Set a Callback URL for Your Account

Lets you assign a callback URL for POST notifications of inbound messages or delivery receipts (DLRs) of messages that you have sent from your Flowroute long code or toll-free number.

Callback Service

Make sure to assign a publicly accessible URL for your callback service.

Endpoint

PUT /messages/{callback_type}

Request Parameters

Path Parameter

callback_type
string required
Callback type to be associated with the specified URL. Allowed values are:
- sms_callback
  Called for inbound SMS messages (see Receive an SMS).
- mms_callback
  Called for inbound MMS messages (see Receive an MMS).
- sms_dlr_callback
  Called for SMS Delivery Receipts (see Receive a DLR).
- mms_dlr_callback
  Called for inbound MMS Delivery Receipts (see Receive a DLR).

Body Parameter

callback_url
string required
The callback URL for your specified callback type. For example, if you specify sms_callback as a path parameter, the value that you set this field to will be the URL associated with the inbound SMS callback service for your Flowroute account. To learn more about Flowroute's SMS callback service, see Receive an SMS.

Response Format

On success, the HTTP status code in the response header is 204 No Content which means that the server successfully processed the request and is not returning any content. On error, the header status code is an error code and the response body contains an array of error objects.

Please make sure to use neutral (vertical) quotes in your request. Smart quotes are known to cause errors.

Example Request

PUT /v2.2/messages/sms_callback HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "data": {
    "attributes": {
      "callback_url": "https://requestbin.fullcontact.com/tjji7itj"
    }
  }
}

Please make sure to use neutral (vertical) quotes in your request. Smart quotes are known to cause errors.

Example Request

PUT /v2.2/messages/sms_callback HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
{
    "callback_url": "https://requestbin.fullcontact.com/tjji7itj"
}

Please make sure to use neutral (vertical) quotes in your request. Smart quotes are known to cause errors.

Example Request


curl https://api.flowroute.com/v2.2/messages/sms_callback \
-H "Content-Type": "application/vnd.api+json" -X PUT -d \ 
'{"callback_url": "https://requestbin.fullcontact.com/tjji7itj"}' \
-u accessKey:secretKey

Example Response

204 No Content

Error Responses

401 Unauthorized

{
  "errors": 
  [
    {
      "status": 401, 
      "detail": "Authentication failed.", 
      "title": "Unauthorized"
    }
  ]
}

405 Method Not Allowed

Returned when specifying an invalid callback type.

  {  "errors":
    [
       {
        "detail": "The method is not allowed for the requested URL.",
        "id": "e806c574-53e6-4f53-9430-f90a70100bb2",
        "status": 405,
        "title": "Method Not Allowed"
      }
    ]
  }

mms v2.2

About

Endpoints

ACCOUNT LEVEL MESSAGING CALLBACK SERVICES

PHONE NUMBER MESSAGING CALLBACK SERVICES

Related Articles

Set a Callback URL for Your Account

Callback Service

Endpoint

Request Parameters

Path Parameter

callback_type

Body Parameter

callback_url

Response Format

Example Request

Example Request

Example Request

Example Response

204 No Content

Error Responses

401 Unauthorized

405 Method Not Allowed