Getting a list of employee groups
| Method | get.group_employees |
|---|---|
| Description | Getting a list of employee groups |
| Available to | Agent, Client |
Request parameters
| Title | Type | Required | Description |
|---|---|---|---|
access_token |
string | yes | Authentication session key |
user_id |
number | no | Unique user identifier of the client agent on behalf of which the request is made Is required for the agentTo obtain a list of client users, you must use the method "get.customer_users" |
limit |
number | no | Number of records returned. See section "Paging" |
offset |
number | no | Shift determines from which record number to return "limit" records. Default is "0". See section "Paging" |
filter |
object | no | See section "Filtering criteria" |
fields |
array | no | See section "View of returned data" |
sort |
array | no | See section "Sorting data" |
Response parameters
| Name | Type | Valid values | Filtering | Sorting | Description |
|---|---|---|---|---|---|
id |
number | yes | Unique group identifier | ||
name |
string | yes | yes | Group name | |
| List of employees in the group | |||||
members |
array | List of unique employee identifiers, who are in the group | |||
employee_id |
number | Unique employee identifier | |||
employee_full_name |
string | F.I.O. employee | |||
| List of employee numbers in the group and their availability | |||||
phone_numbers |
array | yes |
List of landline, mobile and sip numbers
employees who are part of the group, indicating
their availability and call priority. Priority
dialing numbers is determined by the position of the number in
list. Calling a specified list of numbers in a group
possible by internal group number (see.
parameter "group_phone_number"). To change
priority and number availability in the group, see method
"update.group_employees_numbers"
|
||
employee_phone_number |
string | Employee phone number | |||
employee_phone_number_id |
number | Unique identifier of the employee number in group | |||
employee_full_name |
string | F.I.O. employee | |||
employee_id |
number | Unique employee identifier | |||
available |
boolean | Number availability in group | |||
| Setting the internal group number | |||||
group_phone_number |
string | Maximum length 5 | yes | yes | Internal group number |
queue_enabled |
boolean | yes |
The default value is "false". In case everything
numbers specified for this group of employees,
are busy, the caller will queue for
redial to the phones in the list and will
wait for the first available number.
|
||
channels_count |
number | From 1 to 199 | yes | Number of simultaneous lines when calling | |
JSON request structure```json
{ "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 response structure```json
{
"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 returned errors
See the section "List of errors for methods with the verb get"