Skip to main content

Create destination

POST 
/api/v1/purchases/:purchase_id/destinations

Add a new inbound destination for a DID number.

Destination Types:

  • SIP addresses (e.g., sip:[email protected])
  • Phone numbers (e.g., 18005551234)
  • Extensions (SIP accounts created within didlogic)

Parameters:

  • destination - The forwarding target (SIP URI or phone number)
  • dialing_type - Dialing mode: sequence, ring_all or random
  • callhunt - Legacy two-state mirror of dialing_type (boolean); ignored when dialing_type is sent
  • active - Enable/disable this destination (boolean)
  • transport - Transport type code (1 = SIP URI, 4 = Phone number, 5 = SIP device, 10 = Webphone, 12 = WebSocket)

transport: 12 streams the call to a WebSocket endpoint of your own instead of ringing a phone or a SIP device, and destination is then its public wss:// URL. It is available only to accounts enabled for voice streaming; any other account is refused with 422. The endpoint has to speak our protocol — see WebSocket Calls.

did_destination.id feeds purchases_destinations_update and purchases_destinations_destroy as id. Rows: purchases_destinations_index.

Request​

Responses​

Successfully creates destination and returns destination details