Работа с контактами

Труконф04.07.2026Около 2 мин

Работа с контактами

Получить отображаемое имя пользователя по его TrueConf ID

При получении системных уведомлений (например, при добавлении пользователя в чат), в поле userId передаётся только технический идентификатор (TrueConf ID) — например, user@video.example.com.
Если боту необходимо отправить приветственное сообщение или отобразить пользователя в интерфейсе, желательно использовать отображаемое имя (например, "Иван Петров"), а не технический ID.

Запрос:

{
    "type": 1,
    "id": 1,
    "method": "getUserDisplayName",
    "payload": {
        "userId": "user@video.example.com"
    }
}
ПараметрТипОбяз.Описание
typeuint32ДаТип сообщения (по умолчанию 1). Соответствует MESSAGE_TYPE.REQUEST
iduint32ДаУникальный идентификатор запроса. Инкрементируемое значение, назначаемое отправляющей стороной, обязательное в каждом запросе для последующего связывания с ответом. Подробнее читайте тут
methodstringДаКоманда getUserDisplayName
userIdstringДаTrueConf ID пользователя, имя которого необходимо получить

Ответ:

{
    "type": 2,
    "id": 1,
    "payload": {
        "displayName": "John Doe"
    }
}
ПараметрТипОбяз.Описание
typeuint32ДаТип сообщения (по умолчанию 2). Соответствует MESSAGE_TYPE.RESPONSE
iduint32ДаИдентификатор, совпадающий с числом, отправленным в исходном запросе, используемый для связывания запроса и ответа
displayNamestringДаОтображаемое имя пользователя на сервере

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

Последнее обновление: