addToAbook

TrueConfAbout 1 min

addToAbook

Description: Add a user to the address book.

Request example:

{
    "method" : "addToAbook",
    "requestId" : "1",
    "peerId" : "user@some.server",
    "peerDn" : "User 1"
}

Response example:

{
    "method" : "addToAbook",
    "requestId" : "1",
    "result" : true
}

If peerId is changed (converted as shown below), the response will include an additional parameter callId.

Response example:

{
    "method" : "addToAbook",
    "requestId" : "1",
    "callId" : "user10@some.server",
    "result" : true
}

Parameter description:

  • peerId - a unique identifier of the user (TrueConf ID) that needs to be added to the address book. Applicability:

    • PeerId is supported. Within the application, it is automatically converted to CallId and added accordingly.

    • CallId - supported. The specified identifier will be added to the address book.

    • InstanceId is supported. Within the application, it is automatically converted to CallId and added accordingly.

  • peerDn — a user display name. This field is optional. If it is absent, a display name will be added automatically based on the server data.

  • requestId - a unique request identifier. You can find more details about it here.

  • callId - unique identifier of the user after conversion

See also: