# Работа с контактами
# Получение отображаемого имени пользователя по его TrueConf ID
Запрос:
{
"type": 1,
"id": 1,
"method": "getUserDisplayName",
"payload": {
"userId": "user@video.example.com"
}
}
Параметр | Тип | Обяз. | Описание |
---|---|---|---|
type | uint32 | Да | Тип сообщения (по умолчанию 1 ). Соответствует MESSAGE_TYPE.REQUEST |
id | uint32 | Да | Уникальный идентификатор запроса. Инкрементируемое значение, назначаемое отправляющей стороной, обязательное в каждом запросе для последующего связывания с ответом. Подробнее читайте тут |
method | string | Да | Команда getUserDisplayName |
userId | string | Да | TrueConf ID пользователя, имя которого необходимо получить |
Ответ:
{
"type": 2,
"id": 1,
"payload": {
"displayName": "Abe Chester"
}
}
Параметр | Тип | Обяз. | Описание |
---|---|---|---|
type | uint32 | Да | Тип сообщения (по умолчанию 2 ). Соответствует MESSAGE_TYPE.RESPONSE |
id | uint32 | Да | Идентификатор, совпадающий с числом, отправленным в исходном запросе, используемый для связывания запроса и ответа |
displayName | string | Да | Отображаемое имя пользователя на сервере |
В случае возникновения ошибки возвращается сообщение, содержащее параметр errorCode
. Список возможных значений доступен в соответствующем разделе документации.