Внешний номер (/did/)

Протестировать методы API можно на странице интерактивного обозревателя API и без написания кода
Некоторые ресурсы, описанные на странице, по умолчанию могут быть не доступны из-за типа приложения (см. Создание и авторизация приложений)

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

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

Имя

Тип

Описание

Имя

Тип

Описание

id 

long

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

name 

string

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

domain

string

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

client_id

long

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

extension_id 

long

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

allow_message 

boolean

Параметр показывает, разрешается ли получение текстовых сообщений внешним номером

message_extension_id 

long

Идентификатор внутреннего номера, на который будет отправлено полученное текстовое сообщение

comment

string

Комментарий

create_date 

string

Дата создания

Пример

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

Ответ системы:

[ { "comment": "DID1", "domain": null, "create_date": "2020-05-21 15:53:52", "name": "78123092631", "extension_id": 149, "client_id": 12, "id": 6, "allow_message": false, "message_extension_id": null } { "comment": "DID2", "domain": null, "create_date": "2020-05-21 15:58:05", "name": "000104839", "extension_id": null, "client_id": 12, "id": 10, "allow_message": false, "message_extension_id": null } ]

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

Ответ системы:

{ "comment": "DID2", "domain": null, "create_date": "2020-05-21 15:58:05", "name": "000104839", "extension_id": 30, "client_id": 12, "id": 10, "allow_message": false, "message_extension_id": null }

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

GET /client/{client_id}/did/

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

Параметры URL

Имя

Тип

Имя

Тип

client_id

string

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

Имя

Тип

Имя

Тип

domain

array [string]

name

array [string]

page

integer

extension_id

array [integer]

per_page

integer

id

array [integer]

Поля ответа

Имя

Тип

Имя

Тип

allow_message 

boolean

client_id

long

comment

string

create_date 

string

domain

object

extension_id

long

id

long

message_extension_id 

long

name

string

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

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

Параметры URL

Имя

Тип

Имя

Тип

did_id

integer

client_id

string

Параметры JSON

Имя

Тип

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

Имя

Тип

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

extension_id

long

нет

message_extension_id 

long

нет

Поля ответа

Имя

Тип

Имя

Тип

allow_message 

boolean

client_id

long

comment

string

create_date 

string

domain

object

extension_id

long

id

long

message_extension_id 

long

name

string

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

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

Параметры URL

Имя

Тип

Имя

Тип

did_id

integer

client_id

string

Поля ответа

Имя

Тип

Имя

Тип

allow_message 

boolean

client_id

long

comment

string

create_date 

string

domain

object

extension_id

long

id

long

message_extension_id 

long

name

string