Активность бота

Чат-бот может передавать серверу признаки своей активности, чтобы отображать их пользователям в клиентских приложениях TrueConf: например, индикатор «Печатает…» или «Записывает аудиосообщение». Тип передаваемой активности задается перечислением ChatActivity.

Запросы клиента

Отправить активность

Передает серверу признак псевдоактивности чат-бота в указанном чате.

Запрос:

{
    "method": "sendChatActivity",
    "type": 1,
    "id": 10,
    "payload": {
        "chatId": "8be515432414d2e1385abec747ed4fb10cdb12f2",
        "activityType": "typing"
    }
}

Параметр	Тип	Обяз.	Описание
type	uint32	Да	Тип сообщения (по умолчанию 1). Соответствует MESSAGE_TYPE.REQUEST
id	uint32	Да	Уникальный идентификатор запроса. Инкрементируемое значение, назначаемое отправляющей стороной, обязательное в каждом запросе для последующего связывания с ответом. Подробнее читайте тут
method	string	Да	Команда sendChatActivity
chatId	string	Да	Идентификатор чата, в котором будет отображаться активность бота
activityType	string	Да	Тип передаваемой активности. Возможные значения описаны в перечислении ChatActivity

Ответ:

{
    "type": 2,
    "id": 10,
    "payload": {
        "chatId": "8be515432414d2e1385abec747ed4fb10cdb12f2",
        "activityType": "typing",
        "retryAfter": 5
    }
}

Параметр	Тип	Обяз.	Описание
type	uint32	Да	Тип сообщения (по умолчанию 2). Соответствует MESSAGE_TYPE.RESPONSE
id	uint32	Да	Идентификатор, совпадающий с числом, отправленным в исходном запросе, используемый для связывания запроса и ответа
chatId	string	Да	Идентификатор чата, в который передана активность
activityType	string	Да	Тип переданной активности. Возможные значения описаны в перечислении ChatActivity
retryAfter	uint32	Да	Количество секунд, которое боту необходимо подождать перед отправкой следующей активности. Значение 0 означает, что ограничений нет

В случае возникновения ошибки возвращается сообщение, содержащее параметр errorCode. Список возможных значений доступен в соответствующем разделе документации.