Skip to content

Updating a SIP line

Method update.sip_lines
Description Updating a SIP line
Available to Partner, Client

Request parameters

Name Type Required Valid values Description
access_token string yes Authentication session key
id number yes Unique SIP line identifier
user_id number no Unique identifier of the customer's user on whose behalf the request is made. Required for the agent. To obtain a list of customer users, call "get.customer_users".
employee_id number yes Unique employee identifier; see method "get.employees"
virtual_phone_number string yes E.164 format, starting with 7 Virtual number displayed on outgoing calls. If the virtual number is not passed, the SIP line type will be "incoming only"; if it is passed, the line will be "incoming and outgoing".
billing_state enum no active / manual_lock SIP line billing status. active — SIP line is active; manual_lock — blocked manually.
channels_count number no Number of channels available on the SIP line. Limited by the tariff plan.

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 response structure

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

List of returned errors

See "Errors for update methods".