Вы находитесь на странице: 1из 30

REST API ВАТС (CRM)

Дмитрий Есиков

Copyright © 2021 ITooLabs


Содержание

Содержание

1. Общая информация 3

2. Авторизация запросов к ВАТС 3

3. Авторизация 4

3.1 Авторизация (интеграция CRM) 4

3.2 Входные параметры (() – тип, * – обязательный параметр): 4

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

3.4 Ответы ВАТС на запрос авторизации: 4

4. Запросы от ВАТС к CRM или базе данных 6

4.1 Запросы от ВАТС к CRM или базе данных 6

4.2 history (GET/POST) ВАТС➞ CRM 7

4.3 event (POST) ВАТС➞ CRM 9

4.4 contact (POST) ВАТС➞ CRM 11

5. Запросы от CRM или базы данных к ВАТС 13

5.1 Запросы от CRM или базы данных к ВАТС 13

5.2 accounts (GET/POST) CRM➞ ВАТС 14

5.3 groups (GET/POST) CRM➞ ВАТС 16

5.4 makeCall (POST) CRM➞ ВАТС 18

5.5 history (GET/POST) CRM➞ ВАТС 20

5.6 subscribeOnCalls (GET/POST) CRM➞ ВАТС 22

5.7 subscriptionStatus (GET/POST) CRM➞ ВАТС 24

5.8 set_dnd (POST) CRM➞ ВАТС 26

5.9 get_dnd (POST) CRM➞ ВАТС 28

6. Дополнительные сценарии 30

- 2/30 - Copyright © 2021 ITooLabs


1. Общая информация

1. Общая информация

API позволяет подключить к ВАТС любую собственную CRM или базу данных. Интеграция CRM и ВАТС решает несколько бизнес-задач:

• получение имени звонящего по номеру телефона, для того, чтобы его можно было отобразить на экране телефона или SIP-клиента;

• автоматическая маршрутизация входящего звонка от клиента на менеджера, который закреплен за этим клиентом;

• отображение информации о входящем звонке непосредственно внутри CRM (всплывающая карточка клиента)

• сохранение в CRM истории всех звонков и записей разговоров;

• совершение исходящих звонков сразу из интерфейса CRM.

Интеграция должна быть двухсторонней. Поэтому часть запросов CRM посылает в сторону ВАТС на указанные точки входа, а часть
запросов, наоборот, ВАТС посылает в сторону CRM на единую точку входа.

Взаимодействие производится по протоколу HTTPS. Запросы к ВАТС принимаются только по протоколу HTTPS. Это обеспечивает
достаточный уровень безопасности для общения систем через Интернет. В целях безопасности данных прием запросов на стороне CRM
также рекомендуется реализовывать с использованием протокола HTTPS.

Авторизация осуществляется по адресу CRM или ВАТС, а также по авторизационному ключу, полученному в процессе настройки
интеграции.

Для работы с API необходимо реализовать ответную часть на стороне собственной CRM или базы данных.

Если необходимо подключить какую-либо популярную облачную или коробочную CRM и она не присутствует в списке интеграций,
обратитесь в службу поддержки.

2. Авторизация запросов к ВАТС

Для авторизации каждого запроса к ВАТС используется специальный ключ (token). Получить его можно в личном кабинете ВАТС.

Прием запросов на стороне CRM также необходимо реализовать с использованием ключа (token). Необходимо сгенерировать ключ и
вставить его в соответствующее поле в разделе “Настройки интеграции” через API личного кабинета ВАТС.

Ключи создаются один раз при настройке интеграции CRM. При необходимости можно сменить ключ на своей стороне и обновить его в
интерфейсе ВАТС.

- 3/30 - Copyright © 2021 ITooLabs


3. Авторизация

3. Авторизация

3.1 Авторизация (интеграция CRM)


Авторизация осуществляется по имени домена в CRM или ВАТС, а также по авторизационному токену, полученному в процессе настройки
интеграции.

3.2 Входные параметры (() – тип, * – обязательный параметр):


• crm_code (string)* – идентификатор CRM

• crm_token (string)* – токен, с которым ВАТС взаимодействует с CRM для авторизации запросов

• login (string)* – логин администратора ВАТС

• password (string)* – пароль администратора ВАТС

• redirect_url (string) – url, на который осуществляется переход после завершения настройки интеграции в случае отсутствия логина и
пароля

• self_map (boolean) – флаг, отвечающий за сопоставление пользователей на стороне CRM

• url (string)* – полный url, по которому ВАТС обращается в CRM c запросами

Внимание!

Если не указан login и password , то осуществится переход на страницу авторизации с последующим переходом на страницу настроек, но в
этом случае обязательно должен быть указан redirect_uri .

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


POST https://domain/sys/api_login.wcgp
// domain – имя домена виртуальной АТС, например domain.itoolabs.com
login=admin
password=pass
crm_code=mycrm
crm_token=76fsd7tfs-fhjdgfdjsfsk-hfgsdguuuwoeiwey1111
url=https://crm.ru/crm_integration.php

3.4 Ответы ВАТС на запрос авторизации:


• Авторизация прошла успешно. Отправка токена, с которым CRM должна авторизовывать все запросы к ВАТС

HTTP/1.1 200 OK
Content-Type: application/json
{
"token": "5f317b9f-e86c-41f7-a6fc-c76eb0da0000"
}

• Переданы некорректные параметры

HTTP/1.1 400 Bad Request


Content-Type: application/json
{

- 4/30 - Copyright © 2021 ITooLabs


3.4 Ответы ВАТС на запрос авторизации:

"error": "Invalid parameters"


}

• Указаны некорректные данные для авторизации

HTTP/1.1 401 Unauthorized


Content-Type: application/json
{
"error": "Authorization failed"
}

- 5/30 - Copyright © 2021 ITooLabs


4. Запросы от ВАТС к CRM или базе данных

4. Запросы от ВАТС к CRM или базе данных

4.1 Запросы от ВАТС к CRM или базе данных


При выполнении запросов от ВАС к CRM, ВАТС отправляет все запросы на указанный при создании интеграции адрес в личном кабинете
ВАТС. Необходимо подготовить на стороне CRM-системы методы для приема описанных в данном документе запросов.

В теле сообщений ВАТС будет передавать указанный вами ключ (token) в личном кабинете ВАТС.

Все ответы на запросы от ВАТС CRM должна присылать в формате JSON в теле ответа (body). Исключение составляют команды history и
event , которые возвращают 200 OK в формате multipart/form-data.

Внимание!

В случае если ответ от CRM в сторону ВАТС пришел в отличном от указанного в описании формате – ВАТС ответит на такое сообщение
следующим образом:
- Не смогли прочитать настройки CRM

HTTP/1.1 400 Bad Request


Content-Type: application/json

{
"error": "Invalid CRM Settings"
}

- 6/30 - Copyright © 2021 ITooLabs


4.2 history (GET/POST) ВАТС➞CRM

4.2 history (GET/POST) ВАТС➞CRM

Описание

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

Команда может быть использована для сохранения в данных ваших клиентов истории и записей входящих и исходящих звонков.

Входные параметры (() – тип, * – обязательный параметр):

• cmd (string)* – тип операции, в данном случае history

• type (string)* – тип звонка

• in – входящий звонок

• out – исходящий звонок

• user (string)* – идентификатор пользователь ВАТС (необходим для сопоставления на стороне CRM)

• ext (string) – внутренний номер пользователя ВАТС (если есть)

• groupRealName (string) – название отдела, если входящий звонок прошел через отдел

• telnum (string) – прямой телефонный номер пользователя ВАТС (если есть)

• phone (string/E.164)* – номер телефона клиента, с которого или на который произошел звонок

• diversion (string/E.164)* – личный номер телефона, через который прошел входящий вызов

• start (timestamp)* – время начала звонка в формате YYYYmmddTHHMMSSZ, где: YYYY - год, mm – месяц, dd – день, HH – часы, MM
– минуты, SS – секунды, T – разделитель

• duration (number)* – общая длительность звонка в секундах

• callid (string)* – уникальный id звонка

• link (string)* – ссылка на запись звонка (если она включена в ВАТС)

• crm_token (string)* – ключ (token) от CRM, установленный в личном кабинете

• status (string)* – статус входящего/исходящего звонка

• Success – успешный входящий(исходящий) звонок

• Missed – пропущенный входящий(исходящий) звонок

• Cancel – входящий(исходящий) звонок отменен

• Busy – получен ответ “Занято” (только исходящий)

• NotAvailable – получен ответ “Абонент недоступен” (только исходящий)

• NotAllowed – получен ответ “Звонки на это направление запрещены” (только исходящий)

• NotFound – получен ответ “Вызываемый абонент не найден, нет такого SIP номера” (только исходящий)

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

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

- 7/30 - Copyright © 2021 ITooLabs


4.2 history (GET/POST) ВАТС➞CRM

Ответы CRM на запрос history:

• История и запись входящего/исходящего разговора успешно сохранены

HTTP/1.1 200 OK
Content-Type: multipart/form-data

• Переданы некорректные параметры

HTTP/1.1 400 Bad Request


Content-Type: application/json
{
"error": "Invalid parameters: [cmd]"
}

• Передан неверный токен

HTTP/1.1 401 Unauthorized


Content-Type: application/json
{
"error": "CRM not found"
}

• Токен отсутствует

HTTP/1.1 401 Unauthorized


Content-Type: application/json
{
"error": "Empty token"
}

- 8/30 - Copyright © 2021 ITooLabs


4.3 event (POST) ВАТС➞CRM

4.3 event (POST) ВАТС➞CRM

Описание

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

Входные параметры (() –тип, * – обязательный параметр):

• cmd (string)* – тип операции, в данном случае event

• type (string)* – тип события связанного со звонком

• incoming – поступил входящий звонок (у менеджера должен начать звонить телефон в это время)

• accepted – звонок успешно принят (менеджер снял трубку). В этот момент можно убрать всплывающую карточку контакта в CRM

• completed – звонок успешно завершен (менеджер или клиент положили трубку после разговора)

• cancelled – звонок сброшен (клиент не дождался пока менеджер снимет трубку, либо если это был звонок на группу менеджеров,
на звонок мог ответить кто-то еще)

• outgoing – менеджер совершает исходящий звонок (ВАТС пытается дозвониться до клиента)

• transferred - звонок переведен на другого сотрудника или отдел из ВАТС/на внешний номер

• phone (string/E.164)* – номер телефона клиента

• diversion (string/E.164)* – личный номер телефона, через который прошел входящий вызов

• user (string)* – идентификатор пользователь ВАТС (необходим для сопоставления на стороне CRM)

• groupRealName (string) – название отдела, если входящий звонок прошел через отдел

• ext (string) –внутренний номер пользователя ВАТС (если есть)

• telnum (string) – прямой телефонный номер пользователя ВАТС (если есть)

• callid (string)* – уникальный id звонка

• crm_token (string) – ключ (token) от CRM, установленный в личном кабинете*

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

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

Ответы CRM на запрос event:

• Уведомление успешно отправлено

HTTP/1.1 200 OK
Content-Type: multipart/form-data

• Переданы некорректные параметры

HTTP/1.1 400 Bad Request


Content-Type: application/json
{

- 9/30 - Copyright © 2021 ITooLabs


4.3 event (POST) ВАТС➞CRM

"error": "Invalid parameters: [cmd]"


}

• Передан неверный токен

HTTP/1.1 401 Unauthorized


Content-Type: application/json
{
"error": "CRM not found"
}

• Токен отсутствует

HTTP/1.1 400 Bad Request


Content-Type: application/json
{
"error": "Empty token"
}

- 10/30 - Copyright © 2021 ITooLabs


4.4 contact (POST) ВАТС➞CRM

4.4 contact (POST) ВАТС➞CRM

Описание

С помощью команды contact CRM получает информацию о названии клиента и ответственном за него сотруднике по номеру его телефона.
Команда вызывается при поступлении нового входящего звонка.

Команда contact используется для отображения на экране IP-телефона или в коммуникаторе на ПК сотрудника названия клиента.

В ВАТС можно включить функцию автоматического перевода каждого звонка от клиента сразу на ответственного за него менеджера,
указанного в CRM. Данная функция активируется вручную в личном кабинете ВАТС.При включении данной функции необходимо выбрать
номер(а) телефона, на котором будет работать данная функция, а также определить на кого будет переведен звонок, если ответственный
сотрудник не отвечает или занят.

Входные параметры (() – тип, * – обязательный параметр):

• cmd (string)* – тип операции, в данном случае contact

• phone (string/E.164)* – номер телефона клиента

• diversion (string/E.164)* – личный номер телефона, через который прошел входящий вызов

• callid (string)* – уникальный id звонка

• crm_token (string)* – ключ (token) от CRM, установленный в личном кабинете

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

POST https://crm.ru/crm_integration.php

cmd=contact
phone=79101234567
diversion=74957654321
crm_token=76fsd7tfs-fhjdgfdjsfsk-hfgsdguuuwoeiwey1111
callid=B10D0EB124F4E64AF4EA-1511

Ответы CRM на запрос contact:

• Уведомление успешно отправлено

HTTP/1.1 200 OK
Content-Type: application/json
{
contact_name:"Менеджер ЗАО Рога и копыта",
responsible:andy
}

Внимание!

• contact_name - имя контакта (обязательный параметр в ответе)

• responsible - id ответственного пользователя. Нужно для автоматической маршрутизации звонка. В поле responsible может быть
передан логин, внутренний номер или прямой телефонный номер пользователя ВАТС

• Переданы некорректные параметры

HTTP/1.1 400 Bad Request


Content-Type: application/json
{

- 11/30 - Copyright © 2021 ITooLabs


4.4 contact (POST) ВАТС➞CRM

"error": "Invalid parameters: [cmd]"


}

• Передан неверный токен

HTTP/1.1 401 Unauthorized


Content-Type: application/json
{
"error": "CRM not found"
}

• Токен отсутствует

HTTP/1.1 400 Bad Request


Content-Type: application/json
{
"error": "Empty token"
}

- 12/30 - Copyright © 2021 ITooLabs


5. Запросы от CRM или базы данных к ВАТС

5. Запросы от CRM или базы данных к ВАТС

5.1 Запросы от CRM или базы данных к ВАТС


Запросы необходимо отправлять на указанный адрес в личном кабинете ВАТС. Методы необходимо подготовить в соответствии с
описанием в этой инструкции.

В теле запроса в специальном поле «token» необходимо всегда передавать специальный ключ вида xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx .

Все ответы на запросы от CRM ВАТС присылает в формате JSON в теле ответа (body). Исключение составляет команда history , которая
возвращает ответ в CSV и команда subscribeOnCalls , которая возвращает 200 OK в формате multipart/form-data.

- 13/30 - Copyright © 2021 ITooLabs


5.2 accounts (GET/POST) CRM➞ВАТС

5.2 accounts (GET/POST) CRM➞ВАТС

Описание

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

Входные параметры (() – тип, * – обязательный параметр):

• cmd (string)* – тип операции, в данном случае accounts

• token (string)* – ключ (token) ВАТС, полученный в личном кабинете ВАТС

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

POST https://domain/sys/crm_api.wcgp

cmd=accounts
token=5f317b9f-e86c-41f7-a6fc-c76eb0da0000

Ответы ВАТС на запрос accounts:

• Список сотрудников успешно получен CRM из ВАТС для сопоставления

HTTP/1.1 200 OK
Content-Type: application/json
[
{
"name": "79993216549",
"realName": "qaz"
},
{
"name": "anovikov",
"realName": "А. Новиков",
"ext": "712"
},
{
"name": "avilov",
"realName": "Авилов",
"telnum": "79307957680",
"ext": "717"
},
{
"name": "borisovskytest",
"realName": "BorisovskyTest",
"email": "kborisovsky@mail.ru",
"ext": "000"
}
]

• Переданы некорректные параметры

HTTP/1.1 400 Bad Request


Content-Type: application/json
{
"error": "Invalid parameters: [cmd]"
}

• Передан неверный токен

HTTP/1.1 401 Unauthorized


Content-Type: application/json
{

- 14/30 - Copyright © 2021 ITooLabs


5.2 accounts (GET/POST) CRM➞ВАТС

"error": "CRM not found"


}

• Токен отсутствует

HTTP/1.1 400 Bad Request


Content-Type: application/json
{
"error": "Empty token"
}

- 15/30 - Copyright © 2021 ITooLabs


5.3 groups (GET/POST) CRM➞ВАТС

5.3 groups (GET/POST) CRM➞ВАТС

Описание

Запрос от CRM к ВАТС для получения всех отделов или списка отделов ВАТС, в которые входит указанный сотрудник.

Входные параметры (() – тип, * – обязательный параметр):

• cmd (string)* – тип операции, в данном случае groups

• user (string) – сотрудник ВАТС

• token (string)* – ключ (token) ВАТС, полученный в личном кабинете ВАТС

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

POST https://domain/sys/crm_api.wcgp

cmd=groups
user=ul
token=5f317b9f-e86c-41f7-a6fc-c76eb0da0000000

Ответы ВАТС на запрос groups:

• Список отделов, в которые ходит указанный сотрудник успешно получен CRM из ВАТС

HTTP/1.1 200 OK
Content-Type: application/json
{
[
{
"id": "_g4300431554794814808",
"realName": "simple",
"ext": "780"
},
{
"id": "_g9880781555504163932",
"realName": "test_api_2",
"ext": "182"
}
]
}

• Переданы некорректные параметры

HTTP/1.1 400 Bad Request


Content-Type: application/json
{
"error": "Invalid parameters: [cmd]"
}

• Передан неверный токен

HTTP/1.1 401 Unauthorized


Content-Type: application/json
{
"error": "CRM not found"
}

• Токен отсутствует

HTTP/1.1 400 Bad Request


Content-Type: application/json
{

- 16/30 - Copyright © 2021 ITooLabs


5.3 groups (GET/POST) CRM➞ВАТС

"error": "Empty token"


}

• Неверное имя пользователя

HTTP/1.1 401 Unauthorized


Content-Type: application/json
{
"error": "User not found"
}

- 17/30 - Copyright © 2021 ITooLabs


5.4 makeCall (POST) CRM➞ВАТС

5.4 makeCall (POST) CRM➞ВАТС

Описание

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

Входные параметры (() – тип, * – обязательный параметр):

• cmd (string)* – тип операции, в данном случае makeCall

• phone (string/E.164)* – номер, на который последует звонок

• user (string) – сотрудник ВАТС

• token (string)* – ключ (token) ВАТС, полученный в личном кабинете ВАТС

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

POST https://domain/sys/crm_api.wcgp

cmd=makeCall
phone=79101234567
user=andy
token=5f317b9f-e86c-41f7-a6fc-c76eb0da00000000

Ответы ВАТС на запрос makeCall:

• Уникальный идентификатор звонка

HTTP/1.1 200 OK
Content-Type: application/json
{
uuid: "1nj1284h124vv124hhkj4"
callid: "134hj4645hfg784tu4ch5"
}

• Переданы некорректный параметр cmd

HTTP/1.1 400 Bad Request


Content-Type: application/json
{
"error": "Invalid parameters: [cmd]"
}

• Передан неверный токен

HTTP/1.1 401 Unauthorized


Content-Type: application/json
{
"error": "CRM not found"
}

• Токен отсутствует

HTTP/1.1 400 Bad Request


Content-Type: application/json
{

- 18/30 - Copyright © 2021 ITooLabs


5.4 makeCall (POST) CRM➞ВАТС

"error": "Empty token"


}

• Неверное имя пользователя или пользователя не существует

HTTP/1.1 400 Bad Request


Content-Type: application/json
{
"error": "Invalid parameter user"
}

• Неверный или несуществующий номер телефона

HTTP/1.1 400 Bad Request


Content-Type: application/json
{
"error": "Invalid parameter phone"
}

- 19/30 - Copyright © 2021 ITooLabs


5.5 history (GET/POST) CRM➞ВАТС

5.5 history (GET/POST) CRM➞ВАТС

Описание

Команда необходима для того, чтобы получить из ВАТС историю звонков за нужный период времени.

Входные параметры (() – тип, * – обязательный параметр)"

• cmd (string)* – тип операции, в данном случае history

• token (string)* – ключ (token) ВАТС, полученный в личном кабинете ВАТС

• start (string) – начало периода для выгрузки данных

• end (string) – окончание периода для выгрузки данных

• period (string) – период, за который необходимо выгрузить данные

• today – звонки за сегодня

• yesterday – звонки за вчера

• this_week – звонки за текущую неделю

• last_week – звонки за прошедшую неделю

• this_month – звонки за текущий месяц

• last_month – звонки за прошедший месяц

• type (string) – тип звонка

• all – все звонки

• in – только входящие звонки

• out – только исходящие звонки

• missed – только пропущенные звонки

• limit (string) – лимит записей в полученном результате

Внимание!

• Если в запросе установлено значение period – выгружаются данные за указанный период, независимо от значения start и end .

• Если period не задан, необходимо использовать значения start и end .

• Если end не задан, то end должен быть выставлен в сегодняшнее число.

• Если start не задан, то start выставляется равным end.

• Если не задан ни один из параметров period , start , end , необходимо выгрузить историю за текущее число. start и end указываются в
UTC, в формате YYYYmmddTHHMMSSZ, где: YYYY - год, mm – месяц, dd – день, HH – часы, MM – минуты, SS – секунды, T – разделитель.

• Если в запросе не задан параметр type – используется по-умолчанию all .

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

POST https://domain/sys/crm_api.wcgp

cmd=history
period=yesterday
token=5f317b9f-e86c-41f7-a6fc-c76eb0da000000000

- 20/30 - Copyright © 2021 ITooLabs


5.5 history (GET/POST) CRM➞ВАТС

Ответы ВАТС на запрос history:

• Получены значения истории, разделенные запятыми

HTTP/1.1 200 OK
Content-Type: text/csv

UID,type,client,account,via,start,wait,duration,record

• UID – уникальный идентификатор звонка

• type – тип вызова: in / out / missed

• client – номер клиента

• account – логин сотрудника, который разговаривал с клиентом или имя группы или код: ivr / fax, если звонок не дошел до сотрудника

• via – номер телефона, через который пришел входящий звонок или АОН для исходящего вызова

• start – время начала звонка в UTC

• wait – время ожидания на линии (секунд)

• duration – длительность разговора (секунд)

• record – ссылка на запись разговора**

• Переданы некорректные параметры

HTTP/1.1 400 Bad Request


Content-Type: application/json
{
"error": "Invalid parameters: [cmd]"
}

• Передан неверный токен

HTTP/1.1 401 Unauthorized


Content-Type: application/json
{
"error": "CRM not found"
}

- 21/30 - Copyright © 2021 ITooLabs


5.6 subscribeOnCalls (GET/POST) CRM➞ВАТС

5.6 subscribeOnCalls (GET/POST) CRM➞ВАТС

Описание

Запрос от CRM к ВАТС для включение / выключения приема звонков сотрудником во всех его отделах или конкретном отделе.

Может использоваться для того, чтобы временно отключить прием звонков сотрудником во всех его отделах или конкретном отделе.

Входные параметры (() – тип, * – обязательный параметр):

• cmd (string)* – тип операции, в данном случае subscribeoncalls

• user (string)* – сотрудник ВАТС

• token (string)* – ключ (token) ВАТС, полученный в личном кабинете ВАТС

• group_id (string)* – номер, на который последует звонок

• status (string)* – on – включить прием звонков, off – выключить прием звонков

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

POST https://domain/sys/crm_api.wcgp

cmd=subscribeoncalls
user=ivanov
group_id=sales
status=off
token=5f317b9f-e86c-41f7-a6fc-c76eb0da0000

Ответы ВАТС на запрос subscribeOnCalls:

• Прием звонков указанным сотрудником в указанном отделе успешно включен/выключен

HTTP/1.1 200 OK
Content-Type: multipart/form-data

• Переданы некорректные параметры

HTTP/1.1 400 Bad Request


Content-Type: application/json
{
"error": "Invalid parameters: [cmd]"
}

• Передан неверный токен

HTTP/1.1 401 Unauthorized


Content-Type: application/json
{
"error": "CRM not found"
}

• Токен отсутствует

HTTP/1.1 400 Bad Request


Content-Type: application/json
{
"error": "Empty token"
}

• Неверный параметр user

HTTP/1.1 400 Bad Request


Content-Type: application/json
{

- 22/30 - Copyright © 2021 ITooLabs


5.6 subscribeOnCalls (GET/POST) CRM➞ВАТС

"error": "Invalid parameters: user"


}

• Неверное имя пользователя

HTTP/1.1 400 Bad Request


Content-Type: application/json
{
"error": "User not found"
}

• Неверный параметр status

HTTP/1.1 400 Bad Request


Content-Type: application/json
{
"error": "Invalid parameter: status"
}

- 23/30 - Copyright © 2021 ITooLabs


5.7 subscriptionStatus (GET/POST) CRM➞ВАТС

5.7 subscriptionStatus (GET/POST) CRM➞ВАТС

Описание

Запрос от CRM к ВАТС для проверки факта приема звонков сотрудником в конкретном отделе.

Входные параметры (() – тип, * – обязательный параметр):

• cmd (string)* – тип операции, в данном случае subscriptionstatus

• user (string)* – идентификатор пользователя CRM или аккаунт ВАТС, если при авторизации был установлен self_map = true, для
которого надо выключить/включить прием звонков

• token (string)* – ключ (token) ВАТС, полученный в личном кабинете ВАТС

• group_id (string)* – номер, на который последует звонок

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

POST https://domain/sys/crm_api.wcgp

cmd=subscribtionstatus
user=ivanov
group_id=sales
token=5f317b9f-e86c-41f7-a6fc-c76eb0da0000da0000

Ответы ВАТС на запрос subscriptionstatus:

• Получение статуса подписки

HTTP/1.1 200 OK
Content-Type: application/json
{
status: "on" | "off"
}

• Переданы некорректные параметры

HTTP/1.1 400 Bad Request


Content-Type: application/json
{
"error": "Invalid parameters: [cmd]"
}

• Передан неверный токен

HTTP/1.1 401 Unauthorized


Content-Type: application/json
{
"error": "CRM not found"
}

• Токен отсутствует

HTTP/1.1 400 Bad Request


Content-Type: application/json
{
"error": "Empty token"
}

• Неверный параметр user

HTTP/1.1 400 Bad Request


Content-Type: application/json
{

- 24/30 - Copyright © 2021 ITooLabs


5.7 subscriptionStatus (GET/POST) CRM➞ВАТС

"error": "Invalid parameters: user"


}

• Неверное имя пользователя

HTTP/1.1 400 Bad Request


Content-Type: application/json
{
"error": "User not found"
}

• Неверное имя группы

HTTP/1.1 400 Bad Request


Content-Type: application/json
{
"error": "Group not found"
}

- 25/30 - Copyright © 2021 ITooLabs


5.8 set_dnd (POST) CRM➞ВАТС

5.8 set_dnd (POST) CRM➞ВАТС

Описание

Запрос от CRM к ВАТС позволяет включить или выключить прием звонков сотрудником ВАТС (режим do not disturb).

Входные параметры (() – тип, * – обязательный параметр):

• cmd (string)* – тип операции, в данном случае set_dnd

• user (string)* – идентификатор сотрудника ВАТС

• token (string)* – ключ (token) ВАТС, полученный в личном кабинете ВАТС

• state (string)* – флаг включения/отключения приема звонков сотрудником ВАТС

• true

• false

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

POST https://domain/sys/crm_api.wcgp

cmd=set_dnd
user=ivanov
state=true
token=5f317b9f-e86c-41f7-a6fc-c76eb0da0000

Ответы ВАТС на запрос set_dnd:

• Подтверждение включения/отключения приема звонков указанным сотрудником

HTTP/1.1 200 OK
Content-Type: application/json
{ }

• Переданы некорректные параметры

HTTP/1.1 400 Bad Request


Content-Type: application/json
{
"error": "Invalid parameters: [cmd]"
}

• Передан неверный токен

HTTP/1.1 401 Unauthorized


Content-Type: application/json
{
"error": "CRM not found"
}

• Токен отсутствует

HTTP/1.1 400 Bad Request


Content-Type: application/json
{
"error": "Empty token"
}

• Неверный параметр user

HTTP/1.1 400 Bad Request


Content-Type: application/json
{

- 26/30 - Copyright © 2021 ITooLabs


5.8 set_dnd (POST) CRM➞ВАТС

"error": "Invalid parameters: user"


}

• Неверное имя пользователя

HTTP/1.1 400 Bad Request


Content-Type: application/json
{
"error": "User not found"
}

• Неверный параметр status

HTTP/1.1 400 Bad Request


Content-Type: application/json
{
"error": "Invalid parameter: status"
}

- 27/30 - Copyright © 2021 ITooLabs


5.9 get_dnd (POST) CRM➞ВАТС

5.9 get_dnd (POST) CRM➞ВАТС

Описание

Запрос от CRM к ВАТС позволяет узнать включен или выключен прием звонков сотрудником ВАТС (включен или выключен режим do not
disturb).

Входные параметры (() – тип, * – обязательный параметр):

• cmd (string)* – тип операции, в данном случае set_dnd

• user (string)* – идентификатор сотрудника ВАТС

• token (string)* – ключ (token) ВАТС, полученный в личном кабинете ВАТС

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

POST https://domain/sys/crm_api.wcgp

cmd=get_dnd
user=ivanov
token=5f317b9f-e86c-41f7-a6fc-c76eb0da0000

Ответы ВАТС на запрос get_dnd:

• Получение состояния приема звонков указанным сотрудником ВАТС

HTTP/1.1 200 OK
Content-Type: application/json
{
state: true | false
}

• Переданы некорректные параметры

HTTP/1.1 400 Bad Request


Content-Type: application/json
{
"error": "Invalid parameters: [cmd]"
}

• Передан неверный токен

HTTP/1.1 401 Unauthorized


Content-Type: application/json
{
"error": "CRM not found"
}

• Токен отсутствует

HTTP/1.1 400 Bad Request


Content-Type: application/json
{
"error": "Empty token"
}

• Неверный параметр user

HTTP/1.1 400 Bad Request


Content-Type: application/json
{

- 28/30 - Copyright © 2021 ITooLabs


5.9 get_dnd (POST) CRM➞ВАТС

"error": "Invalid parameters: user"


}

• Неверное имя пользователя

HTTP/1.1 400 Bad Request


Content-Type: application/json
{
"error": "User not found"
}

- 29/30 - Copyright © 2021 ITooLabs


6. Дополнительные сценарии

6. Дополнительные сценарии

Используя перечисленные выше команды возможно реализовать в CRM другие функции например:

• Для контроля результатов по работе с пропущенными звонками возможно автоматическое создание нового контакта или лида для
каждого пропущенного звонка с неизвестного номера с назначением на старшего менеджера. Если контакту не перезвонили, он так и
останется на старшем менеджере. Старший менеджер всегда увидит такие контакты.

• Для быстрой и удобной актуализации базы контактов в CRM возможно автоматическое создание нового контакта или лида для
каждого исходящего звонка на неизвестный номер.

• Сохранять историю и записи звонков сотрудников, которые есть в ВАТС, но нет в CRM, от лица пользователя CRM по-умолчанию,
например, от пользователя “все остальные” или “админ”, чтобы вся история звонков и записи разговоров были в CRM.

- 30/30 - Copyright © 2021 ITooLabs

Вам также может понравиться