Регистрация чат-бота

Вызов метода

$result = restCommand('imbot.register', Array(

    'CODE' => 'newbot', // Строковой идентификатор бота, уникальный в рамках вашего приложения (обяз.)
    'TYPE' => 'H', // Тип бота, B - чат-бот, ответы поступают сразу, H - человек, ответы поступают с задержкой от 2-х до 10 секунд, O - чат-бот для Открытых линий, S - чат-бот с повышенными привилегиями (supervisor)
    'EVENT_HANDLER' => 'http://www.hazz/chatApi/event.php', // Ссылка на обработчик событий, поступивших от сервера - см. Обработчики событий ниже (обяз).
    'OPENLINE' => 'Y', // Включение режима поддержки Открытых линий, можно не указывать, если TYPE = 'O'
    'CLIENT_ID' => '', // строковый идентификатор чат-бота, используется только в режиме Вебхуков
    'PROPERTIES' => Array( // Личные данные чат-бота (обяз.)
        'NAME' => 'NewBot', // Имя чат-бота (обязательное одно из полей NAME или LAST_NAME)
        'LAST_NAME' => '', // Фамилия чат-бота (обязательное одно из полей NAME или LAST_NAME)
        'COLOR' => 'GREEN', // Цвет чат-бота для мобильного приложения RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA, PINK, LIME, BROWN,  AZURE, KHAKI, SAND, MARENGO, GRAY, GRAPHITE
        'EMAIL' => 'test@test.ru', // E-mail для связи. НЕЛЬЗЯ использовать e-mail, дублирующий e-mail реальных пользователей
        'PERSONAL_BIRTHDAY' => '2016-03-11', // День рождения в формате YYYY-mm-dd
        'WORK_POSITION' => 'Мой первый бот', // Занимаемая должность, используется как описание чат-бота
        'PERSONAL_WWW' => 'http://test.ru', // Ссылка на сайт
        'PERSONAL_GENDER' => 'F', // Пол чат-бота, допустимые значения M -  мужской, F - женский, пусто, если не требуется указывать
        'PERSONAL_PHOTO' => '/* base64 image */', // Аватар чат-бота - base64
    )

), $_REQUEST["auth"]);

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

• CODE - строковой идентификатор бота, уникальный в рамках вашего приложения.
• PROPERTIES - массив с личными данными чат-бота.
• EVENT_HANDLER - ссылка на обработчик события отправки сообщения чат-боту.
или
• EVENT_MESSAGE_ADD - ссылка на обработчик события отправки сообщения чат-боту.
• EVENT_WELCOME_MESSAGE - ссылка на обработчик события открытия диалога с чат-ботом или приглашения его в групповой чат.
• EVENT_BOT_DELETE - ссылка на обработчик события удаления чат-бота со стороны клиента.

Результат выполнения

Числовой идентификатор созданного бота BOT_ID или ошибка.

Обработчики событий

Если вам требуется обрабатывать события с помощью разных обработчиков, то вместо EVENT_HANDLER вы можете задать каждый обработчик индивидуально:

'EVENT_MESSAGE_ADD' => 'http://www.hazz/chatApi/event.php', // Ссылка на обработчик события отправки сообщения чат-боту
'EVENT_WELCOME_MESSAGE' => 'http://www.hazz/chatApi/event.php', // Ссылка на обработчик события открытия диалога с чат-ботом или приглашения его в групповой чат
'EVENT_BOT_DELETE' => 'http://www.hazz/chatApi/event.php', // Ссылка на обработчик события удаления чат-бота со стороны клиента
'EVENT_MESSAGE_UPDATE' => 'http://www.hazz/chatApi/event.php', // Ссылка на обработчик события подписки на события изменения
'EVENT_MESSAGE_DELETE' => 'http://www.hazz/chatApi/event.php', // Ссылка на обработчик события подписки на события удаления сообщений

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

Rest API - События установки и обновления

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

Для создания чат-бота с повышенными привилегиями в метод imbot.register в поле TYPE укажите тип S.

Обратите внимание, если это не требуется логикой вашего приложения, то рекомендуется отвечать боту на сообщения пользователя только при упоминании этого чат-бота. Проверить это можно по полю TO_USER_ID, которое будет передано в событие.