Skip to content

Updates dialing priority and availability for employee phone numbers in a group.

Method update.group_employees_numbers
API version
Description Updates dialing priority and availability for employee phone numbers in a group.

Available to: Agents and clients

The request must include every phone number in the group. The order of entries determines dialing priority.

Request parameters

Name Type Required Description
access_token string yes Access token used to authenticate the request.
id number yes Unique ID of the employee group to update.
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.
Employee phone numbers and availability
phone_numbers array yes All landline, mobile, and SIP numbers assigned to employees in the group, including availability. Array order determines dialing priority. Calls can be routed to the list through group_phone_number. Include every phone number in the group.
employee_phone_number_id number yes Unique ID of the employee phone number within the group.
available boolean yes Whether the phone number is available in the group.

Example request

{
  "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"
      }
    ]
  }
}

Example response

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

Possible errors

Error text Mnemonic Code Description
Invalid parameter value invalid_parameter_value -32602 Returned when phone_numbers does not include every phone number in the group.

See the "Errors for update methods" section.