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

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 объект следующего вида:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  1. Перейти в редакторы структуры "CRM" > "Настройки" > "Редактор структуры" и задать для всех импортируемых полей уникальный идентификатор – столбец "Код".
    Внимание! Поле данных под номером 1: "Код" является обязательным и должно быть уникальным в рамках CRM.

  2. Затем вызвать скрипт www.cloff.ru/api/crm.insert.php и методом POST передать следующие параметры:

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

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

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

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

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

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

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

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

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 объект следующего вида:

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

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

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

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

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

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

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

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

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

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

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

Остались вопросы? Звоните!

8 800 555-85-90

ЗВОНОК ПО РФ БЕСПЛАТНЫЙ

VOTBOX ©
2001-2017

8 812 335-05-15
8 495 785-21-01
8 800 555-85-90

Звонки по всей России бесплатно

Техподдержка 24/7


Пополнение балансаVisa MasterCard Сбербанк Яндекс.Деньги Qiwi

×

Восстановление пароля CLOFF

Войти в CLOFF
×

Восстановление пароля VOTBOX

Войти в VOTBOX
CLOFF
VOTBOX
×

Войти в кабинет CLOFF

Забыли пароль? Перейти к регистрации
×

Войти в кабинет VOTBOX

Забыли пароль?
×

Регистрация в CLOFF

×