Contacts Management

Retrieve the display name of a user by their TrueConf ID

When receiving system notifications (for example, when a user is added to a chat), only the technical identifier (TrueConf ID) is transmitted in the userId field — for instance, user@video.example.com. If the bot needs to send a welcome message or display the user in the interface, it is preferable to use the display name (e.g., "John Doe") rather than the technical ID.

Request:

{
    "type": 1,
    "id": 1,
    "method": "getUserDisplayName",
    "payload": {
        "userId": "user@video.example.com"
    }
}

Parameter	Type	Req.	Description
type	uint32	Yes	Type of message (default is 1). Corresponds to MESSAGE_TYPE.REQUEST
id	uint32	Yes	Unique request identifier. An incrementing value assigned by the sending party, required in each request for subsequent linkage with the response. Read more here
method	string	Yes	Command getUserDisplayName
userId	string	Yes	User's TrueConf ID for which the name is to be retrieved

Response:

{
    "type": 2,
    "id": 1,
    "payload": {
        "displayName": "John Doe"
    }
}

Parameter	Type	Req.	Description
type	uint32	Yes	Message type (default is 2). Corresponds to MESSAGE_TYPE.RESPONSE
id	uint32	Yes	Identifier matching the number sent in the original request, used to link the request and response
displayName	string	Yes	User's display name on the server

In the event of an error, a message containing the errorCode parameter is returned. A list of possible values is available in the relevant section of the documentation.