Method get.available_virtual_numbers
Description Getting a list of virtual numbers available for connection
Available to Agent, Client

Request parameters

Name Type Required Description
access_token string yes Authentication session key
user_id number no Unique user identifier of the agent client on behalf of which the request is made
Is mandatory for the agent
To receive
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 "View of Returned Data"
sort array no See section "Sorting data"

Response parameters

Name Type Valid values Filtering Sorting Description
phone_number string yes yes Virtual number
category enum usual - usual; bronze - bronze; silver - silver; gold - golden. yes yes Room category
location_mnemonic enum yes yes Region mnemonic
location_name string

yes Region
onetime_payment number

Number connection cost
monthly_charge number

Monthly subscription fee
min_charge number

Minimum bill, per month

JSON request structure```json

{ "jsonrpc": "2.0", "id": "number", "method": "get.available_virtual_numbers", "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": [
      {
        "phone_number": "string",
        "category": "enum",
        "location_mnemonic": "enum",
        "location_name": "string",
        "onetime_payment": "number",
        "monthly_charge": "number",
        "min_charge":"number"
      }
    ]
  }
}

List of returned errors

See the section "List of errors for methods with the verb get"