My numbers

Bulk update phone numbers

Changed on

Applies the same changes to every listed phone number. Only the provided fields are changed. Destination and SMS callback changes are applied asynchronously and may not be reflected in the response immediately.

patch/v1/numbers

Request

  • Base URL
    https://api.wavix.com
  • URL
    https://api.wavix.com/v1/numbers
  • Auth
    HTTP bearer

Request body

idsinteger[] required

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

sms_enabledboolean

Indicates whether SMS is enabled for the phone numbers.

sms_relay_urlstring uri

Callback URL for inbound messages.

call_recording_enabledboolean

Indicates whether call recording is enabled.

transcription_enabledboolean

Indicates whether call transcription is enabled.

transcription_thresholdinteger

Minimum call duration in seconds before transcription runs.

call_status_urlstring uri

Callback URL for call status updates.

Example request

{
  "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"
}

Response

Returns the updated phone numbers.

Example response

{
  "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"
        }
      ],
      "channels": 24,
      "require_docs": [
        "address"
      ],
      "documents": [
        {
          "id": 423,
          "allow_replace": false,
          "did_number": "12565378257",
          "doc_content_type": "image/png",
          "doc_file_name": "Copy of ID.png",
          "doc_type": "id",
          "status": "approved",
          "url": "https://api.wavix.com/v1/numbers/24882/papers/1"
        }
      ],
      "added": "2023-04-10T06:42:59.000Z",
      "paid_until": "2023-12-07",
      "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"
    }
  ]
}

Changes

    • breaking

      removed the required property //// from the response with the status

    • warning

      added the new address enum value to the /// response property for the response status

    • warning

      added the new id enum value to the /// response property for the response status

    • warning

      added the new localaddress enum value to the /// response property for the response status

    • info

      added the required property //// to the response with the status

    • info

      api operation id numbers_bulk_update removed and replaced with my_numbers_bulk_update

    • info

      added the non-success response with the status