...
Name | Type | Description |
---|---|---|
|
| |
|
| One of 'off', 'on'. Default: off |
|
| |
|
| |
|
| |
|
| Resource id. |
POST /client/{client_id}/task_scheduler/{scheduler_id}/task/
Add new task
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
JSON parameters
Name | Type | Description |
---|---|---|
|
| Try_count interval, seconds. |
|
| |
|
| Task name. |
|
| Required. Datetime iso8601 or seconds from now. |
|
| |
|
| Required. Source call number. |
|
| |
|
| Required. Task owner: extension type="phone". |
|
| Required. Destination call number. |
|
| |
|
| How many times a_number and b_number will try to connect. Default: 1 |
Resource fields
Name | Type | Description |
---|---|---|
|
| One of 'scheduled', 'executed', 'delayed', 'finished'. Default: scheduled |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| One of 'success', 'failed'. |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Default: 1 |
|
| |
|
| Resource id. |
|
|
...
GET /client/{client_id}/task_scheduler/{scheduler_id}/task/{task_id
}
Get client
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
|
| Required. |
Resource fields
Name | Type | Description |
---|---|---|
|
| One of 'scheduled', 'executed', 'delayed', 'finished'. Default: scheduled |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| One of 'success', 'failed'. |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Default: 1 |
|
| |
|
| Resource id. |
|
|
...
POST /client/{client_id}/task_scheduler/{scheduler_id}/tasks/
Add list of tasks
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
JSON parameters
Name | Type | Description |
---|---|---|
|
| Required. |
...
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Default: 1 |
Resource fields
Name | Type | Description |
---|---|---|
|
|
...
POST /client/{client_id}/user/client/
Add new user client
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
JSON parameters
Name | Type | Description |
---|---|---|
|
| User email. |
|
| User status. One of 'active', 'blocked'. |
|
| Required. User name. |
|
| Send email with access data for new user. Default: False |
|
| User access type. One of 'full', 'read_only'. |
|
| User extra params. |
|
| User timezone. |
|
| Required. User login. |
|
| Required. User password. |
|
| User email. |
|
| Required. User email. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Resource id. |
GET /client/{client_id}/user/client/
Get user client list
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
...
Name | Type | Description |
---|---|---|
|
| |
|
|
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Resource id. |
...
PUT /client/{client_id}/user/client/{user_id
}
Update user client
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
JSON parameters
Name | Type | Description |
---|---|---|
|
| User email. |
|
| User status. One of 'active', 'blocked'. |
|
| User name. |
|
| User access type. One of 'full', 'read_only'. |
|
| User extra params. |
|
| User timezone. |
|
| User password. |
|
| User email. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Resource id. |
GET /client/{client_id}/user/client/{user_id
}
Get user client
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Resource id. |
DELETE /client/{client_id}/user/client/{user_id
}
Delete user client
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
...
POST /client/{client_id}/user/extension/
Add new user extension
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
JSON parameters
Name | Type | Description |
---|---|---|
|
| User email. |
|
| User status. One of 'active', 'blocked'. |
|
| Required. User name. |
|
| Send email with access data for new user. Default: False |
|
| User access type. One of 'full', 'read_only'. |
|
| Required. User extension id. |
|
| User extra params. |
|
| User timezone. |
|
| Required. User login. |
|
| Required. User password. |
|
| User email. |
|
| Required. User email. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Resource id. |
GET /client/{client_id}/user/extension/
Get user extension list
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
...
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Resource id. |
...
PUT /client/{client_id}/user/extension/{user_id
}
Update user extension
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
JSON parameters
Name | Type | Description |
---|---|---|
|
| User email. |
|
| User status. One of 'active', 'blocked'. |
|
| User name. |
|
| User access type. One of 'full', 'read_only'. |
|
| User extension id. |
|
| User extra params. |
|
| User timezone. |
|
| User password. |
|
| User email. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Resource id. |
GET /client/{client_id}/user/extension/{user_id
}
Get user extension
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Resource id. |
DELETE /client/{client_id}/user/extension/{user_id
}
Delete user extension
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
...
Add new user extension group
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
JSON parameters
Name | Type | Description |
---|---|---|
|
| User email. |
|
| User status. One of 'active', 'blocked'. |
|
| Required. User name. |
|
| Send email with access data for new user. Default: False |
|
| User extra params. |
|
| User access type. One of 'full', 'read_only'. |
|
| Required. User extension id. |
|
| User timezone. |
|
| Required. User login. |
|
| Required. User password. |
|
| User email. |
|
| Required. User email. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Resource id. |
...
Get user extension group list
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
...
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Resource id. |
...
Update user extension group
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
JSON parameters
Name | Type | Description |
---|---|---|
|
| User email. |
|
| User status. One of 'active', 'blocked'. |
|
| User name. |
|
| User extension id. |
|
| User access type. One of 'full', 'read_only'. |
|
| User extra params. |
|
| User timezone. |
|
| User password. |
|
| User email. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Resource id. |
GET /client/{client_id}/user/extension_group/{user_id
}
Get user extension group
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Resource id. |
...
Delete user extension group
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
...
POST /client/{client_id}/variables/
Post client variables
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
JSON parameters
Name | Type | Description |
---|---|---|
|
| Required. |
...
GET /client/{client_id}/variables/
Get client variables
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
...
Get voice mail messages list
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
...
Name | Type | Description |
---|---|---|
|
| Required. Start datetime. |
|
| Required. End datetime. |
|
| Extension id. |
|
| Datetime sorting order. One of 'desc', 'asc'. Default: desc |
|
| Extension id. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Extension id. |
|
| |
|
|
...
Delete voice mail messages in interval
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
...
Get voicemail message file
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
DELETE /client/{client_id}/voicemail/{record_uuid
}
Delete voice message
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
...