getAbook

Description: get the address book.

Request example:

{
    "method" : "getAbook",
    "requestId" : "1"
}

Response example:

{
    "abook" : [
        {
            "isEditable" : true,
            "peerId" : "#sip:@192.168.62.49",
            "peerDn" : "💻 @192.168.62.49",
            "status" : 1,
            "extStatus": 2,
            "lastOnlineTime": 0,
            "additionalStatus": "at lunch"
        },
        {
            "isEditable" : false,
            "peerId" : "user2@some.server",
            "peerDn" : "user2",
            "status" : 0,
            "extStatus": 0,
            "lastOnlineTime": 1690962961,
            "additionalStatus": "at lunch"
        },
        {
            "isEditable" : true,
            "peerId" : "user3@some.server",
            "peerDn" : "user3",
            "status" : 0,
            "extStatus": 1,
            "lastOnlineTime": 1690534039,
            "additionalStatus": ""
        },
        {
            "isEditable" : true,
            "peerId" : "user4@some.server",
            "peerDn" : "user4",
            "status" : 0,
            "extStatus": 0,
            "lastOnlineTime": 1689606420,
            "additionalStatus": ""
        }
    ],
    "method" : "getAbook",
    "requestId" : "1",
    "result" : true
}

Parameter description:

isEditable — ability to edit contact information
peerId - unique user identifier (TrueConf ID)
peerDn — User display name
status — User status. It can have one of the following values:
- -1 — Invalid user
- 0 — Offline user
- 1 — Available user
- 2 — Busy user
- 5 — the user is now taking part in a group conference
extStatus - the extended user status, which can take one of the following values:
- -1 — Invalid user
- 0 — Offline user
- 1 - user is offline but was recently active
- 2 — Available user
- 3 - user is available on the phone
- 4 - user is available from the terminal
- 5 - user is available but has set the status to do not disturb
- 6 - user is away
- 7 — Busy user
- 8 - user is busy on the phone
- 9 - user is busy at the terminal
- 10 — A user is in a group conference that they created and that can be joined at request.
lastOnlineTime - the time in Unix format when the user was last online. If the user is currently online, this parameter is set to 0.
additionalStatus - additional user status as a string
requestId - a unique request identifier. You can find more details about it here.

See also: