Skip to main content
GET
/
mydids
Get numbers on the account
curl --request GET \
  --url https://api.wavix.com/v1/mydids
{
  "items": [
    {
      "id": 123,
      "number": "12565378257",
      "activation_fee": "0.99",
      "monthly_fee": "0.99",
      "per_min": "0.0059",
      "city": "DETROIT, MI",
      "state": "<string>",
      "country": "United States",
      "country_short_name": "US",
      "destination": [
        {
          "id": 1,
          "destination": "[did]@sipuri.com",
          "priority": 1,
          "transport": 1,
          "trunk_id": 23123,
          "srtp": false,
          "trunk_label": "My trunk"
        }
      ],
      "channels": 24,
      "require_docs": [
        "1"
      ],
      "documents": [
        {
          "id": 423,
          "allow_replace": false,
          "did_number": "12565378257",
          "doc_content_type": "image/png",
          "doc_file_name": "Copy of ID.png",
          "doc_type_id": 1,
          "status": "approved",
          "url": "https://api.wavix.com/v1/mydids/24882/papers/1"
        }
      ],
      "domestic_cli": true,
      "free_min": 123,
      "unlimited": true,
      "label": "<string>",
      "status": "<string>",
      "seconds": "<string>",
      "added": "2023-04-10T06:42:59.000Z",
      "paid_until": "2023-12-07T00:00:00.000Z",
      "sms_enabled": false,
      "sms_relay_url": "https://your-website.com/webhook",
      "cnam": true,
      "call_recording_enabled": true,
      "transcription_enabled": true,
      "transcription_threshold": 6,
      "call_status_url": "https://example.com"
    }
  ],
  "doc_types": [
    {
      "id": 2,
      "name": "address",
      "title": "Proof of address"
    }
  ],
  "pagination": {
    "current_page": 2,
    "per_page": 25,
    "total": 101,
    "total_pages": 5
  }
}

Authorizations

appid
string
query
required

An API key to authorize your request

Query Parameters

city_id
integer

Filter numbers by city or rate center.

Example:

123

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

Requested page

Example:

2

per_page
integer

The number of records per page

Example:

50

Response

200 - application/json
items
DIDontheAccount · object[]
required

A list of phone numbers on the account

doc_types
DocumentType · object[]
required

A list document types required to activate a phone number

pagination
object
required
I