Getting a list of virtual number groups

Method	get.virtual_number_groups
Description	Getting a list of virtual number 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 ID of an agent's customer user who makes request Is required for agent To access a list of customer users, use the method "get.customer_users"
limit	number	no	Returning entries count. Refer to "Paging"
offset	number	no	Offset that defines from which number to return the entries "limit". Default value is "0". Refer to "Paging"
filter	object	no	Refer to "Filters"
fields	array	no	Refer to "Viewing returning data"
sort	array	no	Refer to "Data sorting"

Parameters of a reply

Title	Type	Valid values	Filtering	Sorting	Description
id	number		yes	yes	Virtual number group unique ID
name	string		yes	yes	Virtual number group name
number	string		yes	yes	Virtual number group unique identifier (number): g1,g2,g3,...
Employees
employees	array
id	number				Employee ID See method get.employees
full_name	string				Employee full name
Employee groups
employee_groups	array
id	number				Group ID See method get.group_employees
name	string				Group name
Virtual phones
virtual_phones	array
id	number				Virtual phone ID. See method get.virtual_numbers
number	string				Virtual phone number

JSON request structure

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.virtual_number_groups",
  "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",
        "number": "string",
        "employees": [
          {
            "id": "number",
            "full_name": "string"
          }
        ],
        "virtual_phones": [
          {
            "id": "number",
            "number": "string"
          }
        ],
        "employee_groups": [
          {
            "id": "number",
            "name": "string"
          }
        ]
      }
    ]
  }
}

List of returning errors

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