Протестировать методы API можно на странице интерактивного обозревателя и без написания кода
Некоторые ресурсы, описанные на странице, по-умолчанию могут быть не доступны из-за типа приложения. См. типы и уровни приложений
Ресурс предназначен для управления внешними номерами клиента. Ресурс позволяет получить список доступных клиенту внешних номеров и связывать внешние номера с добавочными.
Описание структур данных
Имя | Тип | Описание |
|---|---|---|
|
| Идентификатор внешнего номера |
|
| Имя внешнего номера, то есть сам номер |
| domain | string | Домен внешнего номера |
client_id | integer | Идентификатор клиента, которому назначен внешний номер |
extension_id | integer | Идентификатор добавочного, которому назначен внешний номер |
Пример
Получим список доступных клиенту внешних номеров:
метод | ресурс | данные | ответ |
|---|---|---|---|
| GET | /client/@me/did/ | [ |
Запрос вернул список из двух внешних номеров, один из которых уже назначен добавочному с идентификатором 149.
Назначим внешний номер 000104839 добавочному с идентификатором 30:
метод | ресурс | данные | ответ |
|---|---|---|---|
| PUT | /client/@me/did/10 | { "extension_id": 30 | { |
Ресурсы раздела "Клиент"
GET /client/{client_id}/did/
Получить список внешних номеров клиента
Параметры URL
Имя | Тип |
|---|---|
|
|
Параметры запроса
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
|
|
PUT /client/{client_id}/did/{did_id}
Обновить внешний номер
Параметры URL
Имя | Тип |
|---|---|
|
|
|
|
Параметры JSON
Имя | Тип | Обязательный |
|---|---|---|
|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
|
|
GET /client/{client_id}/did/{did_id}
Получить внешний номер
Параметры URL
Имя | Тип |
|---|---|
|
|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
|
|
Теги по теме