109  /  122

imopenlines.network.message.add

Просмотров: 150
Дата последнего изменения: 12.08.2020

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

Ревизия: 1
Получить информацию о текущей ревизии API (версии платформы Открытых линий) – imopenlines.revision.get.

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

Параметры

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


Вызов метода и ответ

PHP

$result = restCommand('imopenlines.network.message.add', Array(

	'CODE' => 'ab515f5d85a8b844d484f6ea75a2e494',
	'USER_ID' => 2,
	'MESSAGE' => 'message text',
	'ATTACH' => '',
	'KEYBOARD' => '',
	'URL_PREVIEW' => 'Y'

), $_REQUEST["auth"]);

Пример ответа

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

Ограничения

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

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

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

Пример ответа при возникновении ошибки

{
    "error": "CODE_ERROR",
    "error_description": "Указан некорректный код открытой линии"
}

Описание ключей:

  • error – код возникшей ошибки
  • error_description – краткое описание возникшей ошибки

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

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


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



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