Skip to content

Get sip line virtual numbers

Getting a list of virtual numbers for a SIP-line

Method get.sip_line_virtual_numbers
Description Getting a list of virtual numbers that can be used when setting a SIP-line
Who has access Partner, Customer

Parameters of a request

Title Type Required 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"
limit number no Returning entries count. Refer to "Paging"
offset number no Offset that defines from which number to return the entries "limit". Default value is "0". Refer to "Paging"
filter object no Refer to "Filters"
fields array no Refer to "Viewing returning data"
sort array no Refer to "Data sorting"

Parameters of a reply

Title Type Valid values Filtering Sorting Description
virtual_phone_number string yes Virtual number

JSON request structure

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.sip_line_virtual_numbers",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "offset":"number",
    "limit":"number",
    "filter":{

    },
    "sort":[
      {
        "field":"string",
        "order":"string"
      }
    ],
    "fields":[
      "string"
    ]
  }
}

JSON reply structure

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

    },
    "data": [
      {
        "virtual_phone_number": "string"
      }
    ]
  }
}

List of returning errors

Refer to the section "List of errors for the methods with the verb get"