Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description 

Create a new client

Parameters

Code Block
languagebash
name
tenant
cgrt_username
main_email
account_type
origination
termination
company_name
address_line_1
address_line_2
city
state_province
postcode_zip
country
telephone_number
max_per_minute_rate
max_daily_spend
enabled
tax_id
timezone
billing_email
noc_email
rates_email
currency
orig_credit_limit
orig_max_channels
orig_max_cps
low_balance_notification
account_blocked_alert
notify_when_dids_are_added
term_max_channels
send_welcome_email
play_audio_messages

Request

Code Block
languagebash
curl -X POST \-H "Authorization: Token d37fa8c4e008fec158070b1b4aea5f0db3d6a06e" \
-H "Content-Type: application/json" \
-d '{"name": "Joe Bloggs",
"tenant" : "sbc.yourdomain.com",
"cgrt_username": "jbloggs",
"company_name": "VoIP Company",
"address_line_1": "49 Any Street",
"address_line_2": "",
"city": "New York",
"state_province": "New York",
"postcode_zip": "",
"country": "US",
"telephone_number": "12125551234",
"timezone": "America/New York",
"tax_id": "",
"main_email": "jbloggs@mydomain.com",
"billing_email": "",
"noc_email": "",
"rates_email": "",
"enabled": true,
"send_welcome_email": false,
"currency": "USD",
"account_type": "PREPAID",
"orig_credit_limit": null,
"origination": "allow_all",
"orig_max_channels": 10,
"orig_max_cps": 5,
"low_balance_notification": null,
"account_blocked_alert": false,
"notify_when_dids_are_added": false,
"termination": "disabled",
"term_max_channels": 0,
"max_per_minute_rate": "1.00",
"max_daily_spend": 20.00,
"play_audio_messages": false
 }' \
-k https://your.domain.com/api/users/client_add

Response

Code Block
{
  "status": "success",
  "results": {
    "in_cgrates": true,
    "orig_max_channels": 10,
    "max_daily_spend": 20,
    "enabled": "true",
    "max_connection_fee": null,
    "low_balance_notification": null,
    "postcode_zip": "",
    "cgrt_username": "tbloggs3",
    "frequency": "never",
    "timezone": "America/New York",
    "id": 42,
    "rates_email": "",
    "city": "New York",
    "orig_max_cps": 5,
    "orig_credit_limit": null,
    "billing_email": "",
    "max_per_minute_rate": "1.00",
    "created_by": 2,
    "notify_when_dids_are_added": false,
    "verified_for_payments": true,
    "company_name": "VoIP Company",
    "send_welcome_email": false,
    "account_type": "PREPAID",
    "account_blocked_alert": false,
    "origination": "allow_all",
    "main_email": "jbloggs3@domain.com",
    "user": 54,
    "term_max_channels": null,
    "tenant": 1,
    "tax_id": "",
    "state_province": "New York",
    "name": "Tanguy3 Bloggs",
    "currency": 151,
    "country": "US",
    "telephone_number": "12125551234",
    "last_invoice_date": null,
    "play_audio_messages": false,
    "created_date": "2016-12-01T02:01:46.292",
    "noc_email": "",
    "termination": "disabled",
    "account_code": "4255613384",
    "address_line_2": "",
    "address_line_1": "49 Any Street"
  }
}

...