TrueConf

# 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 contain an additional parameter callId.

Response example:

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

Parameter description:

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

    • PeerId - supported. Within the application, it automatically converts to CallId and is then added based on it.

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

    • InstanceId - supported. Inside the application, it is automatically converted to CallId and then added based on it.

  • 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 learn more about it here.

  • callId - unique user identifier after conversion

See also: