Getting a list of SIP lines
| Method | get.sip_lines |
|---|---|
| Description | Getting a list of SIP lines |
| Available to | Partner, Client |
Request parameters
| Title | Type | Required | Description |
|---|---|---|---|
access_token |
string | yes | Authentication session key |
user_id |
number | no | Unique user identifier of the client agent on behalf of which the request is made Is required for the agentTo obtain a list of client users, you must use the method "get.customer_users" |
limit |
number | no | Number of records returned. See section "Paging" |
offset |
number | no | Shift determines from which record number to return "limit" records. Default is "0". See section "Paging" |
filter |
object | no | See section "Filtering criteria" |
fields |
array | no | See section "View of returned data" |
sort |
array | no | See section "Sorting data" |
Response parameters
| Title | Type | Valid values | Filtering | Sorting | Description |
|---|---|---|---|---|---|
id |
number | yes | Unique SIP line identifier | ||
phone_number |
string | yes | SIP line phone number | ||
type |
enum |
|
yes | yes | Type of incoming communication available for the SIP line.
|
channels_count |
number | Number of available lines on the SIP line | |||
dial_time |
number | 1 to 100 | Default value is "60". Time to call the number in the employee's profile. Value in seconds. | ||
billing_state |
enum |
|
yes | yes | SIP line status in billing.
|
physical_state |
enum |
|
yes | yes | Physical state of the SIP line. |
virtual_phone_number |
string | E164 | yes | yes | Virtual number displayed during outgoing calls If the SIP line type is "in", then this field will be empty |
status |
enum |
|
yes | yes | Sip number status in employee profile, see methods "get.employees" |
employee_id |
number | yes | yes | Unique employee identifier, see methods "get.employees" | |
employee_full_name |
string | yes | Last name First name Middle name of the employee, see methods "get.employees" | ||
IP addressesip_addresses |
array | yes | IP addresses of registered terminals. Relevant for SIP lines that have the parameter value "physical_state" = "Registered" |
||
date_time |
iso8601 | YYYY-MM-DD hh:mm:ss | Registration date and time | ||
ip |
string | IP address |
JSON request structure```json
{ "jsonrpc":"2.0", "id":"number", "method":"get.sip_lines", "params":{ "access_token":"string", "user_id":"number", "offset":"number", "limit":"number", "filter":{
},
"sort":[
{
"field":"string",
"order":"string"
}
],
"fields":[
"string"
]
} }
### JSON response structure```json
{
"jsonrpc": "2.0",
"id": "number",
"result": {
"metadata": {
},
"data": [
{
"id": "number",
"phone_number": "string",
"type": "enum",
"employee_id": "number",
"employee_full_name": "string",
"channels_count": "number",
"dial_time": "number",
"billing_state": "enum",
"physical_state": "enum",
"status": "enum",
"virtual_phone_number": "string",
"ip_addresses": [
{
"date_time": "iso8601",
"ip": "string"
}
]
}
]
}
}
List of returned errors
See the section "List of errors for methods with the verb get"