Get group employees

Getting a list of employees groups

Method	get.group_employees
Description	Getting a list of employees groups
Who has access	Agent, Customer

Parameters of a request

Title	Type	Required	Description
access_token	string	yes	Authentication session key
user_id	number	no	Unique user ID of a customer or an agent who makes request. Is mandatory for an agent To get a list of customer users use the method "get.customer_users"
limit	number	no	Number of returning inquiries. Refer to "Paging"
offset	number	no	Offset that defines inquiries from which number to return, "limit" of inquiries. Default value is "0". Refer to "Paging"
filter	object	no	Refer to "Filtering criteria"
fields	array	no	Refer to "Viewing returning data"
sort	array	no	Refer to "Data sorting"

Parameters of a reply

Title	Type	Valid value	Filtering	Sorting	Description
id	number		yes		Group ID
name	string		yes	yes	Group name
List of employees in a group
members	array				List of unique IDs of employees, that belong to a group
employee_id	number				Employee unique ID
employee_full_name	string				Employee full name
List of phone numbers of employees that belong to a group and their availability
phone_numbers	array		yes		List of landline, mobile and sip numbers of employees, that belong to a group, with an indication of their availability and order of dialing priority. Order of dialing priority is defined by a number's position in a list. Dialing a group's phone number list can be made using the group's extension number (refer to the parameter "group_phone_number"). To change the priority and availability of a number refer to the method "update.group_employees_numbers"
employee_phone_number	string				Employee phone number
employee_phone_number_id	number				Employee phone number ID/td>
employee_full_name	string				Employee full name
employee_id	number				Employee ID
available	boolean				Availability of a number in a group
Group extension number settings
group_phone_number	string	Maximum length is 5	yes	yes	Group extension number
queue_enabled	boolean		yes		Default value is "false". In case all the numbers, attributed to a group, are busy, a caller can get in line for a redial to phone numbers in a list. Than, he or she will wait for the first number to become available. Depends on the component "va"
channels_count	number	From 1 to 199	yes		Number of simultaneous channels when dialing

JSON request structure

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.group_employees",
  "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",
        "members":[
          {
            "employee_id":"number",
            "employee_full_name":"string"
          }
        ],
        "phone_number":[
          {
            "employee_phone_number":"string",
            "employee_phone_number_id":"number",
            "employee_full_name":"string",
            "employee_id":"number",
            "available":"boolean"
          }
        ],
        "group_phone_number":"string",
        "queue_enabled":"boolean",
        "channels_count":"number"
      }
    ]
  }
}

List of returning errors

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