Send an SMS

Use this endpoint to send an SMS from your Flowroute phone number to another valid phone number. Visit Manage your DIDs to view all of your Flowroute numbers.

SMS Limitations

You can only send an SMS from a phone number registered on your Flowroute account.
You are allowed to send 5 SMS per second.
Flowroute cannot guarantee delivery to any phone number not enabled for SMS.
Smart quotes are known to cause errors. Please make sure to use neutral (vertical) quotes in your request.

Endpoint

POST /messages

Request Parameters

Body Parameters

to
string required
Valid phone number that you're sending the message to. This number must be compliant with E.164 number standards+12065551234
from
string required
Flowroute phone number that you're sending the message from. This number must be compliant with E.164 number standards+12065550101
body
string required
The content of the message to deliver. Depending on the length of your message, it may be broken into multiple fragments which will be reassembled on the receiver's handset. See Message Length & Concatenation for specific information.
dlr_callback
string
A callback URL that you can configure on a per message basis for delivery receipt updates. Upon sending your SMS, Flowroute will post the delivery receipts to the dlr_callback that you've set. To learn more, see Receive a DLR.

Note: this will override the global sms_dlr_callback if set.

Response Format

On success, the HTTP status code in the response header is 202 Accepted and the response body contains the message record ID with mdr2 prefix. On error, the header status code is an error code and the response body contains an array of error objects.

Response Fields

Upon successful configuration, Flowroute will start posting your inbound SMS messages to your SMS Callback URL. The HTTP status code in the response header is 200 OK and the response body contains a detailed message object in JSON format. If you don't receive the POST notifications, check that your callback service and SMS Callback URL are set up correctly.

data
object
Message object composed of the following:

price_details object - The pricing details of the message sent.

base_rate decimal - The base cost per message segment. Unit is USD.
charged_cost decimal - The total cost of the message. This is calculate by the following formula: (base_rate + surcharge_rate) * segment_count
segment_count int - The SMS industry standard for a single message is 160 characcters as defined in the GSM 03.38 standard
surcharge_rate decimal - The surcharge price per segment that the message incurred.

id
string
ID of the SMS message with the mdr2 prefix.
type
string
This will always be message.

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

Example Request

No DLR Callback

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

{
  "data": {
    "type": "message",
    "attributes": {
      "to": "+19511231234",
      "from": "+18441231234",
      "body": "hey"
    }
  }
}

With DLR Callback

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

{
  "data": {
    "type": "message",
    "attributes": {
      "to": "+19511231234",
      "from": "+18441231234",
      "body": "hey",
      "dlr_callback": "https://example.com/message_to_slack"
    }
  }
}

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

Example Request

No DLR Callback

POST /v2.2/messages HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
{
  "data": {
    "type": "message",
    "attributes": {
      "to": "+19511231234",
      "from": "+18441231234",
      "body": "hey"
    }
  }
}

With DLR Callback

POST /v2.2/messages HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
{
  "data": {
    "type": "message",
    "attributes": {
      "to": "+19511231234",
      "from": "+18441231234",
      "body": "hey",
      "dlr_callback": "https://example.com/message_to_slack"
    }
  }
}

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

Example Request

No DLR Callback


curl https://api.flowroute.com/v2.2/messages \
-H "Content-Type: application/vnd.api+json" -X POST -d \
'{"data": {"type": "message","attributes": {"to": "+19511231234","from": "+18441231234","body": "hey"}}}' \
-u accessKey:secretKey

With DLR Callback


curl https://api.flowroute.com/v2.2/messages \
-H "Content-Type: application/vnd.api+json" -X POST -d \
'{"data": {"type": "message","attributes": {"to": "+19511231234","from": "+18441231234","body": "hey","dlr_callback": "https://example.com/message_to_slack"}}}' \
-u accessKey:secretKey

Example Compact Request

No DLR Callback

This assumes that you have the Python API Wrapper installed and set up. Please make sure to use neutral (vertical) quotes in your request. Smart quotes are known to cause errors.


# Instantiate the API client and create a controller for Messages
client = FlowroutenumbersandmessagingClient(basic_auth_user_name, basic_auth_password)
messages_controller = client.messages

# Create your test SMS
request_body = '{ \
      "data": { \
        "type": "message", \
        "attributes": { \
          "to": "+YOUR_MOBILE_NUMBER", \
          "from": "+YOUR_FLOWROUTE_NUMBER", \
          "body": "hey" \
        } \
      } \
    }'

print ("---Send A Message")
result = messages_controller.send_a_message(request_body)
pprint.pprint(result)

Example Response

202 ACCEPTED

{
"data": {
    "id": "mdr2-abc123",
    "links": {
      "self": "https://api.flowroute.com/v2.2/messages/mdr2-abc123"
    },
    "price_details": {
      "base_rate": 0.0035,
      "charged_cost": 0.0097,
      "segment_count": 1,
      "surcharge": 0.0062
    },
    "type": "message"
  }
}

401 Unauthorized

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

403 Forbidden

{  "errors": 
  [
    {
      "status": 403, 
      "detail": "", 
      "title": "ActionNotAuthorizedError"
    }
  ]
}

mms v2.2

About

Endpoints

ACCOUNT LEVEL MESSAGING CALLBACK SERVICES

PHONE NUMBER MESSAGING CALLBACK SERVICES

Related Articles

Send an SMS

SMS Limitations

Endpoint

Request Parameters

Body Parameters

to

from

body

dlr_callback

Response Format

Response Fields

data

id

type

Example Request

No DLR Callback

With DLR Callback

Example Request

No DLR Callback

With DLR Callback

Example Request

No DLR Callback

With DLR Callback

Example Compact Request

No DLR Callback

Example Response

202 ACCEPTED

401 Unauthorized

403 Forbidden