Skip to main content
PUT
/
mydids
/
{id}
Update a specific number
curl --request PUT \
  --url https://api.wavix.com/v1/mydids/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "call_recording_enabled": true,
  "transcription_enabled": true,
  "transcription_threshold": 30,
  "sms_relay_url": "https://you-site.com/sms",
  "call_status_url": "https://your-site.com/calls"
}'
{
  "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"
}

Authorizations

​
appid
string
query
required

An API key to authorize your request

Path Parameters

​
id
integer
required

Phone number ID

Example:

123

Body

application/json
​
call_recording_enabled
boolean

Turn call recording on or off for the number.

Example:

true

​
transcription_enabled
boolean

Turn transcription on or off for the number.

Example:

true

​
transcription_threshold
integer

Transcription threshold, in seconds.

Example:

30

​
sms_relay_url
string

SMS relay URL for the number. Incoming and MMS messages are sent to this URL as HTTP POST requests. If the number isn't SMS-enabled, setting the sms_relay_url returns the HTTP 422 Unprocessable Content error. To remove inbound message routing for this number, set the value to null. Messages will then be forwarded only to the sms_relay_url configured on the account.

Example:

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

​
call_status_url
string

Call status callback URL for the number. Status updates are sent to this URL as HTTP POST requests.

Example:

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

Response

A phone number on the account

​
id
integer
required

Unique identifier of the DID

Example:

123

​
number
string
required

The phone number

Example:

"12565378257"

​
activation_fee
string
required

The phone number activation fee, in USD

Example:

"0.99"

​
monthly_fee
string
required

Recurring phone number monthly fee, in USD

Example:

"0.99"

​
per_min
string
required

Price per inbound minute, in USD

Example:

"0.0059"

​
city
string
required

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

Example:

"DETROIT, MI"

​
country
string
required

The originating country of the phone number

Example:

"United States"

​
country_short_name
string
required

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

Example:

"US"

​
destination
InboundCallDestination · object[]
required

Inbound call destinations configured for the phone number

​
channels
integer
required

Number of inbound channels on the phone number

Example:

24

​
require_docs
string[]
required

A list of document required to activate the phone number

Example:
["1"]
​
documents
DIDDocument · object[]
required

Documents uploaded for the phone number

​
domestic_cli
boolean
required

Domestic cli

​
label
string | null
required

Label assigned to the phone number

​
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

​
seconds
string
required

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

​
added
string<date-time>
required

Date and time the phone number was added to the account

Example:

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

​
paid_until
string<date>
required

The date when the next monthly phone number charge is due

Example:

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

​
sms_enabled
boolean
required

Indicates if the phone number is SMS-enabled

Example:

false

​
sms_relay_url
string | null
required

A webhook URL to forward inbound messages to

Example:

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

​
cnam
boolean | null
required

Indicates if CNAM storage is activated for the phone number

Example:

true

​
call_recording_enabled
boolean
required

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

Example:

true

​
transcription_enabled
boolean
required

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

Example:

true

​
transcription_threshold
integer
required

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

Example:

6

​
state
string
​
free_min
integer

Free minute

​
unlimited
boolean
​
call_status_url
string | null

Call status url

Example:

"https://example.com"

⌘I