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 d37fa8c4e008fec158070b1b4aea5f0db3d6a06e3469bc9092c887da28b9704c79db0375e7168d8d" \
-H "Content-Type: application/json" \
-d '{"name": "Joefarsana BloggsTest1",
"tenant" : "sbc.yourdomain.com",
"cgrt_username": "jbloggsfarsana_Check",
"company_name": "VoIPTest Company",
"address_line_1": "49 Any Street",
"address_line_2": "",
"city": "New York",
"state_province": "New York",
"postcode_zip": "",
"country": "US",
"telephone_number": "121255512345666556",
"timezone": "America/New _York",
"tax_id": "",
"main_email": "jbloggs@mydomainfarsana@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
languagexml
firstline1
{
   "statusresult": "success",[
     "results": {
    "in_cgrates": true,     "orig_max_channels": 10,15,
         "max_daily_spend": 20,0,
         "enabled": "true",
         "max_connection_fee": null,"",
         "low_balance_notification": null,"0.0000",
         "postcode_zip": "",
         "cgrt_username":"farsana Check"tbloggs3",
         "frequency": "never",
         "timezone": "America/New _York",
         "id": 42,"8659705574181934",
         "rates_email": "",
         "city": "New York",
         "orig_max_cps": 5,
         "orig_credit_limit": null,"0.0000",
         "billing_email": "",
         "max_per_minute_rate": "1.00",0,
         "created_by": 2,8841083500730897,
         "notify_when_dids_are_added": false,
          "verified_for_payments": true,false,
         "company_name": "VoIPTest Company",
         "send_welcome_email": "false",
         "account_type": "PREPAID",
         "account_blocked_alert": false,
         "origination": "allow_all",
         "main_email": "jbloggs3@domainfarsana@mydomain.com",
         "user": 54,8841083500730897,
         "term_max_channels": null,0,
         "tenant": 1,"8692210812138996",
         "tax_id": "",0,
         "state_province": "New York",
         "name": "Tanguy3farsana BloggsTest1",
         "currency": "151",
         "country": "US",
         "telephone_number": "121255512345666556",
         "last_invoice_date": null,"0001-01-01T00:00:00Z",
         "play_audio_messages": false,
         "created_date": "20162019-1210-01T02:21T07:33:55.009029+01:46.29200",
         "nocis_emailprovider": "",
         "termination": "disabled",
         "account_code": "42556133848768173222",
         "address_line_2": "",
         "address_line_1": "49 Any Street"
      }
   ]
 }