Get group contacts

Getting contact groups list in address book

Method	get.group_contacts
Description	Getting contact groups list in address book
Who has access	Agent, Customer

Parameters of request

Title	Type	Required	Description
access_token	string	yes	Authentication session key
user_id	number	no	Authentication session key
user_id	number	no	Unique user ID of a customer or an agent who makes request. Is mandatory for the agent To access a list of customer users you need to use the method "get.customer_users"
limit	number	no	Number of returned records. Refer to "Paging"
offset	number	no	Offset that defines from which phone number to return "limit" of recordings. Default value is "0". Refer to "Paging"
filter	object	no	Refer to "Filtering criteria"
fields	array	no	Refer to "View returning errors"
sort	array	no	Refer to "Sorting"

Parameters of reply

Title	Type	Valid value	Filtering	Sorting	Description
id	number		yes		Unique ID of a contact group in address book
name	string		yes	yes	Contact group name
is_system	boolean		yes		It's a system group that cannot be deleted
List of contacts that belong to a group
members	array		yes		List of unique cintact IDs that belong to a group.
contact_id	number				Unique contact ID refer to "get.contacts"
contact_full_name	string				Contact full name

JSON request structure

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.group_contacts",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "offset":"number",
    "limit":"number",
    "filter":{

    },
    "sort":[
      {
        "field":"string",
        "order":"string"
      }
    ],
    "fields":[
      "string"
    ]
  }
}

JSON reply structure

{
  "jsonrpc":"2.0",
  "id":"number",
  "result":{
    "metadata":{

    },
    "data":[
      {
        "id":"number",
        "name":"string",
        "is_system":"boolean",
        "members":[
          {
            "contacts_id":"number",
            "contact_full_name":"string"
          }
        ]
      }
    ]
  }
}

List of returning errors

Refer to "List of errors for methods with the verb get"