# getGroups

Description

Get information about groups in the address book.

void getGroups()

Response example

{
    "groups" : [
        {
            "id" : 268435454,
            "name" : "Sales Group",
            "peers" : [
                {
                    "peerId" : "user2@some.server",
                    "peerDn" : "user2"
                }
            ]
        }
    ],
    "method" : "getGroups",
    "requestId" : "1",
    "result" : true
}

Response Parameters

Name Description
groups The list of groups in the address book
id Group identifier
name Group name
peers The list of users in a group
peerId TrueConf ID, unique user identifier
peerDn User display name
requestId A unique request identifier
result A flag indicating whether the request was successful

See also

Last Updated: 09/12/2025