Contacts Management

Retrieving the display name of a user by their TrueConf 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

Answer:

{
    "type": 2,
    "id": 1,
    "payload": {
        "displayName": "Abe Chester"
    }
}

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 case 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.