Открытый интерфейс API для интеграции CRM, Контакт-центра и виртуальной АТС

1. Постановка задачи

Для постановки задачи автоинформирования необходимо вызвать скрипт www.cloff.ru/api/ai.task.set.php и методом POST передать следующие параметры:

recid

Учётная запись в системе

username

Имя пользователя

password

Hash сумма строки, сформированной как "{Учётная запись},{Имя пользователя},{Пароль}" по алгоритму MD5 (RFC 1321)

algid

ID шаблона обзвона (см. Сервисы->Автоинформатор->Мои шаблоны поле №)

dtstart

Дата и время запуска задачи (в случае отсутствия - текущее время)

csv_file

Файл с номерами для обзвона каждая строка содержит 1 запись следующего формата: 88121112233;DESCR;TIME;FILEID;VOICEID;VOICETEXT;DIALTIMEOUT;DTEND;DTDIFF;CLIID;CCPHONE;ANI; OPGROUPID
Обязательным полем является только первое – номер для обзвона в формате 8XXXYYYYYYY для номеров РФ и 810ZZZZZZZZZZZ для международных номеров

Остальные поля:

DESCR	описание (можно указать 2 значения, разделив их символом ~ тильда)
TIME	дата и время обзвона номера, например 2011-07-18 14:30:00
FILEID	идентификатор ранее загруженного в систему звукового файла
VOICEID	тип голоса (0 – женский; 1 – мужской)
VOICETEXT	текст сообщения (читается, если алгоритм содержит точку типа ТТС) Также поддерживается механизм автозамены. Для этого в нужные места текста вставляются маркеры {S}, а в следующих после текста полях – значения для замены (количество маркеров должно соответствовать количеству значений)
DIALTIMEOUT	время дозвона в секундах
DTEND	время жизни сообщения
DTDIFF	"сдвиг" времени обзвона (время указывается для МСК, а этот параметр – поправка на часовой пояс абонента)
CLIID	числовой параметр – идентификатор в "вашей" CRM позволяет впоследствии отслеживать "историю" оповещений абонента
CCPHONE	номер оператора колл-центра, который будет обслуживать абонента. В случае если в шаблоне указан список номеров, а в записи заполнено это поле, то список будет проигнорирован и дозвон будет производиться только на этот номер
ANI	индивидуальный АОН для звонка абоненту в формате XXXYYYYYYY без лидирующей восьмёрки
OPGROUPID	ID группы операторов (списка) для второго вызова

В ответ сервер передаст JSON объект следующего вида:

{"errorcode":0,"data":{"id":17987000,"name":"\u041d\u043e\u0432\u0430\u044f
\u0437\u0430\u0434\u0430\u0447\u0430","dtstart":"2017-02-28 11:50:00","status":"\u0412
\u043e\u0447\u0435\u0440\u0435\u0434\u0438","countphone":10}}

Либо в случае ошибки:

{"errorcode":2,"errormessage":"Autentification failed"}

2. Список номеров задачи

Для получения списка номеров задачи автоинформирования необходимо вызвать скрипт www.cloff.ru/api/ai.task.phone.list.php и методом POST передать следующие параметры:

recid	Учётная запись в системе
username	Имя пользователя
password	Hash сумма строки, сформированной как "{Учётная запись},{Имя пользователя},{Пароль}" по алгоритму MD5 (RFC 1321)
taskid	ID ранее поставленной задачи (см. раздел "Постановка задачи")

В ответ сервер передаст JSON объект следующего вида:

{"errorcode":0,"data":{"arrcall":[{"id":168237400,"phone":"89211112233","ani":"","dtstart":"28.02.2017
11:51","dtend":"","status":"\u0412
\u043e\u0447\u0435\u0440\u0435\u0434\u0438","jobstatus":0,"attemptsdone":0,"maxattempts":3,"info":""}
,{"id":168237401,"phone":"89211112231","ani":"","dtstart":"28.02.2017 11:51","dtend":"","status":"\u0412
\u043e\u0447\u0435\u0440\u0435\u0434\u0438","jobstatus":0,"attemptsdone":0,"maxattempts":3,"info":""}
,{"id":168237402,"phone":"89211112232","ani":"","dtstart":"28.02.2017 11:51","dtend":"","status":"\u0412
\u043e\u0447\u0435\u0440\u0435\u0434\u0438","jobstatus":0,"attemptsdone":0,"maxattempts":3,"info":""}
,{"id":168237403,"phone":"89211112234","ani":"","dtstart":"28.02.2017 11:51","dtend":"","status":"\u0412
\u043e\u0447\u0435\u0440\u0435\u0434\u0438","jobstatus":0,"attemptsdone":0,"maxattempts":3,"info":""}
,{"id":168237404,"phone":"89211112235","ani":"","dtstart":"28.02.2017 11:51","dtend":"","status":"\u0412
\u043e\u0447\u0435\u0440\u0435\u0434\u0438","jobstatus":0,"attemptsdone":0,"maxattempts":3,"info":""}
,{"id":168237405,"phone":"89211112236","ani":"","dtstart":"28.02.2017 11:51","dtend":"","status":"\u0412
\u043e\u0447\u0435\u0440\u0435\u0434\u0438","jobstatus":0,"attemptsdone":0,"maxattempts":3,"info":""}
,{"id":168237406,"phone":"89211112237","ani":"","dtstart":"28.02.2017 11:51","dtend":"","status":"\u0412
\u043e\u0447\u0435\u0440\u0435\u0434\u0438","jobstatus":0,"attemptsdone":0,"maxattempts":3,"info":""}
,{"id":168237407,"phone":"89211112238","ani":"","dtstart":"28.02.2017 11:51","dtend":"","status":"\u0412
\u043e\u0447\u0435\u0440\u0435\u0434\u0438","jobstatus":0,"attemptsdone":0,"maxattempts":3,"info":""}
,{"id":168237408,"phone":"89211112239","ani":"","dtstart":"28.02.2017 11:51","dtend":"","status":"\u0412
\u043e\u0447\u0435\u0440\u0435\u0434\u0438","jobstatus":0,"attemptsdone":0,"maxattempts":3,"info":""}
,{"id":168237409,"phone":"89211112240","ani":"","dtstart":"28.02.2017 11:51","dtend":"","status":"\u0412
\u043e\u0447\u0435\u0440\u0435\u0434\u0438","jobstatus":0,"attemptsdone":0,"maxattempts":3,"info":""}
] }}

Либо в случае ошибки:

{"errorcode":2,"errormessage":"Autentification failed"}

3. Подробности звонков на номер

Для получения списка звонков на конкретный номер необходимо вызвать скрипт www.cloff.ru/api/ai.task.phone.detail.php и методом POST передать следующие параметры:

recid	Учётная запись в системе
username	Имя пользователя
password	Hash сумма строки, сформированной как "{Учётная запись},{Имя пользователя},{Пароль}" по алгоритму MD5 (RFC 1321)
taskid	ID ранее поставленной задачи (см. раздел "Список номеров задачи")

В ответ сервер передаст JSON объект следующего вида:

{"errorcode":0,"data":{"arrcalls":[{"id":114129,"phone":"89211112233","ani":"","dtadd":"2017-02-17
13:36:33","callphone":"89211112233","callani":"8123350515","callduration":23,"linkduration":15,"pay":1.64}]}}

Либо в случае ошибки:

{"errorcode":2,"errormessage":"Autentification failed"}

4. Список звонков задачи

Для получения списка всех звонков в рамках конкретной задачи необходимо вызвать скрипт www.cloff.ru/api/ai.task.call.list.php и методом POST передать следующие параметры:

recid	Учётная запись в системе
username	Имя пользователя
password	Hash сумма строки, сформированной как "{Учётная запись},{Имя пользователя},{Пароль}" по алгоритму MD5 (RFC 1321)
taskid	ID ранее поставленной задачи (см. раздел "Постановка задачи")

В ответ сервер передаст JSON объект следующего вида:

{"errorcode":0,"data":{"arrcall":[{"id":59075,"dt":"17.02.2017
16:55","phone":"89211112233","ani":"8123350515","duration":16,"linkduration":"7","pay":"1.64","dtmf":"","use
r":"","info":""}, {"id":59076,"dt":"17.02.2017
16:28","phone":"89211112234","ani":"8123350515","duration":"33"linkduration":"17","pay":"1.64","dtmf":"","u
ser":"","info":""}] }}

Либо в случае ошибки:

{"errorcode":2,"errormessage":"Autentification failed"}

5. Приостановить задачу

Для временного прекращения обработки задачи необходимо вызвать скрипт www.cloff.ru/api/ai.task.stop.php и методом POST передать следующие параметры:

recid	Учётная запись в системе
username	Имя пользователя
password	Hash сумма строки, сформированной как "{Учётная запись},{Имя пользователя},{Пароль}" по алгоритму MD5 (RFC 1321)
taskid	ID ранее поставленной задачи (см. раздел "Постановка задачи")

В ответ сервер передаст JSON объект следующего вида:

{"errorcode":0,"data":{"id":17986990,"name":"test task","dtstart":"2015-07-31
14:17:06","status":"\u041f\u0440\u0438\u043e\u0441\u0442\u0430\u043d\u043e\u0432\u043b\u0435\u043d
\u0430","countphone":0}}

Либо в случае ошибки:

{"errorcode":2,"errormessage":"Autentification failed"}

6. Запустить задачу

Для возобновления обработки задачи необходимо вызвать скрипт www.cloff.ru/api/ai.task.unstop.php и методом POST передать следующие параметры:

recid	Учётная запись в системе
username	Имя пользователя
password	Hash сумма строки, сформированной как "{Учётная запись},{Имя пользователя},{Пароль}" по алгоритму MD5 (RFC 1321)
taskid	ID ранее поставленной задачи (см. раздел "Постановка задачи")

В ответ сервер передаст JSON объект следующего вида:

{"errorcode":0,"data":{"id":17986990,"name":"test task","dtstart":"2015-07-31
14:17:06","status":"\u0412\u044b\u043f\u043e\u043b\u043d\u044f\u0435\u0442\u0441\u044f","countphone
":0}}

Либо в случае ошибки:

{"errorcode":2,"errormessage":"Autentification failed"}

7. Завершить задачу

Для полного досрочного завершения обработки задачи необходимо вызвать скрипт www.cloff.ru/api/ai.task.end.php и методом POST передать следующие параметры:

recid	Учётная запись в системе
username	Имя пользователя
password	Hash сумма строки, сформированной как "{Учётная запись},{Имя пользователя},{Пароль}" по алгоритму MD5 (RFC 1321)
taskid	ID ранее поставленной задачи (см. раздел "Постановка задачи")

В ответ сервер передаст JSON объект следующего вида:

{"errorcode":0,"data":{"id":17986990,"name":"test task","dtstart":"2015-07-31
14:17:06","status":"\u0412\u044b\u043f\u043e\u043b\u043d\u044f\u0435\u0442\u0441\u044f","countphone
":0}}

Либо в случае ошибки:

{"errorcode":2,"errormessage":"Autentification failed"}

1. Добавление клиента

Для добавления нового клиента необходимо:

Перейти в редакторы структуры "CRM" > "Настройки" > "Редактор структуры" и задать для всех импортируемых полей уникальный идентификатор – столбец "Код".
Внимание! Поле данных под номером 1: "Код" является обязательным и должно быть уникальным в рамках CRM.
Затем вызвать скрипт www.cloff.ru/api/crm.insert.php и методом POST передать следующие параметры:

recid	Учётная запись в системе
username	Имя пользователя
password	Hash сумма строки, сформированной как "{Учётная запись},{Имя пользователя},{Пароль}" по алгоритму MD5 (RFC 1321)
csv_file	Файл формата CSV разделитель ";". Первая строка должна содержать "коды" полей данных для добавления. Для добавления контактов следует использовать заголовок contact:phone – для добавления контакта типа телефон, либо contact:email для добавления адреса электронной почты. Каждая следующая строка содержит запись с данными клиента для добавления. Внимание! Количество полей записи не должно быть меньше полей в заголовке файла. Избыточные поля в строке будут проигнорированы.

В ответ сервер передаст JSON объект следующего вида:

{"errorcode":0,"data":{"line_count":10,"client_created":9,"arr_errors":["Поле code:25646894321 содержит не уникальное значение\r\n"]}}

Либо в случае ошибки:

{"errorcode":2,"errormessage":"Autentification failed"}

2. Изменение данных клиента

Для изменения (обновления) данных существующего клиента необходимо вызвать скрипт www.cloff.ru/api/crm.update.php и методом POST передать следующие параметры:

recid	Учётная запись в системе
username	Имя пользователя
password	Hash сумма строки, сформированной как "{Учётная запись},{Имя пользователя},{Пароль}" по алгоритму MD5 (RFC 1321)
csv_file	Файл формата CSV разделитель ";". Первая строка должна содержать "коды" полей данных для обновления. Внимание! В списке передаваемых полей обязательно должен присутствовать уникальный идентификатор поле code. Каждая следующая строка содержит запись с данными клиента для изменения. Внимание! Количество полей записи не должно быть меньше полей в заголовке файла. Избыточные поля в строке будут проигнорированы.

В ответ сервер передаст JSON объект следующего вида:

{"errorcode":0,"data":{"line_count":4,"client_updated":4,"arr_errors":[]}}

Либо в случае ошибки:

{"errorcode":2,"errormessage":"Autentification failed"}

1. Постановка задачи

Для постановки задачи смс-рассылки необходимо вызвать скрипт www.cloff.ru/api/sms.task.set.php и методом POST передать следующие параметры:

recid	Учётная запись в системе
username	Имя пользователя
password	Hash сумма строки, сформированной как "{Учётная запись},{Имя пользователя},{Пароль}" по алгоритму MD5 (RFC 1321)
sendername	Имя отправителя СМС (должно быть зарегистрированным для Вас именем в системе)
text	Текст отправляемого СМС сообщения
start	Дата и время запуска задачи (в случае отсутствия – текущее время)
phone	Номер телефона для отправки одиночного СМС сообщения (для отправки рассылки воспользуйтесь параметром csv_file)
csv_file	Файл с номерами для отправки СМС рассылки (для отправки одиночного сообщения воспользуйтесь параметром phone). Каждая строка содержит номер телефона в следующем формате: 8XXXYYYYYYY (для номеров РФ). СМС-рассылка на международные номера не осуществляется.

В ответ сервер передаст JSON объект следующего вида:

{"errorcode":0,"data":{"id":17987000,"dtstart":"2017-02-28 11:50:00","status":"\u0412 \u043e\u0447\u0435\u0440\u0435\u0434\u0438","countphone":10}}

Либо в случае ошибки:

{"errorcode":2,"errormessage":"Autentification failed"}

2. Статистика задачи

Для получения статуса обработки задачи СМС рассылки необходимо вызвать скрипт www.cloff.ru/api/sms.task.stat.php и методом POST передать следующие параметры:

recid	Учётная запись в системе
username	Имя пользователя
password	Hash сумма строки, сформированной как "{Учётная запись},{Имя пользователя},{Пароль}" по алгоритму MD5 (RFC 1321)
taskid	ID ранее поставленной задачи (см. раздел "Постановка задачи")

В ответ сервер передаст JSON объект следующего вида:

{"errorcode":0,"data":{"arrcall":[{"id":168237400,"phone":"89211112233","dtstart":"28.02.2017 11:51","dtend":"","status":"\u0412 \u043e\u0447\u0435\u0440\u0435\u0434\u0438","text":"\u0422\u0435\u043A\u0441\u0442 \u0441\u043E\u043E\u0431\u0449\u0435\u043D\u0438\u044F"}, {"id":168237401,"phone":"89211112235","dtstart":"28.02.2017 11:51","dtend":"","status":"\u0412 \u043e\u0447\u0435\u0440\u0435\u0434\u0438","text":"\u0422\u0435\u043A\u0441\u0442 \u0441\u043E\u043E\u0431\u0449\u0435\u043D\u0438\u044F"}  ] }}

Либо в случае ошибки:

{"errorcode":2,"errormessage":"Autentification failed"}

2. Завершить задачу

Для завершения обработки задачи необходимо вызвать скрипт www.cloff.ru/api/sms.task.stop.php и методом POST передать следующие параметры:

recid	Учётная запись в системе
username	Имя пользователя
password	Hash сумма строки, сформированной как "{Учётная запись},{Имя пользователя},{Пароль}" по алгоритму MD5 (RFC 1321)
taskid	ID ранее поставленной задачи (см. раздел "Постановка задачи")

В ответ сервер передаст JSON объект следующего вида:

{"errorcode":0,"data":{"id":17986990,"status":"\u0417\u0430\u0432\u0435\u0440\u0448\u0435\u043D\u0430"}}

Либо в случае ошибки:

{"errorcode":2,"errormessage":"Autentification failed"}

1. Получение текущего баланса кабинета

Для получения текущего баланса кабинета необходимо вызвать скрипт www.cloff.ru/api/api.balance.php и методом POST передать следующие параметры:

recid	Учётная запись в системе
username	Имя пользователя
password	Hash сумма строки, сформированной как "{Учётная запись},{Имя пользователя},{Пароль}" по алгоритму MD5 (RFC 1321)

Сумма баланса возвращается в рублях.

В ответ сервер передаст JSON объект следующего вида:

{"errorcode":0,"data":{"balance":2500}}

Либо в случае ошибки:

{"errorcode":2,"errormessage":"Autentification failed"}

API для интеграции c CLOFF

1. Постановка задачи

2. Список номеров задачи

3. Подробности звонков на номер

4. Список звонков задачи

5. Приостановить задачу

6. Запустить задачу

7. Завершить задачу

1. Добавление клиента

2. Изменение данных клиента

1. Постановка задачи

2. Статистика задачи

2. Завершить задачу

1. Получение текущего баланса кабинета