Skip to main content
PATCH
/
v1
/
numbers
Bulk update phone numbers
curl --request PATCH \
  --url https://api.wavix.com/v1/numbers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    123,
    456
  ],
  "sms_enabled": true,
  "destinations": [
    {
      "destination": "32882",
      "priority": 1,
      "transport": 5,
      "trunk_id": 3107
    }
  ],
  "sms_relay_url": "https://your-site.com/sms",
  "call_recording_enabled": true,
  "transcription_enabled": true,
  "transcription_threshold": 30,
  "call_status_url": "https://your-site.com/calls"
}
'
{
  "items": [
    {
      "id": 123,
      "number": "12565378257",
      "activation_fee": "0.99",
      "monthly_fee": "0.99",
      "per_min": "0.01",
      "city": "DETROIT, MI",
      "country": "United States",
      "country_short_name": "US",
      "destination": [
        {
          "id": 1,
          "destination": "[did]@sipuri.com",
          "priority": 1,
          "trunk_id": 23123,
          "trunk_label": "My trunk",
          "srtp": false
        }
      ],
      "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/numbers/24882/papers/1"
        }
      ],
      "domestic_cli": true,
      "label": "<string>",
      "status": "<string>",
      "seconds": "<string>",
      "added": "2023-04-10T06:42:59.000Z",
      "paid_until": "2023-12-07",
      "sms_enabled": false,
      "sms_relay_url": "https://your-website.com/webhook",
      "cnam": true,
      "call_recording_enabled": true,
      "transcription_enabled": true,
      "transcription_threshold": 6,
      "state": "<string>",
      "free_min": 123,
      "unlimited": true,
      "call_status_url": "https://example.com"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Wavix API key. Pass as Authorization: Bearer <api_key>. Keys support per-resource scopes (none / read / write). See Restricted keys and scopes.

Body

application/json

A single patch applied to every listed phone number. All mutable fields are optional.

​
ids
integer[]
required

Numbers (by ID) to apply the patch to. The same patch is applied to every listed number.

Example:
[123, 456]
​
sms_enabled
boolean

Indicates whether SMS is enabled for the phone numbers.

Example:

true

​
destinations
NumberDestination · object[]

Inbound call routing destinations for the phone numbers.

​
sms_relay_url
string<uri>

Callback URL for inbound messages.

Example:

"https://your-site.com/sms"

​
call_recording_enabled
boolean

Indicates whether call recording is enabled.

Example:

true

​
transcription_enabled
boolean

Indicates whether call transcription is enabled.

Example:

true

​
transcription_threshold
integer

Minimum call duration in seconds before transcription runs.

Example:

30

​
call_status_url
string<uri>

Callback URL for call status updates.

Example:

"https://your-site.com/calls"

Response

Returns the updated phone numbers.

​
items
Number · object[]

The updated phone numbers.