...
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Resource id. |
|
|
...
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Resource id. |
|
|
...
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Resource id. |
|
|
...
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Resource id. |
|
|
...
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
...
POST /client/{client_id}/
...
extensions_bundle/{extension_id
}
Add extension bundle
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
...
JSON parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
|
| Start datetime. |
|
|
| Fax uuid. |
|
| Destination number. |
Resource fields
Name | Type | Description | |
---|---|---|---|
|
| Caller id number. | |
|
| End datetime. | |
|
| Extension group id. | |
|
| Datetime sorting order. One of 'desc', 'asc'. Default: desc |
|
GET /client/{client_id}/extensions_bundle/{extension_id
}
Get extension bundle info
Path parameters
Name | Type | Description |
---|---|---|
|
| Extension idRequired. |
|
| Required. |
Resource fields
Name | Type | Description |
---|---|---|
|
| Fax uuid. |
|
| Destination number. |
|
| |
|
| Caller id. |
|
| Record datetime. |
|
| Fax file size. |
DELETE /client/{client_id}/extensions_bundle/{extension_id
}
Delete extension bundle info
Path parameters
Name | Type | Description |
---|---|---|
|
| Extension idRequired. |
|
| Client idRequired. extension_group |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| Extension group id. |
...
GET /client/{client_id}/fax/in/
Delete Get incoming fax messages in intervallist
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
Query parameters
Name | Type | Description |
---|---|---|
|
| Start datetime. |
|
| End datetime. |
GET /client/{client_id}/fax/in/{fax_uuid
}
Get incoming fax message
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
DELETE /client/{client_id}/fax/in/{fax_uuid
}
Delete record
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
GET /client/{client_id}/fax/out/
Get client fax messages list
Path parameters
Fax uuid. | ||
|
| Destination number. |
|
| Caller id number. |
|
| End datetime. |
|
| Extension group id. |
|
| Datetime sorting order. One of 'desc', 'asc'. Default: desc |
|
| Extension id. |
Resource fields
Name | Type | Description |
---|---|---|
|
| RequiredFax uuid. |
...
| Name
| Type | Description |
|
---|---|---|---|---|
|
| Start datetime. | ||
|
| |||
end_Caller id. | ||||
|
| End Record datetime. | ||
Name | Type | Description | ||
|
| Datetime sorting order. One of 'desc', 'asc'. Default: desc |
Resource fields
| Fax file size. | |
|
| Extension id. |
|
| Resource Client id. |
|
| |
|
| |
|
| |
|
|
...
Extension group id. |
DELETE /client/{client_id}/fax/
...
in/
Add Delete incoming fax messages in interval
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
...
Query parameters
Name | Type | Description |
---|---|---|
|
| RequiredStart datetime. Interval timezone. |
|
| Required. Datetime conditions. |
|
| Required. Interval name. |
Resource condition
|
| End datetime. |
...
GET /client/{client_id}/fax/in/{fax_uuid
}
Get incoming fax message
Path parameters
Name | Type | Description | |||
---|---|---|---|---|---|
|
| Start datetime formatted as yyyy-mm-dd hh:mm:ss. if start_datetime and end_datetime passed, other condition parameters will be ignored. |
|
| Required. |
|
| Required. |
DELETE /client/{client_id}/fax/in/{fax_uuid
}
Delete record
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
...
GET /client/{client_id}/fax/out/
Get client fax messages list
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
Query parameters
Name | Type | Description |
---|---|---|
|
| Start datetime. |
|
| |
|
| End datetime. |
|
| Datetime sorting order. One of 'desc', 'asc'. Default: desc |
Resource fields
Name | Type | Description |
---|---|---|
|
| Resource id. |
|
| |
|
| |
|
| |
|
|
...
POST /client/{client_id}/interval/
Add interval
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
JSON parameters
Name | Type | Description |
---|---|---|
|
| Required. Interval timezone. |
|
| Required. Datetime conditions. |
|
| Required. Interval name. |
Resource condition
Name | Type | Description |
---|---|---|
|
| Start datetime formatted as yyyy-mm-dd hh:mm:ss. if start_datetime and end_datetime passed, other condition parameters will be ignored. |
|
| Start day of week sun = 1, mon = 2, etc. Min: 1. Max: 7. |
|
| Min: 1. |
|
| Start datetime formatted as yyyy-mm-dd. |
|
| Month. Min: 1. Max: 12. |
|
| End day of week sun = 1, mon = 2, etc. Min: 1. Max: 7. |
|
| Min: 1. |
|
| End month day. Min: 1. Max: 31. |
|
| Start month day. Min: 1. Max: 31. |
|
| End time of day. |
|
| Start time of day. |
|
| End datetime formatted as yyyy-mm-dd hh:mm:ss. if start_datetime and end_datetime passed, other condition parameters will be ignored. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Resource id. |
Resource interval_condition
Name | Type | Description |
---|---|---|
|
| |
|
| Start day of week sun = 1, mon = 2, etc. |
|
| Min: 1. |
|
| Start datetime formatted as yyyy-mm-dd. |
|
| |
|
| End day of week sun = 1, mon = 2, etc. |
|
| Min: 1. |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
GET /client/{client_id}/interval/
Get interval list
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Resource id. |
Resource interval_condition
Name | Type | Description | |
---|---|---|---|
|
| ||
|
| Start day of week sun = 1, mon = 2, etc. Min: 1. Max: 7. | |
|
| Min: 1. | |
|
| Start datetime formatted as yyyy-mm-dd. | |
|
| Month. Min: 1. Max: 12. |
|
|
| End day of week sun = 1, mon = 2, etc. Min: 1. Max: 7. | |
|
| Min: 1. | |
|
| ||
|
| ||
|
| ||
End time of day. |
| ||
|
| ||
|
| End datetime formatted as yyyy-mm-dd hh:mm:ss. if start_datetime and end_datetime passed, other condition parameters will be ignored. |
...
PUT /client/{client_id}/interval/{interval_id
}
Update interval
Path parameters
Name | Type | Description | ||
---|---|---|---|---|
|
| |||
|
| |||
extensionRequired. | ||||
|
|
|
| Required. |
JSON parameters
Name | Type | Description | ||
---|---|---|---|---|
|
| Required. Interval timezone. | ||
|
|
|
| Resource idRequired. Datetime conditions. |
|
| Required. Interval name. |
Resource
...
condition
Name | Type | Description |
---|---|---|
|
| Start datetime formatted as yyyy-mm-dd hh:mm:ss. if start_datetime and end_datetime passed, other condition parameters will be ignored. |
|
| Start day of week sun = 1, mon = 2, etc. Min: 1. Max: 7. |
|
| Min: 1. |
|
| Start datetime formatted as yyyy-mm-dd. |
|
| Month. Min: 1. Max: 12. |
|
| End day of week sun = 1, mon = 2, etc. Min: 1. Max: 7. |
|
| Min: 1. |
|
| End month day. Min: 1. Max: 31. |
|
| Start month day. Min: 1. Max: 31. |
|
| |
|
| |
|
| |
|
|
GET /client/{client_id}/interval/
Get interval list
Path parameters
Name | Type | Description | |
---|---|---|---|
|
| Required | End time of day. |
|
| Start time of day. | |
|
| End datetime formatted as yyyy-mm-dd hh:mm:ss. if start_datetime and end_datetime passed, other condition parameters will be ignored. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Resource id. |
Resource interval_condition
Name | Type | Description |
---|---|---|
|
| |
|
| Start day of week sun = 1, mon = 2, etc. |
|
| Min: 1. |
|
| Start datetime formatted as yyyy-mm-dd. |
|
| |
|
| End day of week sun = 1, mon = 2, etc. |
|
| Min: 1. |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
...
GET /client/{client_id}/interval/{interval_id
}
Update Get interval
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
...
Resource fields
Name | Type | Description | |
---|---|---|---|
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| Required. Datetime conditions. | |
|
| Required. Interval name. |
...
|
| Resource id. |
Resource interval_condition
Name | Type | Description | |
---|---|---|---|
|
| Start datetime formatted as yyyy-mm-dd hh:mm:ss. if start_datetime and end_datetime passed, other condition parameters will be ignored. |
|
|
| Start day of week sun = 1, mon = 2, etc. Min: 1. Max: 7. | |
|
| Min: 1. | |
|
| Start datetime formatted as yyyy-mm-dd. | |
|
| Month. Min: 1. Max: 12. | |
|
| End day of week sun = 1, mon = 2, etc. Min: 1. Max: 7. | |
|
| Min: 1. | |
|
| ||
|
| Start month day. Min: 1. Max: 31. | |
|
| End time of day. | |
|
| Start time of day. | |
|
| End datetime formatted as yyyy-mm-dd hh:mm:ss. if start_datetime and end_datetime passed, other condition parameters will be ignored | |
|
| ||
|
| ||
|
| ||
|
|
DELETE /client/{client_id}/interval/{interval_id
}
Delete interval
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
...
GET /client/{client_id}/limit/
Get client limits
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
| ||
|
| |
|
| |
|
| |
|
| |
|
| Resource id. |
Resource interval_condition
Name | Type | Description |
---|---|---|
|
| |
|
| Start day of week sun = 1, mon = 2, etc. |
|
| Min: 1. |
|
| Start datetime formatted as yyyy-mm-dd. |
|
| |
|
| End day of week sun = 1, mon = 2, etc. |
|
| Min: 1. |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
...
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Default: 0 |
...
POST /client/{client_id}/
...
network_permission/
Add network permission group
Path parameters
Name | Type | Description | ||
---|---|---|---|---|
|
| Required. |
|
|
JSON parameters
Name | Type | Description |
---|---|---|
|
| Network_address/mask list. |
|
| Required. |
Resource fields
Name | Type | Description | |
---|---|---|---|
|
| ||
|
| ||
extension_ | Network permission count. Default: 0 | ||
|
| Network addresses list. | |
|
| client_Network permission id |
|
|
| ||
|
| ||
. | |||
|
| Resource Client id. |
Resource interval_condition
Name | Type | Description |
---|---|---|
|
| |
|
| Start day of week sun = 1, mon = 2, etc. |
|
| Min: 1. |
|
| Start datetime formatted as yyyy-mm-dd. |
|
| |
|
| End day of week sun = 1, mon = 2, etc. |
|
| Min: 1. |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
...
|
| Network permission name. |
GET /client/{client_id}/network_permission/
Get network permission group list
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
Resource fields
Name | Type | Description |
---|---|---|
|
| Network permission count. Default: 0 |
|
| Network addresses list. |
|
| Network permission id. |
|
| Client id. |
|
| Network permission name. |
...
PUT /client/{client_id}/
...
network_permission/{
...
group_id
}
Delete intervalUpdate network permission group
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
GET /client/{client_id}/limit/
Get client limits
...
JSON parameters
Name | Type | Description |
---|---|---|
|
| Network_address/mask list. |
|
|
Resource fields
Name | Type | Description |
---|---|---|
|
| Network permission count. Default: 0 |
|
| Network addresses list. |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Default: 0 |
...
Network permission id. | ||
|
| Client id. |
|
| Network permission name. |
GET /client/{client_id}/network_permission/{group_id
}
Get network permission group
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
Resource fields
Name | Type | Description |
---|---|---|
|
| Network permission count. Default: 0 |
|
| Network addresses list. |
|
| Network permission id. |
|
| Client id. |
|
| Network permission name. |
DELETE /client/{client_id}/network_permission/{group_id
}
Delete network permission group
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
...
GET /client/{client_id}/
...
record/
Add network permission groupGet record list
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
...
Query parameters
Name | Type | Description |
---|---|---|
|
| Required. Start datetime. |
|
| Required. |
Resource fields
Name | Type | Description |
---|---|---|
|
| Network permission countDatetime sorting order. One of 'desc', 'asc'. Default: 0desc |
|
| Network addresses list. |
|
| Network permission id. |
|
| Client id. |
|
| Network permission name. |
GET /client/{client_id}/network_permission/
Get network permission group list
...
Required. End datetime. | ||
|
| |
|
| Default: 1 |
Resource fields
Name | Type | Description |
---|---|---|
|
| Required. |
Resource fields
Name | Type | Description |
---|---|---|
|
| Network permission count. Default: 0 |
|
| Network addresses list. |
|
| Network permission id. |
|
| Client id. |
|
| Network permission name. |
PUT /client/{client_id}/network_permission/{group_id
}
Update network permission group
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
JSON parameters
Name | Type | Description |
---|---|---|
|
| Network_address/mask list. |
|
|
Resource fields
Name | Type | Description |
---|---|---|
|
| Network permission count. Default: 0 |
|
| Network addresses list. |
|
| Network permission id. |
|
| Client id. |
|
| Network permission name. |
...
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
DELETE /client/{client_id}/record/
Delete records in interval
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
Query parameters
Name | Type | Description |
---|---|---|
|
| Required. Start datetime. |
|
| Required. End datetime. |
...
POST /client/{client_id}/
...
record/archive/
Get record archive
Path parameters
Name | Type | Description |
|
| Required. |
---|---|---|---|---|---|
|
| Required. |
...
JSON parameters
Name | Type | Description |
---|---|---|
|
| Network permission count. Default: 0 |
|
| Network addresses list. |
|
| Network permission id. |
|
| Client id. |
|
| Network permission name. |
DELETE /client/{client_id}/network_permission/{group_id
}
Delete network permission group
...
|
| Required. Start datetime. |
|
| |
|
| Required. |
|
| Required. End datetime. |
Resource fields
Name | Type | Description | |||
---|---|---|---|---|---|
|
| ||||
|
| Required. |
|
| Required. |
|
| ||||
|
| ||||
|
|
...
GET /client/{client_id}/record/stats/
Get record statistics list
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
Query parameters
Name | Type | Description | |||
---|---|---|---|---|---|
|
| Required. Start datetime. |
|
| Datetime sorting order. One of 'desc', 'asc'. Default: desc |
|
| Required. End datetime. | |||
|
| ||||
|
| Default: 1 |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
...
GET /client/{client_id}/record/{record_uuid
}
Get record
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
DELETE /client/{client_id}/record/{record_uuid
}
Delete record
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
...
GET /client/{client_id}/record/{record_uuid}/download/
Get record with basic http authentication
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
...
Required. |
...
GET /client/{client_id}/record/{record_uuid}/path/
Get ftp record path
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
...
GET /client/{client_id}/record/{record_uuid}/storage_url/
Get record storage url
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
...
GET /client/{client_id}
...
/reg_status_log/
Get logs for change registrations of all client extensions
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
Query parameters
Name | Type | Description |
---|---|---|
|
| Required. Start datetime. |
|
| Required. End datetime. |
|
| Datetime sorting order. One of 'desc', 'asc'. Default: desc |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
|
...
POST /client/{client_id}/
...
sound/
Get record archiveAdd sound
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
...
Form parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
|
| Required. Start datetime. | ||||
|
| |||||
|
|
| Required. |
|
| Required. End datetime. Sound title. |
Resource fields
Name | Type | Description |
---|---|---|
|
| Sound title. |
|
| |
|
| |
|
| |
| ||
|
| Resource id. |
|
| |
|
|
GET /client/{client_id}/
...
sound/
...
Get record statistics sound list
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
Query parameters
Name | Type | Description |
---|---|---|
|
| Required. Start datetime. |
|
| Required. End datetime. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
|
GET /client/{client_id}/record/{record_uuid
}
Get record
...
| ||
|
| |
|
| |
|
| |
|
| Default: 1 |
Resource fields
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
DELETE /client/{client_id}/record/{record_uuid
}
Delete record
Path parameters
Name | Type | Description |
---|---|---|
|
| Required |
|
| Resource id. |
|
| |
|
| Required. |
...
GET /client/{client_id}/
...
sound/search/
Client sounds search
Path parameters
Name | Type | Description |
|
| Required. |
---|---|---|---|---|---|
|
| Required. |
GET /client/{client_id}/record/{record_uuid}/path/
Get ftp record path
...
Query parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
GET /client/{client_id}/record/{record_uuid}/storage_url/
Get record storage url
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
...
| ||
|
| |
|
| |
|
| |
|
| |
|
| Default: 1 |
Resource fields
Name | Type | Description |
---|---|---|
|
|
...
PUT /client/{client_id}/sound/
...
{sound_id
}
Update sound
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
Query parameters
Name | Type | Description | |
---|---|---|---|
|
|
| Required. Start datetime. |
|
| Required. End datetime. | |
|
| Datetime sorting order. One of 'desc', 'asc'. Default: desc |
JSON parameters
Name | Type | Description |
---|---|---|
|
| Sound title. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| Resource id. |
|
| |
|
|
POST /client/{client_id}/sound/{sound_id
}
Add Update sound file
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
Form parameters
Name | Type | Description |
|
| Required. Description | |
---|---|---|---|---|---|---|
|
| Required. Sound title. | ||||
|
| Required. |
Resource fields
Name | Type | Description |
---|---|---|
|
| Sound title. |
|
| |
|
| Resource id. |
|
| |
|
|
GET /client/{client_id}/sound/{sound_id
}
Get sound list
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
Query parameters
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| Default: 1 |
|
| Required. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| Resource id. |
|
| |
|
|
...
DELETE /client/{client_id}/sound/
...
Client sounds search
Path parameters
...
Name
...
Type
...
Description
...
{sound_id
}
...
string
...
Required.
Query parameters
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Default: 1 |
...
Delete sound
Path parameters
Name | Type | Description |
---|---|---|
|
|
...
|
| Required. |
|
| Required. |
...
GET /client/{client_id}/sound/{sound_id}/download/
Update Get sound file
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
...
POST /client/{client_id}/task_scheduler/
Add task scheduler
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
JSON parameters
Name | Type | Description | |
---|---|---|---|
|
| ||
|
| One of 'on', 'off'. Default: off | |
|
| ||
|
| Sound titleRequired. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
| ||
|
| |
|
| One of 'off', 'on'. Default: off |
|
| |
|
| |
|
| |
|
| Resource id. |
|
| |
|
|
...
PUT /client/{client_id}/
...
task_scheduler/{
...
scheduler_id
}
Update sound filescheduler
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
...
JSON parameters
Name | Type | Description |
---|---|---|
|
| Sound title. |
|
| Required. |
Resource fields
Name | Type | Description |
---|---|---|
|
| Sound title. |
|
| |
|
| Resource id. |
|
| |
|
|
GET /client/{client_id}/sound/{sound_id
}
Get sound
Path parameters
|
| One of 'on', 'off'. Default: off |
|
|
Resource fields
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| One of 'off', 'on'. Default: off |
|
| |
|
| |
|
| |
|
| Resource id. |
|
| |
|
|
...
GET /client/{client_id}/
...
task_scheduler/{
...
scheduler_id
}
Delete soundGet task scheduler by id for
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
GET /client/{client_id}/sound/{sound_id}/download/
Get sound file
Path parameters
Resource fields
Name | Type | Description | |
---|---|---|---|
|
| ||
|
| Required. | sound_One of 'off', 'on'. Default: off |
|
| ||
|
| ||
|
| ||
|
| RequiredResource id. |
...
POST /client/{client_id}/task_scheduler/{scheduler_id}/task/
Add new task scheduler
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
JSON parameters
Name | Type | Description |
---|---|---|
|
| |
|
| One of 'on', 'off'. Default: off |
|
| Required. |
|
| 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 'off'scheduled', 'executed', 'delayed', 'onfinished'. Default: off |
|
| Resource id. |
|
|
...
|
|
|
|
|
...
Update scheduler
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
JSON parameters
Name | Type | Description |
---|---|---|
|
| |
|
| One of 'on', 'off'. Default: off |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| One of 'off', 'on'. Default: off |
|
| |
|
| |
|
| One of 'success', 'failed'. |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Default: 1 |
|
| |
|
| Resource id. |
|
|
...
GET /client/{client_id}/task_scheduler/{scheduler_id}/task/{task_id
}
Get task scheduler by id forclient
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
|
| Required. |
Resource fields
Name | Type | Description |
| |
---|---|---|---|---|
|
| One of 'offscheduled', 'executed', 'delayed', 'onfinished'. Default: off | ||
|
| Resource id. | ||
|
|
POST /client/{client_id}/task_scheduler/{scheduler_id}/task/
Add new task
Path parameters
Name | Type | Descriptionscheduled |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
Required. |
|
|
|
| RequiredOne of 'success', 'failed'. |
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 |
|
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| 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. |
Resource task_args
Name | Type | Description | |
---|---|---|---|
|
| ||
|
| ||
|
| ||
|
| ||
|
|
|
|
|
| One of 'success', 'failed'. | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| Default: 1 | |
|
| ||
|
| Resource id. | |
|
|
GET /client/{client_id}/task_scheduler/{scheduler_id}/task/{task_id
}
Get client
Path parameters
Resource fields
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
|
| Required. |
Resource fields
|
|
Resource task_res
Name | Type | Description |
---|---|---|
|
| One of 'scheduled', 'executed', 'delayed', 'finished'. Default: scheduled |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| One of 'success', 'failed'. |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Default: 1 |
|
| |
|
| Resource id. |
|
|
...
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. |
Resource client_vars
Name | Type | Description |
---|---|---|
|
| |
|
|
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. |
...