# getGroups

Description: get information about groups in the address book.

Request example:

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

Response example:

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

Parameter description:

  • groups — the list of groups in the address book

  • id — Group identifier

  • name — Group name

  • peers — the list of users in a group

  • peerIdTrueConf ID, unique user identifier

  • peerDn — User display name

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

See also: