Get numbers on the account

Authorizations

appid

string

query

required

An API key to authorize your request

Query Parameters

city_id

integer<int32>

Filter numbers by city or rate center.

Example:

123

string

Filter numbers by digits in the phone number. You can provide a full number or part of it.

Example:

"256537"

label

string

Filter phone numbers by label. Only exact matches are returned.

Example:

"ALEX"

label_present

boolean

If true, returns only phone numbers with a label. If false, returns only phone numbers without a label. When this parameter is used, the label parameter is ignored.

Example:

true

page

integer<int32>

Requested page

Example:

2

per_page

integer<int32>

The number of records per page

Example:

50

Response

200 - application/json

items

DIDontheAccount · object[]

required

A list of phone numbers on the account

Show child attributes

items.id

integer<int32>

required

Unique identifier of the DID

Example:

123

items.number

string

required

The phone number

Example:

"12565378257"

items.activation_fee

string

required

The phone number activation fee, in USD

Example:

"0.99"

items.monthly_fee

string

required

Recurring phone number monthly fee, in USD

Example:

"0.99"

items.per_min

string

required

Price per inbound minute, in USD

Example:

"0.0059"

items.city

string

required

The name of a city or a rate center for the phone number

Example:

"DETROIT, MI"

items.country

string

required

The originating country of the phone number

Example:

"United States"

items.country_short_name

string

required

2-letter ISO code of the originating country of the phone number

Example:

"US"

items.destination

InboundCallDestination · object[]

required

Inbound call destinations configured for the phone number

Show child attributes

items.destination.id

integer<int32>

required

Unique identifier of the inbound call destination

Example:

1

items.destination.destination

string

required

The destination for inbound call routing. Can be either a SIP URI, a PSTN phone number or system-generated login of a SIP trunk on the platform.

Example:

"[did]@sipuri.com"

items.destination.priority

integer<int32>

required

For DIDs with several destinations, sets the order of the destination the platform routes inbound calls to. The lesser the value, the higher the priority is.

Example:

1

items.destination.transport

enum<integer>

required

Inbound call transport

Available options:

1,

4,

5

items.destination.trunk_id

integer<int32> | null

required

Unique identified of a SIP trunk on the platform. In cases when transport:5, otherwise, null

Example:

23123

items.destination.trunk_label

string | null

required

A user-defined name of a SIP trunk on the platform. In cases when transport:5, otherwise, null

Example:

"My trunk"

items.destination.srtp

boolean

Example:

false

items.channels

integer<int32>

required

Number of inbound channels on the phone number

Example:

24

items.require_docs

string[]

required

A list of document required to activate the phone number

Example:

["1"]

items.documents

DIDDocument · object[]

required

Documents uploaded for the phone number

Show child attributes

items.documents.id

integer<int32>

required

Unique identifier of the uploaded document

Example:

1

items.documents.allow_replace

boolean

required

Indicates if the document can be replaced. You can only replace documents with rejected status.

Example:

false

items.documents.did_number

string

required

The phone number the document was uploaded for

Example:

"12565378257"

items.documents.doc_content_type

string

required

The uploaded content type identified by the platform

Example:

"image/png"

items.documents.doc_file_name

string

required

The uploaded document name

Example:

"Copy of ID.png"

items.documents.doc_type_id

enum<integer>

required

Specifies the type of document required to activate the phone number. Possible values are: 1 - Proof of identity, 2 - Proof of address, 3 - Proof of business registration.

Available options:

1,

2,

3

items.documents.status

string

required

Status of the uploaded document. Can be either approved, pending, or rejected

items.documents.url

string

required

A link to the uploaded document

Example:

"https://api.wavix.com/v1/mydids/24882/papers/1\""

items.domestic_cli

boolean

required

Domestic cli

items.label

string | null

required

Label assigned to the phone number

items.status

string

required

Status of the phone number. Can be either active indicating the phone number is active can can receive inbound calls, or inactive

items.seconds

string

required

Duration of all inbound calls to the phone number in the current month, in seconds

items.added

string<date-time>

required

Date and time the phone number was added to the account

Example:

"2023-04-10T06:42:59.000Z"

items.paid_until

string<date>

required

The date when the next monthly phone number charge is due

Example:

"2023-12-07T00:00:00.000Z"

items.sms_enabled

boolean

required

Indicates if the phone number is SMS-enabled

Example:

false

items.sms_relay_url

string | null

required

A webhook URL to forward inbound messages to

Example:

"https://your-website.com/webhook"

items.cnam

boolean | null

required

Indicates if CNAM storage is activated for the phone number

Example:

true

items.call_recording_enabled

boolean

required

Indicates if call recording is activated for the phone number. For Flex Pro accounts only.

Example:

true

items.transcription_enabled

boolean

required

Indicates if automatic call transcription is activated on the phone number. For Flex Pro accounts only.

Example:

true

items.transcription_threshold

integer<int32>

required

The minimal inbound call duration to automatically generate transcription for, in seconds. For Flex Pro accounts only.

Example:

6

items.state

string

items.free_min

integer

Free minute

items.unlimited

boolean

items.call_status_url

string | null

Call status url

Example:

"https://example.com"

doc_types

DocumentType · object[]

required

A list document types required to activate a phone number

Show child attributes

doc_types.id

integer<int32>

required

Unique ID of the document type

Example:

2

doc_types.name

string

required

Name of the document type

Example:

"address"

doc_types.title

string

required

Human-readable description of the document type

Example:

"Proof of address"

pagination

Pagination · object

required

Show child attributes

pagination.current_page

integer<int32>

required

Current page number

Example:

2

pagination.per_page

integer<int32>

required

Number of records per page

Example:

25

pagination.total

integer<int32>

required

Total number of records

Example:

101

pagination.total_pages

integer<int32>

required

Total number of pages

Example:

5

Using the APIs

API reference

Get numbers on the account

Authorizations

Query Parameters

Response