Creates an employee group.

Method	create.group_employees
API version	—
Description	Creates an employee group.

Available to: Agents and clients

Request parameters

Name	Type	Required	Valid values	Description
access_token	string	yes		Access token used to authenticate the request.
user_id	number	no		Unique ID of the client user on whose behalf the agent is making the request. Required for agents. To retrieve a list of client users, use get.customer_users.
name	string	yes		Employee group name.
Employees in the group
members	array	no		IDs of the employees who belong to the group.
Group extension settings
group_phone_number	string	no	Maximum length: 5 characters	Group extension number. Requires the va component.
queue_enabled	boolean	no		When true, callers wait in a queue until a group phone number becomes available. Requires the va component. Default: false.
channels_count	number	no	1 to 199	Maximum number of simultaneous calls to the group. Requires the va component. Default: 1.

Response parameters

Name	Type	Required	Description
id	number	yes	Unique employee group ID.

Example request

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"create.group_employees",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "name":"string",
    "members":[
      "employee_id"
    ],
    "group_phone_number":"string",
    "queue_enabled":"boolean",
    "channels_count":"number"
  }
}

Example response

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

Possible errors

See the "Errors for create methods" section.