getAbook

TrueConf7/5/26About 2 min

getAbook

Description

Get the address book

void getAbook()

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
}

Response Parameters

Name	Description
isEditable	Ability to edit contact information
peerId	TrueConf ID, unique user identifier
peerDn	User display name
status	User status. It can have on 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 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 ce be joined at request
lastOnlineTime	Time in Unix format indicating when the user was last available. If the user is currently available, then this parameter is equal to 0
additionalStatus	Additional user status as a string
requestId	A unique request identifier
result	A flag indicating whether the request was successful

See also