Skip to content

Create sip lines

Creating SIP-lines

Method create.sip_lines
Description Creating SIP-lines
Who has access Partner, Customer

Parameters of a request

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

Parameters of a reply

Name Type Description
phone_number string Phone number of a SIP-line
password string Password for registration
server string FQDN and a server port for registration
id number SIP-line unique ID

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

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

List of returning errors

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