Update group employees numbers
Updating and priority and availability of an employee's phone number in an employees group
Method |
update.group_employees_numbers |
Description |
Updating and priority and availability of an employee's phone number in an employees group |
Who has access |
Agent, Customer |
If a number is not in a numbers list, any information attributed to it van not be updated.
Parameters of a request
Title |
Type |
Required |
Description |
access_token |
string |
yes |
Authentication session key |
id |
number |
yes |
Group ID |
user_id |
number |
yes |
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" |
List of phone numbers in 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" ).
You need to transmit all the numbers
|
employee_phone_number_id |
number |
yes |
Unique ID of a phone number of an employee from a group |
available |
boolean |
yes |
Availability of a number in a group |
JSON request structure
{
"jsonrpc":"2.0",
"id":"number",
"method":"update.group_employees_numbers",
"params":{
"access_token":"string",
"id":"number",
"user_id":"number",
"phone_numbers":[
{
"employee_phone_number_id":"number",
"available":"boolean"
}
]
}
}
JSON reply structure
{
"jsonrpc":"2.0",
"id":"number",
"result":{
}
}
List of returning errors
Text of error |
Mnemonics |
Code |
Description |
Invalid parameter value |
invalid_parameter_value |
-32602 |
Not all the numbers are transferred in the data bulk phone_numbers |
Refer to "List of errors for methods with the verb update"