Update DID Configuration

Update the configuration of an existing DID (Direct Inward Dialing) number.
This endpoint can also be used to update IPDN (Integrated Public Number Database) information.

Request Body

• did_number: The DID number to update (must start with 61 for AU or 86 for NZ)
• description: Optional friendly description for the number
• primary_route: Primary routing method
• primary_destination: Destination for primary route (required for some route types)
• primary_timeout: Optional timeout in seconds
• backup_route: Backup routing method
• backup_destination: Destination for backup route (required for some route types)
• block_prefs: Call blocking preferences
  • block_invalid: Block calls with invalid CLI
  • block_hidden: Block calls with hidden CLI
  • block_international: Block international calls
  • block_landline: Block calls from landlines
  • block_mobile: Block calls from mobiles
  • block_list: List of numbers to block
  • allow_list: List of numbers to allow
  • route: Routing method for blocked calls
  • destination: Destination for blocked calls
• sms_routes: SMS routing configuration (only for virtual mobile numbers)
  • route: SMS routing method
  • destination: SMS destination
• address_id: UUID of the address for IPDN registration
• person_id: UUID of the person for IPDN registration

IPDN Information

The address_id and person_id fields are used to update the IPDN registration details:

• address_id: Links the DID to a registered service address in the IPDN. You can create and manage addresses using the Account Addresses API.
• person_id: Links the DID to a registered person or organization in the IPDN. You can create and manage account holders using the Account Holders API.

These fields are important for maintaining accurate emergency service information.

Available Destinations

You can retrieve a list of available destinations by making a GET request to:
/api/v1/phone-numbers/destinations/

Route Types

• congestion: Play congestion tone
• device: Route to a specific device
• server: Route to a SIP server
• uri: Route to a SIP URI
• pstn: Route to PSTN
• group: Route to a hunt group
• voicemail: Send to voicemail
• pbx: Route to PBX
• timeswitch: Use time-based routing
• fax: Send to fax server
• aa: Auto attendant
• announcement: Play announcement
• pstn2: Alternative PSTN route
• stateroute: State-based routing
• busy: Play busy tone

SMS Route Types (for virtual mobile numbers)

• email: Forward to email
• sip: Forward via SIP
• httpget: Forward via HTTP GET
• httppost: Forward via HTTP POST
• httpform: Forward via HTTP form
• httpjson: Forward via HTTP JSON
• forward: Forward to another number
• forwardspoof: Forward with CLI spoofing
• device: Send to device
• softphone: Send to softphone
• server: Send to server
• reply: Auto-reply
• replyonce: Single auto-reply
• pbx: Send to PBX
• 3cx: Send to 3CX
• softphone_pbx: Send to softphone via PBX

Returns

• Success message if the update is completed

Raises

• 400: Invalid configuration
• 404: DID not found
• 500: API communication error