...
Query parameters
Name | Type | Description |
---|---|---|
|
| |
|
| Default: 1 |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Default: 1 |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Resource id. |
...
Query parameters
Name | Type | Description | |
---|---|---|---|
|
| Required. | Default: 1 |
|
| ||
|
| Default: 1 | Required. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
|
...
Query parameters
Name | Type | Description |
---|---|---|
|
| Default: 1 |
|
| |
|
| |
|
| Default: 1 |
|
|
Resource fields
...
Query parameters
Name | Type | Description | |
---|---|---|---|
|
| Required. | Default: 1 |
|
| ||
|
| Required. | |
|
| ||
|
| Default: 1 |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
|
...
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
JSON parameters
Name | Type | Description |
---|---|---|
|
| Required. |
...
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| Resource id. |
|
|
...
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
|
| Required. |
...
PUT /admin/application/{id
}
...
JSON parameters
Name | Type | Description | ||
---|---|---|---|---|
|
| |||
|
| |||
|
| Music on hold sound id. | ||
|
| One of 'yes', 'no'. | ||
|
| |||
|
| Default: False | ||
|
| |||
|
| |||
|
| |||
|
| |||
|
| Default: False | ||
|
| |||
|
| |||
|
|
| ||
|
| Call interactive method. One of 'GET', 'POST'. Default: GET | ||
|
| |||
|
| |||
|
| Required. | ||
|
| |||
|
| |||
|
| Default: 3 | ||
|
| Required. | ||
|
| |||
|
| |||
|
| |||
|
| |||
|
| Required. | ||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| One of 'J', 'F'. | ||
|
| Required. | ||
|
| One of 'active', 'blocked'. | ||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| Comma-separated list of codecs without spaces. | ||
|
| Call interactive url. | ||
|
| |||
|
| Default: 0 |
|
|
|
| |||
|
| |||
|
| |||
|
| One of 'default', 'from', 'diversion'. | ||
|
| Default: Europe/Moscow | ||
|
| |||
|
| One of 'None', 'ab', 'aa', 'af', 'ak', 'sq', 'am', 'ar', 'an', 'hy', 'as', 'av', 'ae', 'ay', 'az', 'bm', 'ba', 'eu', 'be', 'bn', 'bh', 'bi', 'bs', 'br', 'bg', 'my', 'ca', 'ch', 'ce', 'ny', 'zh', 'cv', 'kw', 'co', 'cr', 'hr', 'cs', 'da', 'dv', 'nl', 'dz', 'en', 'eo', 'et', 'ee', 'fo', 'fj', 'fi', 'fr', 'ff', 'gl', 'ka', 'de', 'el', 'gn', 'gu', 'ht', 'ha', 'he', 'hz', 'hi', 'ho', 'hu', 'ia', 'id', 'ie', 'ga', 'ig', 'ik', 'io', 'is', 'it', 'iu', 'ja', 'jv', 'kl', 'kn', 'kr', 'ks', 'kk', 'km', 'ki', 'rw', 'ky', 'kv', 'kg', 'ko', 'ku', 'kj', 'la', 'lb', 'lg', 'li', 'ln', 'lo', 'lt', 'lu', 'lv', 'gv', 'mk', 'mg', 'ms', 'ml', 'mt', 'mi', 'mr', 'mh', 'mn', 'na', 'nv', 'nd', 'ne', 'ng', 'nb', 'nn', 'no', 'ii', 'nr', 'oc', 'oj', 'cu', 'om', 'or', 'os', 'pa', 'pi', 'fa', 'pl', 'ps', 'pt', 'qu', 'rm', 'rn', 'ro', 'ru', 'sa', 'sc', 'sd', 'se', 'sm', 'sg', 'sr', 'gd', 'sn', 'si', 'sk', 'sl', 'so', 'st', 'es', 'su', 'sw', 'ss', 'sv', 'ta', 'te', 'tg', 'th', 'ti', 'bo', 'tk', 'tl', 'tn', 'to', 'tr', 'ts', 'tt', 'tw', 'ty', 'ug', 'uk', 'ur', 'uz', 've', 'vi', 'vo', 'wa', 'cy', 'wo', 'fy', 'xh', 'yi', 'yo', 'za', 'zu'. | ||
|
| |||
|
| Default: False | ||
|
| One of 'mp3', 'wav'. Default: mp3 | ||
|
| One of 'yes', 'no'. | ||
|
| |||
|
| |||
|
| |||
|
| Music for outg_call_vr_on_fail param. | ||
|
| Call interactive timout. |
Resource fields
Name | Type | Description | |
---|---|---|---|
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| Default: False | |
|
| Default: False0 | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| Default: False |
|
|
| Default: GET | |
|
| ||
|
| ||
|
|
| Default: 0 |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| Resource id. | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| Default: False | |
|
| Default: 0 |
|
|
| ||
|
| ||
|
| ||
|
| ||
|
| Default: Europe/Moscow | |
|
| ||
|
| ||
|
| ||
|
| Default: False | |
|
| Default: mp3 | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
|
GET /admin/client/
...
Query parameters
Name | Type | Description | |
---|---|---|---|
|
| Default: 1 | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| One of 'name', 'prefix', 'domain_id', 'status'. | |
|
| ||
|
| ||
|
| One of 'desc', 'asc'. Default: asc | |
|
| Default: 1 |
Resource fields
Name | Type | Description | |
---|---|---|---|
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| Default: False | |
|
| Default: False0 | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| Default: False |
|
|
| Default: GET | |
|
| ||
|
| ||
|
|
| Default: 0 |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| Resource id. | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| Default: False | |
|
| Default: 0 |
|
|
| ||
|
| ||
|
| ||
|
| ||
|
| Default: Europe/Moscow | |
|
| ||
|
| ||
|
| ||
|
| Default: False | |
|
| Default: mp3 | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
|
...
GET /admin/client/search/
...
Query parameters
Name | Type | Description | |||
---|---|---|---|---|---|
|
| Default: 1 | |||
|
| ||||
|
| Required. | |||
|
| One of 'name', 'prefix', 'domain_id', 'status'. | |||
|
| One of 'desc', 'asc'. Default: asc |
|
| Required. |
|
| ||||
|
| ||||
|
|
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
|
Resource client_search
Name | Type | Description | |
---|---|---|---|
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| Default: False | |
|
| Default: False0 | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| Default: False |
|
|
| Default: GET | |
|
| ||
|
| ||
|
| ||
|
| Default: 0 | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| Resource id. | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| Default: False | |
|
| Default: 0 | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| Default: Europe/Moscow | |
|
| ||
|
| ||
|
| ||
|
|
| Default: False |
|
| Default: mp3 | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
|
...
PUT /admin/client/{client_id
}
...
JSON parameters
Name | Type | Description | |
---|---|---|---|
|
| ||
|
| ||
|
| Music on hold sound id. | |
|
| One of 'yes', 'no'. | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| Call interactive method. One of 'GET', 'POST'. Default: GET | |
|
| ||
|
| ||
|
| ||
|
| ||
|
|
|
|
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| One of 'J', 'F'. | |
|
| ||
|
| One of 'active', 'blocked'. | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| Comma-separated list of codecs without spaces. | |
|
| Call interactive url. | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| One of 'default', 'from', 'diversion'. | |
|
| ||
|
| ||
|
| One of 'None', 'ab', 'aa', 'af', 'ak', 'sq', 'am', 'ar', 'an', 'hy', 'as', 'av', 'ae', 'ay', 'az', 'bm', 'ba', 'eu', 'be', 'bn', 'bh', 'bi', 'bs', 'br', 'bg', 'my', 'ca', 'ch', 'ce', 'ny', 'zh', 'cv', 'kw', 'co', 'cr', 'hr', 'cs', 'da', 'dv', 'nl', 'dz', 'en', 'eo', 'et', 'ee', 'fo', 'fj', 'fi', 'fr', 'ff', 'gl', 'ka', 'de', 'el', 'gn', 'gu', 'ht', 'ha', 'he', 'hz', 'hi', 'ho', 'hu', 'ia', 'id', 'ie', 'ga', 'ig', 'ik', 'io', 'is', 'it', 'iu', 'ja', 'jv', 'kl', 'kn', 'kr', 'ks', 'kk', 'km', 'ki', 'rw', 'ky', 'kv', 'kg', 'ko', 'ku', 'kj', 'la', 'lb', 'lg', 'li', 'ln', 'lo', 'lt', 'lu', 'lv', 'gv', 'mk', 'mg', 'ms', 'ml', 'mt', 'mi', 'mr', 'mh', 'mn', 'na', 'nv', 'nd', 'ne', 'ng', 'nb', 'nn', 'no', 'ii', 'nr', 'oc', 'oj', 'cu', 'om', 'or', 'os', 'pa', 'pi', 'fa', 'pl', 'ps', 'pt', 'qu', 'rm', 'rn', 'ro', 'ru', 'sa', 'sc', 'sd', 'se', 'sm', 'sg', 'sr', 'gd', 'sn', 'si', 'sk', 'sl', 'so', 'st', 'es', 'su', 'sw', 'ss', 'sv', 'ta', 'te', 'tg', 'th', 'ti', 'bo', 'tk', 'tl', 'tn', 'to', 'tr', 'ts', 'tt', 'tw', 'ty', 'ug', 'uk', 'ur', 'uz', 've', 'vi', 'vo', 'wa', 'cy', 'wo', 'fy', 'xh', 'yi', 'yo', 'za', 'zu'. | |
|
| ||
|
| Default: False | |
|
| One of 'mp3', 'wav'. | |
|
| One of 'yes', 'no'. | |
|
|
| |
|
| ||
|
| ||
|
| Music for outg_call_vr_on_fail param. | |
|
| Call interactive timout. | |
|
|
Resource fields
Name | Type | Description | ||
---|---|---|---|---|
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| Default: False | ||
|
| Default: False0 | ||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| Default: False |
| |
|
| Default: GET | ||
|
| |||
|
| |||
|
|
| Default: 0 | |
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| Resource id. | ||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| Default: False | ||
|
| Default: 0 |
|
|
|
| |||
|
| |||
|
| |||
|
| |||
|
| Default: Europe/Moscow | ||
|
| |||
|
| |||
|
| |||
|
| Default: False | ||
|
| Default: mp3 | ||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
|
...
Resource fields
Name | Type | Description | |
---|---|---|---|
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| Default: False | |
|
| Default: False0 | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| Default: False |
|
|
| Default: GET | |
|
| ||
|
| ||
|
| ||
|
| Default: 0 | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| Resource id. | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| Default: False | |
|
| Default: 0 | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| Default: Europe/Moscow | |
|
| ||
|
| ||
|
| ||
|
|
| Default: False |
|
| Default: mp3 | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
|
DELETE /admin/client/{client_id
}
...
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
|
Resource fields
...
Query parameters
Name | Type | Description |
---|---|---|
|
| Default: 1 |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| One of 'desc', 'asc'. Default: asc |
|
| |
|
| |
|
| |
|
| One of 'name', 'id'. Default: name |
|
| |
|
| |
|
| Default: 1 |
|
| |
| One of 'desc', 'asc'. Default: asc |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Default: False |
|
| |
|
| |
|
| Resource id. |
|
| |
|
|
...
Query parameters
Name | Type | Description | ||
---|---|---|---|---|
|
| Required. | Default: 1 | |
|
|
|
| Default: 1 |
|
| Required. | ||
|
|
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
|
...
Query parameters
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
|
Resource fields
...
Query parameters
Name | Type | Description | |
---|---|---|---|
|
| Default: 1 | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| Default: 1 |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| Default: False |
|
| |
|
| |
|
| Default: False |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Resource id. |
|
|
...
Query parameters
Name | Type | Description | |
---|---|---|---|
|
| Required. | Default: 1 |
|
| ||
|
| Default: 1 | Required. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
|
...
Name | Type | Description |
---|---|---|
|
| One of 'digest', 'network', 'both'. Default: digest |
|
| Voicemail enabled. |
|
| Music on hold sound id. |
|
| |
|
| Preserve original caller id number on attended transfer. |
|
| |
|
| |
|
| |
|
| Append to cid name on transfer. |
|
| Static registration user. |
|
| One of 'yes', 'no', 'None'. |
|
| Timeout in seconds before hangup if extension does not answer. |
|
| |
|
| Email address for voicemail notifications. |
|
| |
|
| Voicemail greeting sound id. |
|
| Call record enabled. |
|
| Attach voicemail message to notification email. |
|
| |
|
| |
|
| |
|
| Transfer caller id number. |
|
| Ignore early media. |
|
| Static registration host. |
|
| Voicemail configuration. One of 'default', 'record_silence'. |
|
| Static registration address:port. |
|
| |
|
| |
|
| Call screening enabled. |
|
| Ringback sound id. |
|
| One of 'mp3', 'wav', 'None'. |
|
| |
|
| |
|
|
...
Name | Type | Description |
---|---|---|
|
| |
|
| Default: False |
|
| |
|
| |
|
| Default: False |
|
| |
|
| Default: True |
|
| |
|
| |
|
| |
|
| |
|
| Default: 60 |
|
| |
|
| |
|
| Default: False |
|
| |
|
| |
|
| Default: False |
|
| Default: True |
|
| |
|
| |
|
| |
|
| |
|
| Default: False |
|
| |
|
| Default: default |
|
| |
|
| |
|
| |
|
| |
|
| Default: False |
|
| |
|
| |
|
| |
|
| Default: False |
|
|
...
Name | Type | Description | ||
---|---|---|---|---|
|
| |||
|
| Default: False | ||
|
| |||
|
| |||
|
| Default: False | ||
|
| |||
|
| Default: True | ||
|
| |||
|
| |||
|
| |||
|
| |||
|
| Default: 60 | ||
|
| |||
|
| |||
|
| Default: False | ||
|
| |||
|
| |||
|
| Default: False | ||
|
| Default: True | ||
|
| |||
|
| |||
|
| |||
|
| |||
|
| Default: False | ||
|
| |||
|
| Default: default |
|
|
|
| |||
|
|
|
| |
|
| Default: False | ||
|
| |||
|
| |||
|
| |||
|
| Default: False | ||
|
|
...
Query parameters
Name | Type | Description |
---|---|---|
|
| Default: 1 |
|
|
Resource fields
Name | Type | Description |
---|---|---|
|
| Network permission count. Default: 0 |
|
| Network addresses list. |
|
| Network permission id. |
|
| Client id. |
|
| Network permission name. |
...
Query parameters
Name | Type | Description | |
---|---|---|---|
|
| Required. | Default: 1 |
|
| ||
|
| Default: 1 | Required. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
|
...
Name | Type | Description |
---|---|---|
|
| Required. |
...
POST /admin/notify_extension/
Notify extensions
JSON parameters
Name | Type | Description |
---|---|---|
|
| Extension id for notification. |
|
| Need to reboot extensions. Default: False |
Resource fields
Name | Type | Description |
---|---|---|
|
|
...
GET /admin/rate_limit/
Get rate limit list
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| Resource id. |
|
|
...
Name | Type | Description |
---|---|---|
|
| Required. |
JSON parameters
Name | Type | Description |
---|---|---|
|
| Required. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| Resource id. |
|
|
...
Name | Type | Description |
---|---|---|
|
| Required. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| Resource id. |
|
|
...
Get count of registered extensions
Resource fields
Name | Type | Description |
---|---|---|
|
|
...
POST /admin/
...
routing/
Get restapi logs
...
Add routing list
JSON parameters
Name | Type | Description | |
---|---|---|---|
|
| Required. Routing rules list. | |
|
|
| Required. Routing list name. |
Resource routing_rule
Name | Type | Description |
---|---|---|
|
| Required. |
|
| |
|
| |
|
| Default: 1 |
|
| |
|
|
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| Resource id. |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
POST /admin/routing/
Add routing list
JSON parameters
| |
|
|
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| Resource id. |
|
| Required. Routing list name. |
Resource routing_rule
Name | Type | Description |
---|---|---|
|
| Required. |
|
| |
|
|
GET /admin/routing/
Get routing list
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| Resource id. |
|
|
Resource routing_rule
Name | Type | Description |
---|---|---|
|
| Required. |
|
| |
|
|
...
PUT /admin/routing/{id
}
Get Update routing list
...
Path parameters
Name | Type | Description |
---|---|---|
|
| |
|
| Resource id. |
|
|
Resource routing_rule
Name | Type | Description |
---|---|---|
|
| Required. |
|
| |
|
|
PUT /admin/routing/{id
}
Update routing list
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. Resource id. |
JSON parameters
Name | Type | Description |
---|---|---|
|
| Routing rules list. |
|
| Routing list name. |
...
Form parameters
Name | Type | Description |
---|---|---|
|
| Required. Sound title. |
|
| Required. Sound title. |
Resource fields
Name | Type | Description |
---|---|---|
|
| Sound title. |
|
| |
|
| Resource id. |
|
| |
|
|
GET /admin/sound/
Get sound list
Query parameters
Name | Type | Description |
---|---|---|
|
| Default: 1 |
|
| |
|
| |
|
| |
|
| Default: 1 |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| Resource id. |
|
| |
|
|
...
GET /admin/sound/search/
Common sounds search
Query parameters
Name | Type | Description | |
---|---|---|---|
|
| Required. | Default: 1 |
|
| ||
|
| Default: 1 | Required. |
Resource fields
Name | Type | Description |
---|---|---|
|
|
...
Name | Type | Description |
---|---|---|
|
| Required. |
JSON parameters
Name | Type | Description |
---|---|---|
|
| Sound title. |
...
POST /admin/trunk/
Add trunk
JSON parameters
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| One of 'yes', 'no'. Default: no |
|
| |
|
| One of 'yes', 'no'. Default: no |
|
| |
|
| |
|
| |
|
| Default: 0 |
|
| |
|
| Required. One of 'in', 'out', 'all'. |
|
| |
|
| Default: False |
|
| One of 'active', 'blocked'. |
|
| One of 'yes', 'no'. |
|
| |
|
| One of 'yes', 'no'. |
|
| |
|
| Required. |
|
| |
|
| |
|
| |
|
| Default: False |
|
| One of 'active', 'blocked'. |
Resource fields
Name | Type | Description | |
---|---|---|---|
|
| ||
|
| ||
|
| ||
|
| ||
|
| Default: [] | |
|
| ||
|
| ||
|
| ||
|
| Resource id. | |
|
| ||
|
| ||
|
| ||
|
| Default: 0 |
|
|
| ||
|
|
| |
|
| Default: 0 | |
|
| Default: False | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| Default: False | |
|
|
GET /admin/trunk/
Get trunk list
Query parameters
Name | Type | Description |
---|---|---|
|
| Default: 1 |
|
| |
|
| |
|
| |
|
| Default: 1 |
| array [string |
|
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| Default: [] |
|
| |
|
| |
|
| |
|
| Resource id. |
|
| |
|
| |
|
| |
|
| Default: 0 |
|
| |
|
|
|
|
| Default: 0 |
|
| Default: False |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Default: False |
|
|
...
GET /admin/trunk/search/
Trunk search
Query parameters
Name | Type | Description | |
---|---|---|---|
|
| Required. | Default: 1 |
|
| ||
|
| Default: 1 | Required. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
|
Resource trunk_search
Name | Type | Description | |
---|---|---|---|
|
| ||
|
| ||
|
| ||
|
| ||
|
| Default: [] | |
|
| ||
|
| ||
|
| ||
|
| Resource id. | |
|
| ||
|
| ||
|
| ||
|
| Default: 0 |
|
|
| ||
|
|
| |
|
| Default: 0 | |
|
| Default: False | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| Default: False | |
|
|
...
PUT /admin/trunk/{id
}
...
Name | Type | Description |
---|---|---|
|
| Required. Resource id. |
JSON parameters
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| One of 'yes', 'no'. Default: no |
|
| |
|
| One of 'yes', 'no'. Default: no |
|
| |
|
| |
|
| |
|
| Default: 0 |
|
| |
|
| Required. One of 'in', 'out', 'all'. |
|
| |
|
| Default: False |
|
| One of 'active', 'blocked'. |
|
| One of 'yes', 'no'. |
|
| |
|
| One of 'yes', 'no'. |
|
| |
|
| Required. |
|
| |
|
| |
|
| |
|
| Default: False |
|
| One of 'active', 'blocked'. |
Resource fields
Name | Type | Description | |
---|---|---|---|
|
| ||
|
| ||
|
| ||
|
| ||
|
| Default: [] | |
|
| ||
|
| ||
|
| ||
|
| Resource id. | |
|
| ||
|
| ||
|
| ||
|
| Default: 0 | |
|
| ||
|
|
|
|
|
| Default: 0 | |
|
| Default: False | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| Default: False | |
|
|
GET /admin/trunk/{id
}
...
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| Default: [] |
|
| |
|
| |
|
| |
|
| Resource id. |
|
| |
|
| |
|
| |
|
| Default: 0 |
|
| |
|
|
|
|
| Default: 0 |
|
| Default: False |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Default: False |
|
|
DELETE /admin/trunk/{id
}
...
POST /admin/user/admin/
Add admin user
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. |
...
GET /admin/user/admin/
Get admin user list
Query parameters
Name | Type | Description |
---|---|---|
|
| |
|
|
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Resource id. |
...
Name | Type | Description |
---|---|---|
|
| 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. |
...
GET /admin/users/
Get user list
Query parameters
Name | Type | Description |
| ||
---|---|---|---|---|---|
|
| Default: 1 | |||
|
| ||||
|
| ||||
|
| ||||
|
| ||||
|
| ||||
|
|
|
| Default: 1 | One of 'active', 'blocked'. |
|
| One of 'full', 'read_only'. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| Id of dealer resource. |
|
| |
|
| User is admin. Default: False |
|
| |
|
| Resource id. |
|
| |
|
| Id of extension resource. |
|
| Id of client resource. |
|
| Id of extension_group resource. |
|
| |
|
| |
|
|
...
GET /admin/users/search/
User search
Query parameters
Name | Type | Description | ||
---|---|---|---|---|
|
| Required. | Default: 1 | |
|
| |||
|
| Required. | ||
|
|
|
| Default: 1 |
|
| One of 'active', 'blocked'. | ||
|
| One of 'full', 'read_only'. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
|
...
Name | Type | Description |
---|---|---|
|
| 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. |
...
Name | Type | Description |
---|---|---|
|
| Required. |
JSON parameters
Name | Type | Description |
---|---|---|
|
| Network_address/mask list. |
|
| Network_address/mask list. |
...
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| Resource id. |
PUT /admin/{client_id}/phone_event/{id
}
Update client event
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. Resource id. |
|
| Required. |
JSON parameters
Name | Type | Description |
---|---|---|
|
| Request url. |
|
| Call event type. One of 'dial-in', 'dial-out', 'hangup', 'answer', 'message-in', 'message-out', 'voicemail'. |
|
| Http request method. One of 'GET', 'POST'. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| Resource id. |
GET /admin/{client_id}/phone_event/{id
}
Get client event
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. Resource id. |
|
| Required. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| Resource id. |
DELETE /admin/{client_id}/phone_event/{id
}
Delete client event
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. Resource id. |
|
| Required. |
POST /admin/{client_id}/phone_events/
Add client phone event
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
JSON parameters
Name | Type | Description |
---|---|---|
|
| Required. Request url. |
|
| Required. Call event type. One of 'dial-in', 'dial-out', 'hangup', 'answer', 'message-in', 'message-out', 'voicemail'. |
|
| Required. Http request method. One of 'GET', 'POST'. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| Resource id. |
GET /admin/{client_id}/phone_events/
Get client event list
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
Resource fields
Name | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| Resource id. |
DELETE /admin/{client_id}/phone_events/
Delete all client events
...
GET /admin/voicemail/{record_uuid}/full_path/
Get voicemail storage url
Path parameters
Name | Type | Description |
---|---|---|
|
| Required. |
...