ВОЙТИ

API для подключения телефонии

Последние изменения: 09.08.2019
добавить в избранные

Следующие методы в случае успеха возвращают пустой результат.

Начало звонка.

Url: https://schooldomain.t8s.ru//Api/V1/OnRinging

При вызове данного метода в CRM у необходимого сотрудника(-ов) появляется окно о звонке.
Хотя бы один из номеров должен являться внутренним номером сотрудника, в том же виде, в котором он указан в CRM. В противном случае, метод вернёт ошибку.

Список параметров (обязательные поля отмечены звёздочкой):

Название

Описание

callId *

Идентификатор звонка

from *

Номер звонящего

to *

Номер адресата

trunkNumber

Номер, через который осуществляется коммуникация (отображается в истории звонков)

utm

UTM-метки в JSON-формате (используются при создании лида из звонка)

 

Смена одного из значений CallerID в длящемся звонке.

Url: https://schooldomain.t8s.ru//Api/V1/OnChangedCallerId

При вызове данного метода можно заменить номер одной из сторон во время звонка.
Заменить можно только внешний номер, внутренний номер сотрудника не меняется.

Список параметров (все поля являются обязательными):

Название

Описание

callId

Идентификатор звонка

old

Старое значение CallerID

new

Новое значение CallerID

 

Подтверждение звонка (снятие трубки).

Url: https://schooldomain.t8s.ru//Api/V1/OnAnswer

Список параметров (все поля являются обязательными):

Название

Описание

callId

Идентификатор звонка

 

Завершение звонка.

Url: https://schooldomain.t8s.ru//Api/V1/OnHangup

При вызове данного метода в CRM закрываются окна о звонке, и звонок добавляется в историю.

Список параметров (обязательные поля отмечены звёздочкой):

Название

Описание

callId *

Идентификатор звонка

cause

Причина завершения звонка (отображается в истории у непринятых звонков)

audioUrl

Ссылка на запись звонка (если указана, то для данного звонка не будет вызываться вебхук-метод запроса аудиофайла звонка)

 

----- Методы обратного вызова (webhooks) -----

Ссылки на данные методы задаются в настройках CRM.

Для проверки подлинности вызова можно использовать произвольный ключ (так же задаётся в настройках CRM, не обязателен).
Данный ключ придёт в качестве аргумента “key” в каждый из нижеуказанных методов (для краткости не указан в списке параметров).

Возвращаемые данные (если они предусмотрены) должны быть представлены в виде JSON.
В случае ошибки вебхук-методы должны возвращать текст ошибки в поле “Error”.
Если возвращаемый код состояния HTTP свидетельствует об ошибке, так же будет отображён соответствующий ему текст ошибки, но текст в поле “Error” имеет больший приоритет.

Исходящий вызов.

Вызывается при клике пользователем CRM на кнопку с изображением трубки возле номера телефона.
Если данный метод не указан, эти кнопки будут скрыты.
Клик по кнопке не является для CRM событием начала звонка. Звонок можно начать только вызовом метода OnRinging.

Список параметров:

Название

Описание

from

Номер звонящего

to

Номер адресата

Возвращаемых данных не предусмотрено.

Завершение звонка.

Вызывается при клике пользователем CRM на кнопку «Завершить» в окне звонке.
Если данный метод не указан, эта кнопка будет скрыта.

Список параметров:

Название

Описание

callId

Идентификатор звонка

Возвращаемых данных не предусмотрено.

Запрос аудиофайла.

Вызывается при клике пользователем CRM на кнопку для воспроизведения состоявшегося звонка из истории звонков.
Если данный метод не указан, эти кнопки будут скрыты (кроме тех звонков, для которых был указан параметр audioUrl в методе OnHangup).

Список параметров:

Название

Описание

created

Unix timestamp начала звонка

finished

Unix timestamp завершения звонка

employeePhones

Внутренние номера телефонии, установленные в данный момент у сотрудника, являющегося одной из сторон звонка

remotePhone

Внешний номер (может быть также внутренним номером сотрудника при внутреннем звонке)

incoming

Признак того, что звонок является входящим относительно первого сотрудника (employeePhones)

Метод должен возвращать массив строк с URL’ами аудиофайлов (массив – на случай, если совпадений несколько), даже если запись одна.

Если запись не найдена, можно возвратить как пустой массив, так и пустой результат (более корректным является первый вариант).