Retrieves virtual numbers that can be assigned to phone_number_id when creating or updating an advertising campaign.

Retrieves virtual numbers that can be assigned to phone_number_id when creating or updating an advertising campaign

Method	get.campaign_available_phone_numbers
Description	Retrieves virtual numbers that can be assigned to phone_number_id when creating or updating an advertising campaign.
Who has access	Agents and clients

Request parameters

Name	Type	Required	Description
access_token	string	yes	Session key used to authenticate the request
user_id	number	no	Unique ID of the client user on whose behalf the request is made. Required when an agent makes the request. To retrieve a list of client users, call "get.customer_users".
limit	number	no	Maximum number of records to return. See the "Paging" section.
offset	number	no	Number of records to skip before returning results. Default: 0. See the "Paging" section.
filter	object	no	Filtering criteria. See the "Filters" section.
fields	array	no	Fields to include in the response. See the "Viewing returned data" section.
sort	array	no	Sorting criteria. See the "Data sorting" section.

Response parameters

Name	Type	Valid values	Filtering	Sorting	Description
id	number		yes		Unique virtual number ID. Use this value as phone_number_id in create.campaigns or update.campaigns.
prefix	string		yes	yes	Phone number prefix
phone_number	string		yes		Virtual phone number
type	enum	va call_tracking user	yes		Virtual number type: va for a Virtual PBX number, call_tracking for a call tracking number, or user for a user-provided number

Example request

{
    "jsonrpc": "2.0",
    "id": "number",
    "method": "get.campaign_available_phone_numbers",
    "params": {
        "access_token": "string",
        "user_id": "number",
        "offset": "number",
        "limit": "number",
        "filter": {},
        "sort": [
            {
                "field": "string",
                "order": "string"
            }
        ],
        "fields": [
            "string"
        ]
    }
}

Example response

{
    "jsonrpc": "2.0",
    "id": "number",
    "result": {
        "metadata": {},
        "data": [
            {
                "id": "number",
                "prefix": "string",
                "phone_number": "string",
                "type": "enum"
            }
        ]
    }
}

List of returned errors

See the "List of errors for get methods" section.