Getting agent clients
| Method | get.customers |
|---|---|
| Description | Getting Agent Clients |
| Available to | Partner |
Archived clients do not appear in the list
Request parameters
| Title | Type | Required | Description |
|---|---|---|---|
access_token |
string | yes | Authentication session key |
limit |
number | no | Number of records returned. See section "Paging" |
offset |
number | no | Shift determines from which record number to return "limit" records. Default is "0". See section "Paging" |
filter |
object | no | See section "Filtering criteria" |
fields |
array | no | See section "View of returned data" |
sort |
array | no | See section "Sorting data" |
Response parameters
| Name | Type | Valid values | Filtering | Sorting | Description |
|---|---|---|---|---|---|
id |
number | yes | Unique client identifier | ||
name |
string | yes | Client name | ||
description |
string | Description for the client | |||
creation_date_time |
iso8601 | YYYY-MM-DD hh:mm:ss | yes | Date and time of client creation | |
status |
enum |
|
yes | yes | Client status |
status_change_date_time |
iso8601 | YYYY-MM-DD hh:mm:ss | Date and time of status change | ||
monthly_base_limit |
number | Total monthly limit. The value is set in money. | |||
monthly_base_notify_limit |
number | Threshold value of the total monthly limit when
reaching which a notification is sent to
email address specified in the parameter
"monthly_base_notify_email" |
|||
monthly_base_notify_emails |
array | Email addresses to receive notifications about reaching the total monthly limit | |||
monthly_calls_limit |
number | Monthly call limit. The value is set in number of calls. | |||
monthly_calls_notify_limit |
number | Threshold value of monthly call limit
upon reaching which it is sent
notification to the email address specified in
parameter "monthly_calls_notify_email" |
|||
monthly_calls_notify_emails |
array | Email addresses to receive notifications about reaching the monthly limit on calls | |||
daily_calls_limit |
number | Daily call limit. The value is set in number of calls. | |||
daily_calls_notify_limit |
number |
Threshold value of daily call limit
upon reaching which it is sent
notification to the email address specified in
parameter "daily_calls_notify_email"
|
|||
daily_calls_notify_emails |
array | Email addresses to receive notifications about reaching the daily limit on calls | |||
| List of client sites | |||||
sites |
array | List of client sites | |||
site_id |
number | Unique site identifier | |||
site_domain_name |
string | Site domain name | |||
| Tariff plan | |||||
tariff_plan_id |
number | yes | Unique identifier of the tariff plan | ||
tariff_plan_name |
string | yes | Tariff plan name | ||
JSON request structure```json
{ "jsonrpc":"2.0", "id":"number", "method":"get.customers", "params":{ "access_token":"string", "offset":"number", "limit":"number", "filter":{
},
"sort":[
{
"field":"string",
"order":"string"
}
],
"fields":[
"string"
]
} }
### JSON response structure```json
{
"jsonrpc":"2.0",
"id":"number",
"result":{
"metadata":{
},
"data":[
{
"id":"number",
"name":"string",
"description":"string",
"creation_date_time":"iso8601",
"status":"enum",
"status_change_date_time":"iso8601",
"tariff_plan_id":"number",
"tariff_plan_name":"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"
],
"sites":[
{
"site_domain_name":"string",
"site_id":"number"
}
]
}
]
}
}
List of returned errors
See the section "List of errors for methods with the verb get"