Creating a SIP line

Method	create.sip_lines
Description	Creating a SIP line
Available to	Partner, Client

Request parameters

Name	Type	Required	Valid values	Description
access_token	string	yes		Authentication session key
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".

Response parameters

Name	Type	Description
phone_number	string	SIP line phone number
password	string	Password for registration
server	string	FQDN and server port for registration
id	number	Unique SIP line identifier

JSON request structure

{
    "jsonrpc": "2.0",
    "id": "number",
    "method": "create.sip_lines",
    "params": {
        "access_token": "string",
        "user_id": "number",
        "employee_id": "number",
        "virtual_phone_number": "string"
    }
}

JSON response structure

{
    "jsonrpc": "2.0",
    "id": "number",
    "result": {
        "phone_number": "string",
        "password": "string",
        "server": "string",
        "id": "number"
    }
}

List of returned errors

See "Errors for create methods".