75  /  80

Открытые линии Rest API

Просмотров: 4719 (Статистика ведётся с 06.02.2017)

Внимание! Для использования методов IMOPENLINES REST необходимо помимо прав на imbot (Создание и управление чат-ботами) иметь доступ к scope imopenlines (Открытые линии).


Подключение открытой линии по коду

Rest-метод: imopenlines.network.join

Вызов метода:
$result = restCommand('imopenlines.network.join', Array(

    'CODE' => 'ab515f5d85a8b844d484f6ea75a2e494' // код для поиска со страницы коннекторов

), $_REQUEST["auth"]);
Результат выполнения: true или код ошибки.

Возможные ошибки:

Код ошибкиОписание ошибки
IMBOT_ERROR Не установлен модуль по управлению ботами.
NOT_FOUND Открытая линия не найдена.
INACTIVE Открытая линия в данный момент недоступна.

Отправка сообщения от лица открытой линии выбранному пользователю

Rest-метод: imopenlines.network.message.add

Вызов метода:
$result = restCommand('imopenlines.network.message.add', Array(

	'CODE' => 'ab515f5d85a8b844d484f6ea75a2e494', // код зарегистрированной открытой линии
	'USER_ID' => 2, // идентификатор пользователя получателя сообщения
	'MESSAGE' => 'message text' // Тест сообщения
	'ATTACH' => '' // Вложение, необязательное поле
	'KEYBOARD' => '' // Клавиатура, необязательное поле
	'URL_PREVIEW' => 'Y' // Преобразовывать ссылки в rich-ссылки, необязательное поле, по умолчанию 'Y'

), $_REQUEST["auth"]);
Результат выполнения: true или код ошибки.

Ограничения:
  • Вы можете отправить сообщение не более одного раза для каждого пользователя в течение недели.

    Примечание: На порталах с тарифом Партнер (NFR-лицензия) ограничений нет.

  • Вы можете использовать клавиатуру только для формирования кнопки-ссылки на внешний сайт.

Ссылки по теме:

Как работать с набираемыми клавиатурами
Как работать с вложениями
Форматирование сообщений

Возможные ошибки:

Код ошибкиОписание ошибки
CODE_ERROR Указан некорректный код открытой линии.
USER_ID_EMPTY Не передан идентификатор пользователя получателя.
MESSAGE_EMPTY Не передан текст сообщения.
ATTACH_ERROR Весь переданный объект вложения не прошел валидацию.
ATTACH_OVERSIZE Превышен максимально допустимый размер вложения (30 Кб).
KEYBOARD_ERROR Весь переданный объект клавиатуры не прошел валидацию.
KEYBOARD_OVERSIZE Превышен максимально допустимый размер клавиатуры (30 Кб).
USER_MESSAGE_LIMIT Превышен лимит отправки сообщения для конкретного пользователя.
WRONG_REQUEST Что-то пошло не так.


Переключение разговора на свободного оператора

Rest-метод: imopenlines.bot.session.operator

Вызов метода:
$result = restCommand('imopenlines.bot.session.operator', Array(

    'CHAT_ID' => 12 // Идентификатор чата

), $_REQUEST["auth"]);
Результат выполнения: true или код ошибки.

Возможные ошибки:

Код ошибкиОписание ошибки
CHAT_ID_EMPTY Не передан идентификатор чата.
WRONG_CHAT Указанный чат находится не под управлением бота.
BOT_ID_ERROR Неправильный идентификатор чат-бота.


Переключение разговора на конкретного оператора

Rest-метод: imopenlines.bot.session.transfer

Вызов метода:
$result = restCommand('imopenlines.bot.session.transfer', Array(

    'CHAT_ID' => 12 // Идентификатор чата
    'USER_ID' => 12 // Идентификатор пользователя, на которого осуществляется перенаправление
    'LEAVE' => 'N' // Y/N. Если указано N - чат-бот не покинет данный чат после переадресации и будет присутствовать до момента подтверждения пользователя	

), $_REQUEST["auth"]);

Примечание: Вместо USER_ID можно указать QUEUE_ID для переключения на другую открытую линию.

Результат выполнения: true или код ошибки.

Возможные ошибки:

Код ошибкиОписание ошибки
CHAT_ID_EMPTY Не передан идентификатор чата.
USER_ID_EMPTY Не передан идентификатор пользователя, на которого необходимо переадресовать разговор.
WRONG_CHAT Указан некорректный идентификатор пользователя или этот пользователь является чат-ботом или экстранет пользователем.
BOT_ID_ERROR Неправильный идентификатор чат-бота.


Завершение текущей сессии

Rest-метод: imopenlines.bot.session.finish

Вызов метода:
$result = restCommand('imopenlines.bot.session.finish', Array(

    'CHAT_ID' => 12 // Идентификатор чата	

), $_REQUEST["auth"]);
Результат выполнения: true или код ошибки.

Возможные ошибки:

Код ошибкиОписание ошибки
CHAT_ID_EMPTY Не передан идентификатор чата.
BOT_ID_ERROR Неправильный идентификатор чат-бота.


Примечание: На основе Rest API Открытых линий вы можете создать канал техподдержки своих клиентов.



1
Курсы разработаны в компании «1С-Битрикс»