REST API ВАТС

От Облачной АТС TELCOM к CRM или базе данных:

– history (POST)
– event (POST)
– contact (POST)

От CRM или базы данных к Облачной АТС TELCOM:

– accounts (GET / POST)
– groups (GET / POST)
– makeCall (POST)
– history (GET / POST)
– subscribeOnCalls (POST)
– subscriptionStatus (GET / POST)
– set_dnd (POST)
– get_dnd (GET / POST)

Пожалуйста, реализуйте принимающую и ответную часть для этих команд.

Команда history (POST)

– Входящий звонок клиента и ссылка на запись разговора записывается в CRM – Всегда подключено!
– Исходящий звонок клиента и ссылка на запись разговора записывается в CRM – Всегда подключено!

После успешного звонка в CRM отправляется запрос с данными о звонке и ссылкой на запись разговора.
Команда может быть использована для сохранения в данных ваших клиентов истории и записей входящих и исходящих звонков.
Команда доступна сразу после включения API.

Входные параметры:

Пример запроса:

POST https://crm.ru/crm_integration.php
cmd=history
type=out
status=Success
phone=79101234567
user=user
start=20170703T121110Z
duration=124
link=https://link/file.mp3
crm_token=76fsd7tfs-fhjdgfdjsfsk-hfgsdguuuwoeiwey1111
callid=B10D0EB124F4E64AF4EA-1511

Выходные данные:

Команда event (POST)

При входящем звонке всплывает карточка клиента с его именем – Всегда подключено!
Облачная АТС TELCOM отправляет в вашу CRM уведомления о событиях входящих звонков пользователям: появлении, принятии или завершении звонка. Команда может быть использована для отображения всплывающей карточки клиента в интерфейсе CRM. Команда доступна сразу после включения API.

Входные параметры:

Пример запроса:

POST https://crm.ru/crm_integration.php
cmd=event
type=INCOMING / COMPLETED / ACCEPTED / CANCELLED
phone=79101234567
user=andy
crm_token=76fsd7tfs-fhjdgfdjsfsk-hfgsdguuuwoeiwey1111
callid=B10D0EB124F4E64AF4EA-1511

Выходные данные:

Команда contact (POST)

Команда для получения информации о названии клиента и ответственном за него сотруднике по номеру его телефона. Команда вызывается при поступлении нового входящего звонка.
При входящем звонке имя клиента отображается на экране IP-телефона или коммуникатора – Всегда подключено!
Команда используется для отображения на экране IP-телефона или в коммуникаторе на ПК сотрудника названия клиента.
Этот функционал доступен сразу после включения API.
Звонки от клиентов будут перенаправляться ответственному менеджеру, указанному в CRM – Настроить!
Также в Облачной АТС TELCOM можно включить функцию автоматического перевода каждого звонка от клиента сразу на ответственного за него менеджера, указанного в CRM. Данная функция активируется вручную в веб-кабинете Облачной АТС TELCOM. При включении вам будет необходимо выбрать номер(а) телефона, на котором будет работать данная функция, а также определить на кого будет переведен звонок, если ответственный сотрудник не отвечает или занят.

Входные параметры:

Пример запроса:

POST https://crm.ru/crm_integration.php
cmd=contact
phone=79101234567
crm_token=76fsd7tfs-fhjdgfdjsfsk-hfgsdguuuwoeiwey1111
callid=B10D0EB124F4E64AF4EA-1511

Выходные данные:

В поле responsible может быть передан логин, внутренний номер или прямой телефонный номер пользователя Облачной АТС TELCOM.

Пожалуйста, реализуйте отправку и приемку ответов для этих команд.

Команда accounts (GET / POST)

CRM получает список сотрудников из Облачной АТС для сопоставления – Всегда подключено!
Запрос от CRM к Облачной АТС для получения сотрудников. Может использоваться для сопоставления пользователей в CRM и Облачной АТС TELCOM. Для этого
вам придётся реализовать функционал сопоставления. Вы можете так же настраивать сопоставление пользователей на вашей стороне вручную, без использования этой команды. Команда доступна сразу после включения API.

Входные параметры:

Пример запроса:

POST https://domain/sys/crm_api.wcgp
cmd=accounts
token=5f317b9f-e86c-41f7-a6fc-c76eb0da0000

Выходные данные:

Команда groups (GET / POST)
CRM получает список всех отделов из Облачной АТС или список отделов, в которые входит указанный сотрудник – Всегда подключено!
Запрос от CRM к Облачной АТС для получения отделов. Команда доступна сразу после включения API.

Входные параметры:

Пример запроса:

POST https://domain/sys/crm_api.wcgp
cmd=groups
user=u1
token=5f317b9f-e86c-41f7-a6fc-c76eb0da0000

Выходные данные:

Входные параметры:

Команда makeCall (POST)

Кликом по номеру клиента в CRM совершается исходящий звонок клиенту – Всегда подключено!
Команда необходимая для того, чтобы инициировать звонок от менеджера клиенту. В результате успешного выполнения команды, Облачная АТС TELCOM сделает сначала звонок на телефон менеджера, а потом соединит его с клиентом. Команда может использоваться, например, для звонка по клику на номер клиента в вашей CRM или базе данных. Команда доступна сразу после включения API.

Входные параметры:

Пример запроса:

POST https://domain/sys/crm_api.wcgp
cmd=makeCall
phone=79101234567
user=andy
token=5f317b9f-e86c-41f7-a6fc-c76eb0da0000

Выходные данные:

Команда history (GET / POST)

CRM может запросить истории звонков из Облачной АТС TELCOM за нужный период времени. Команда доступна сразу после включения API.

Входные параметры:

Значения start и end указываются в UTC, в формате YYYYmmddTHHMMSSZ, где
YYYY – год
mm – месяц
dd – день
HH – часы
MM – минуты
SS – секунды
T – разделитель

Пример запроса:

POST https://domain/sys/crm_api.wcgp
cmd=history
period=today
token=5f317b9f-e86c-41f7-a6fc-c76eb0da0000

Выходные данные:

Поля в таблице:

Команда subscribeOnCalls (POST)

CRM может включить или выключить прием звонков сотрудником во всех его отделах или конкретном отделе – Всегда подключено!
Запрос от CRM к Облачной АТС TELCOM для включение / выключения приема звонков сотрудником во всех его отделах или конкретном отделе. Может использоваться для того, чтобы временно выключить прием звонков сотрудником во всех его отделах или конкретном отделе. Команда доступна сразу после включения API.

Входные параметры:

Пример запроса:

POST https://domain/sys/crm_api.wcgp
cmd=subscribeoncalls
user=ivanov
group_id=sales
status=off
token=5f317b9f-e86c-41f7-a6fc-c76eb0da0000

Выходные данные:

Команда subscriptionStatus (GET / POST)

CRM может запросить информацию о том, принимает или не принимает звонки сотрудник в отделе – Всегда подключено!
Запрос от CRM к Облачной АТС TELCOM для проверки факта приема звонков сотрудником в конкретном отделе. Команда доступна сразу после включения API.

Входные параметры:

Пример запроса:

POST https://domain/sys/crm_api.wcgp
cmd=subscribtionstatus
user=ivanov
group_id=sales
token=5f317b9f-e86c-41f7-a6fc-c76eb0da0000

Выходные данные:

Команда set_dnd (POST)

CRM может включить или выключить прием звонков сотрудником (режим do not disturb) – Всегда подключено!
Запрос от CRM к Облачной АТС TELCOM позволяет включить или выключить прием звонков сотрудником Облачной АТС. Команда доступна сразу после включения API.

Входные параметры:

Пример запроса:

POST https://domain/sys/crm_api.wcgp
cmd=set_dnd
user=ivanov
state=true
token=5f317b9f-e86c-41f7-a6fc-c76eb0da0000

Выходные данные:

Команда get_dnd (POST)
CRM может проверить факт прием звонков сотрудником (включен или выключен режим do not disturb) – Всегда подключено!
Запрос от CRM к Облачной АТС TELCOM позволяет узнать включен или выключен прием звонков сотрудником Облачной АТС. Команда доступна сразу после включения API.

Входные параметры:

Пример запроса:

POST https://domain/sys/crm_api.wcgp
cmd=get_dnd
user=ivanov
token=5f317b9f-e86c-41f7-a6fc-c76eb0da0000

Выходные данные:

На основе имеющихся команд вы можете реализовать в вашей CRM другие полезные функции, например:
– Автоматическое создание нового контакта или лида для каждого пропущенного звонка с неизвестного номера с назначением на старшего менеджера. Это полезно для контроля результатов по работе с пропущенными звонками. Если контакту не перезвонили, он так и останется на старшем менеджере. Старший менеджер всегда увидит такие контакты.
– Автоматическое создание нового контакта или лида для каждого исходящего звонка на неизвестный номер. Позволяет быстро и удобно актуализировать базу контактов в CRM.
– Сохранять историю и записи звонков сотрудников, которые есть в Облачной АТС TELCOM, но их нет в CRM, от лица пользователя CRM по умолчанию, например, от пользователя «все остальные» или «админ». Так вся история звонков и записи разговоров всегда будут в вашей CRM.