Документация для разработчиков
Темная тема

imconnector.send.messages

Scope: imconnector Права на выполнение: для всех

Описание

Метод отправки сообщений в ОЛ.

Параметры

Параметр Описание С версии
CONNECTOR ID коннектора (который был указан при регистрации обработчика).
LINE ID открытой линии.
MESSAGES Массив сообщений, где сообщения описываются массивом следующего формата:
array(
	array(
		//Массив описания пользователя
		'user' => array(
			'id',//ID пользователя во внешней системе *
			'last_name',//Фамилия
			'name',//Имя
			'picture' =>
				array(
					'url'//Ссылка на аватарку пользователя, доступную для портала
				),
				'url',//Ссылка на профиль пользователя
				'sex',//Пол. Допустимо male и female
				'email', //email
				'phone', //телефон
				'skip_phone_validate' => 'Y', //В значении 'Y' позволяет не применять валидацию 
											  //номера телефона пользователя. По умолчанию 'N'.
		),
		//Массив описания сообщения
		'message' => array(
			'id', //ID сообщения во внешней системе.*
			'date', //Время сообщения в формате timestamp *
			'disable_crm' => 'Y' ,//отключить чат трекер (CRM трекер)
			'text', //Текст сообщения. Должен быть указан элемент text или files. 
					//Допустимое форматирование (BB коды) описаны 
					//здесь: https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=7679
			'files' => array(//Массив описаний файлов, где каждый файл описывается 
							//массивом, со ссылкой, которая доступна порталу
				array('url' => 'Cсылка на файл'),
				array('url' => 'Cсылка на файл'),
				 ...
			)
		),
		//Массив описания чата
		'chat' => array(
			'id',//ID чата во внешней системе *
			'name', //Имя чата во внешней системе
			'url', //Ссылка на чат во внешней системе
		),
	),
	array(...),
);

Формат передаваемого файла не имеет ограничений. В чате вложение в сообщение может форматироваться как картинка для типов: jpe, jpg, jpeg, png, webp, gif, bmp.

Сообщения можно отправлять от имени менеджера, указав user_id в массиве message.

Параметр skip_phone_validate из структуры пользователя рекомендуется применять в только исключительных случаях. Параметр - вынужденная мера для преодоления ограничений валидатора номеров телефонов.

Ошибки при вызове метода и их причины

КодВыводимый текст ошибкиПояснение
WRONG_AUTH_TYPE Current authorization type is denied for this methodНекорректный тип авторизации. Необходим тип oauth
CONNECTOR Argument 'CONNECTOR' is null or emptyНе указан обязательный параметр в запросе 'CONNECTOR'
LINE Argument 'LINE' is null or emptyНе указан обязательный параметр в запросе 'LINE'
MESSAGES Argument 'MESSAGES' is null or emptyНе указан обязательный параметр в запросе 'MESSAGES'
The value of an argument 'MESSAGES' must be of type arrayЗначение параметра не является массивом.
IMCONNECTOR_NO_CORRECT_PROVIDER Не удалось найти подходящий провайдер для коннектораНекорректное значение в параметре 'CONNECTOR'
IMCONNECTOR_COULD_NOT_GET_PROVIDER_OBJECT Не удалось получить объект провайдераНекорректное значение в параметре 'CONNECTOR'
IMCONNECTOR_NOT_SPECIFIED_CORRECT_COMMAND Не указана корректная командаЧто-то невероятное. Это где-то ошибся разработчик.
IMCONNECTOR_NOT_SPECIFIED_CORRECT_CONNECTOR Не указан коннекторНекорректное значение в параметре 'CONNECTOR'
NOT_ACTIVE_LINE Линия c таким ID неактивна или не существуетЛиния на портале удалена или отключена
PROVIDER_UNSUPPORTED_TYPE_INCOMING_MESSAGE Неподдерживаемый тип входящего сообщения от сервераНекорректное значение в параметре 'type_message', если он передан
IMCONNECTOR_NOT_ALL_THE_REQUIRED_DATA Переданы не все необходимые данныеПустое или не корректное значение в параметре 'user'
CONNECTOR_PROXY_NO_ADD_USER Не удалось создать или получить пользователя системы, сопоставленного с пользователем удаленного мессенджераДля работы чата открытых линий необходимо на портал добавить специального технического пользователя с признаком, что это пользователь для мессенджер-коннектора, и под которым невозможно авторизоваться
CONNECTOR_PROXY_NO_USER_IM Не получен id пользователя мессенджераНекорректное значение поля 'id' в параметре 'user'. Это следствие предыдущей ошибки
IMCONNECTOR_NOT_ALL_THE_REQUIRED_DATA Переданы не все необходимые данныеНекорректное значение поля 'text' или 'files' в параметре 'message'. Не переданы какие-либо данные для отправки сообщения
100 The MESSAGES parameter must be an array of messages (arrays)Значение параметра 'MESSAGES' должно быть массивом сообщений.
The incorrect structure of a message inside MESSAGES parameter.Некорректная структура сообщений.


© «Битрикс», 2001-2024, «1С-Битрикс», 2024