Skip to content

Update sip lines

Updating a SIP-line

Method update.sip_lines
Description Updating a SIP-line
Who has access Partner, Customer

Parameters of a request

Title Type Required Valid value Description
access_token string yes Authentication session key
id number yes SIP-line unique ID
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"
employee_id number yes Employee unique ID, refer to the method "get.employees"
virtual_phone_number string yes E164 format. Begins with 7 Virtual number displayed during an outgoing call.
If a virtual number is not transferred, a SIP-line will only have the type "incoming communication", if it is transferred, the type will be "incoming and outgoing"
billing_state enum no
  • active
  • manual_lock
 SIP-line status in billing.
  • active - SIP-line is active;
  • manual_lock - SIP-line is manually blocked.
channels_count number no The number of available lines on a SIP-line
Defined by service plan limits.

JSON request structure

{
  "jsonrpc": "2.0",
  "id": "number",
  "method": "update.sip_lines",
  "params": {
    "access_token": "string",
    "user_id": "number",
    "id": "number",
    "employee_id": "number",
    "virtual_phone_number": "string",
    "billing_state": "enum",
    "channels_count": "number"
  }
}

JSON reply structure

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

  }
}

List of returning errors

Refer to "List of errors for the methods with the verb update"