Мы обновили документацию, актуальная версия страницы доступна по ссылке: Внешний номер (/did/)

Ресурс предназначен для управления внешними номерами клиента. Ресурс позволяет получить список доступных клиенту внешних номеров и связывать внешние номера с добавочными.

Описание структур данных

Имя
Тип
Описание

id 

integer

Идентификатор внешнего номера

name 

string

Имя внешнего номера, то есть сам номер

domainstring

Домен внешнего номера

client_idintegerИдентификатор клиента, которому назначен внешний номер
extension_id integerИдентификатор добавочного, которому назначен внешний номер

Пример

Получим список доступных клиенту внешних номеров:

метод
ресурс
данные
ответ
GET
/client/@me/did/


[
{
"id": 6,
"domain": null,
"name": "78123092631",
"client_id": 12,
"extension_id": 149
},
{
"id": 10,
"domain": null,
"name": "000104839",
"client_id": 12,
"extension_id": null
}
]

Запрос вернул список из двух внешних номеров, один из которых уже назначен добавочному с идентификатором 149.

Назначим внешний номер 000104839 добавочному с идентификатором 30:

метод
ресурс
данные
ответ
PUT
/client/@me/did/10

 {

"extension_id": 30
}

{
"id": 10,
"domain": null,
"name": "000104839",
"client_id": 12,
"extension_id": 30
}

Ресурсы раздела "Клиент"

GET /client/{client_id}/did/

Получить список внешних номеров клиента

Параметры URL

Имя

Тип

client_id

string

Параметры запроса

Имя

Тип

name

array [string]

domain

array [string]

id

array [integer]

extension_id

array [integer]

Поля ответа

Имя

Тип

name

string

domain

object

extension_id

integer

client_id

integer

id

integer

PUT /client/{client_id}/did/{did_id}

Обновить внешний номер

Параметры URL

Имя

Тип

did_id

integer

client_id

string

Параметры JSON

Имя

Тип

Обязательный

extension_id

integer

нет

Поля ответа

Имя

Тип

name

string

domain

object

extension_id

integer

client_id

integer

id

integer

GET /client/{client_id}/did/{did_id}

Получить внешний номер

Параметры URL

Имя

Тип

did_id

integer

client_id

string

Поля ответа

Имя

Тип

name

string

domain

object

extension_id

integer

client_id

integer

id

integer

Теги по теме