WAwavix
My numbers

Update a phone number

Changed on

Updates the phone number identified by id. Only the provided fields are changed.

patch/v1/numbers/{id}

Request

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

Path parameters

idinteger required
Example:123

The unique ID of the phone number.

Request body

sms_enabledboolean

Indicates whether SMS is enabled for the phone number.

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

{
  "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 number.

idinteger required

Phone number ID.

numberstring required

Phone number.

activation_feestring required

One-time activation fee in USD.

monthly_feestring required

Monthly fee in USD.

per_minstring required

Price per inbound minute in USD.

citystring required

City or rate center where the phone number originates.

statestring nullable

State where the phone number originates. For non-US numbers, this field may be null.

countrystring required

Country where the phone number originates.

country_short_namestring required

Two-letter ISO country code.

channelsinteger required

Maximum number of concurrent inbound calls.

require_docsDocumentType[] required

Documents to activate the number.

domestic_cliboolean required

Indicates whether the number can be used as the Caller ID for local calls.

free_mininteger

Number of free inbound minutes.

unlimitedboolean

Indicates whether usage is unlimited.

labelstring nullable required

Label assigned to the phone number.

statusstring required

Phone number status. active means the number can receive and place calls; inactive means it cannot.

secondsstring required

Total inbound call duration in seconds for current month.

addedstring date-time required

Date and time the phone number was purchased in ISO 8601 format.

paid_untilstring date required

Date until which the number is paid.

sms_enabledboolean required

Indicates whether SMS is enabled.

sms_relay_urlstring nullable required

Callback URL for inbound SMS and MMS messages.

cnamboolean nullable required

Indicates whether CNAM is enabled.

call_recording_enabledboolean required

Indicates whether call recording is enabled.

transcription_enabledboolean required

Indicates whether transcription is enabled.

transcription_thresholdinteger required

Minimum call duration in seconds to trigger transcription.

call_status_urlstring nullable

Callback URL for call status updates.

Example response

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

  • 76b9ec29392aRevision 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

  • 6a89c962481cRevision changes
    • info

      api operation id numbers_update removed and replaced with my_numbers_update

    • info

      added the non-success response with the status