Create an endpoint

Creates a new voice or SMS endpoint for your organisation. Voice endpoints must use sip: URIs. SMS endpoints can use HTTPS callbacks or mailto: URIs.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

A description of the endpoint

string
enum
required

The type of endpoint to create

Allowed:
string
required

The URI of the endpoint.

For Voice endpoints, this must start with sip: and supports variables: %e164, %raw and %national for the E.164, raw and national number formats respectively. e.g. sip:%[email protected]:5060

For SMS endpoints, this can be a HTTPS or Email URI. e.g. https://example.com/callback or mailto:[email protected]

boolean

If true, this becomes the default for this endpoint type and replaces any existing default. Existing numbers with explicit endpoints are not reassigned.

boolean

Whether this endpoint is the secondary for the endpoint type

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json