Skip to content

Getting the list of virtual numbers that can be used when setting up a SIP line

Getting the list of virtual numbers that can be used when setting up a SIP line

Method get.sip_line_virtual_numbers
Description Getting the list of virtual numbers that can be used when setting up a SIP line
Available to Partner, Client

Request parameters

Name Type Required 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".
limit number no Number of records returned. See section "Paging"
offset number no Offset defining the record number from which to return "limit" records. Default is "0". See section "Paging"
filter object no See section "Filtering criteria"
fields array no See section "Viewing returned data"
sort array no See section "Sorting data"

Response parameters

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

{
    "jsonrpc": "2.0",
    "id": "number",
    "result": {
        "metadata": {},
        "data": [
            { "virtual_phone_number": "string" }
        ]
    }
}

List of returned errors

See "Errors for get methods".