Skip to main content
POST
/
v1.0
/
message
/
routes
json
{
  "RouteName": "Main SMS Webhook",
  "MessageUrl": "https://apiendpoint.com",
  "MessageUrlMethod": "POST",
  "MessageRouteEnabled": true,
  "MessageAuthenticationType": "Basic",
  "MessageUsername": "admin"
}
{
  "MessageRouteId": "MRID-ad0ff867-57dc-4aeb-80e9-9d18349080e9",
  "AccountId": "DID-eab92510-1040-45a5-bb9c-0bad927SDY878W",
  "RouteName": "Main SMS Webhook",
  "MessageUrl": "https://apiendpoint.com",
  "MessageUrlMethod": "POST",
  "MessageRouteEnabled": false,
  "MessageAuthenticationType": "Basic",
  "MessageUsername": "admin",
  "MessagePasswordToken": "passwordORbearerToken",
  "CallbackMessageUrl": "https://apiendpoint.com",
  "CallbackMessageUrlMethod": "POST",
  "CallbackMessageAuthenticationType": "Basic",
  "CallbackMessageUsername": "admin",
  "CallbackMessagePasswordToken": "password"
}

Authorizations

​
Authorization
string
header
required

Enter the token obtained from the Authentication endpoint

Body

application/json
​
RouteName
string
required

Friendly name for the message route

Example:

"Main SMS Webhook"

​
MessageUrl
string<uri>
required

Primary webhook URL for inbound messages

Example:

"https://apiendpoint.com"

​
MessageUrlMethod
enum<string>
required

HTTP method for webhook delivery

Available options:
GET,
POST
Example:

"POST"

​
MessageRouteEnabled
boolean
default:true

Enable or disable this message route

Example:

true

​
MessageAuthenticationType
enum<string>

Authentication type for primary webhook

Available options:
None,
Basic,
Bearer
Example:

"Basic"

​
MessageUsername
string

Username for Basic auth (if applicable)

Example:

"admin"

​
MessagePasswordToken
string

Password for Basic auth or token for Bearer auth

Example:

"passwordORbearerToken"

​
CallbackMessageUrl
string<uri>

Fallback/callback webhook URL

Example:

"https://apiendpoint.com"

​
CallbackMessageUrlMethod
enum<string>

HTTP method for callback webhook

Available options:
GET,
POST
Example:

"POST"

​
CallbackMessageAuthenticationType
enum<string>

Authentication type for callback webhook

Available options:
None,
Basic,
Bearer
Example:

"Basic"

​
CallbackMessageUsername
string

Username for callback Basic auth

Example:

"admin"

​
CallbackMessagePasswordToken
string

Password/token for callback auth

Example:

"password"

Response

200 - application/json

Create Message Route

The response is of type object.