Create customers
Creating agent's customers
Method |
create.customers |
Description |
Creating agent's customers |
Who has access |
Partner |
Parameters of a request
Title |
Type |
Description |
Valid values |
Description |
access_token |
string |
yes |
|
Authentication session key |
name |
string |
yes |
|
Customer name |
description |
string |
no |
|
Description of a customer |
tariff_plan_id |
number |
yes |
|
Tariff plan unique ID. You can get a list of available tariff plans using the method "get.partner_tariffs" |
email |
string |
yes |
|
Customer email |
password |
string |
yes |
Minimal length is 8 symbol |
Customer password |
monthly_base_limit |
number |
no |
|
Monthly base limit. Value is in costs. |
monthly_base_notify_limit |
number |
no |
|
Threshold value of a monthly base limit. When you reach it, a notification is sent to the email specified in the parameter "monthly_base_notify_email" |
monthly_base_notify_emails |
array |
yes |
Maximum 5 emails |
Emails used to receive the notifications when a monthly base limit is reached |
monthly_calls_limit |
number |
no |
|
Monthly calls limit. Value is in calls count. |
monthly_calls_notify_limit |
number |
no |
|
Threshold value of monthly calls limit. When you reach it, a notification is sent to the email specified in the parameter "monthly_calls_notify_email" |
monthly_calls_notify_emails |
array |
yes |
Maximum 5 emails |
Emails used to receive notifications when a monthly calls limit is reached |
daily_calls_limit |
number |
no |
|
Daily calls limit. Value is in calls count. |
daily_calls_notify_limit |
number |
no |
|
Threshold value of a daily calls limit. When you reach it, a notification is sent to the email specified in the parameter "daily_calls_notify_email" |
daily_calls_notify_emails |
array |
yes |
Maximum 5 emails |
Emails used to receive notifications when a daily calls limit is reached |
Parameters of a reply
Title |
Type |
Required |
Description |
id |
number |
yes |
Customer unique ID |
JSON request structure
{
"jsonrpc":"2.0",
"id":"number",
"method":"create.customers",
"params":{
"access_token":"string",
"name":"string",
"description":"string",
"tariff_plan_id":"number",
"email":"string",
"password":"string",
"monthly_base_limit":"number",
"monthly_base_notify_limit":"number",
"monthly_base_notify_emails":[
"item"
],
"monthly_calls_limit":"number",
"monthly_calls_notify_limit":"number",
"monthly_calls_notify_emails":[
"item"
],
"daily_calls_limit":"number",
"daily_calls_notify_limit":"number",
"daily_calls_notify_emails":[
"item"
]
}
}
JSON reply structure
{
"jsonrpc":"2.0",
"id":"number",
"result":{
"id":"number"
}
}
List of returning errors
Refer to the section "List of errors for methods with the verb create"