Send an SMS

Use this endpoint to send a message from your Flowroute phone number to another valid phone number. Click here 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.
To upgrade from v2 to v2.1, see Upgrade to Flowroute Messaging API v2.1.

Endpoint

POST /messages

Request Parameters

Body Parameters

to
string required
Valid phone number that you're sending the message to. This number must be in E.164 format. e.g., 12065551234
from
string required
Flowroute phone number that you're sending the message from. This must be a number that you own in your Flowroute account in E.164 format. e.g., 12065551234
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.Read this article for specific information on message length and concatenation.

Response Format

On success, the HTTP status code in the response header is 200 OK and the response body contains the message record ID with mdr1 prefix. On error, the header status code is an error code and the response body contains an error object.

Example Request

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

POST /v2/messages HTTP/1.1
Host: api.flowroute.com
Authorization: Basic ENCODED_CREDENTIALS
User-Agent: curl/7.43.0
Accept: */*
Content-Type: application/json; charset=UTF-8

{
    "to":"NUMBER_YOU_HAVE_ACCESS_TO",
    "from":"YOUR_FLOWROUTE_NUMBER",
    "body":"sample message"
}

Example Request

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


curl https://api.flowroute.com/v2/messages -H "Content-Type: application/json" -X POST -d \ 
'{"to":"12061231234","from":"12065551234", "body":"hello world"}' \
-u accessKey:secretKey

Example Request

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 Controller and pass your API credentials
controller = APIController(username="API_ACCESS_KEY", password="API_SECRET_KEY")

#Create and Send a Message
msg = Message(to="NUMBER_YOU_HAVE_ACCESS_TO", from_="YOUR_FLOWROUTE_NUMBER", content="Message Content")
response = controller.create_message(msg)

#Print the response
print (response)

Example Request

This assumes that you have the PHP 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 Messages controller and pass your API credentials
$controller_name = new MessagesController('API_ACCESS_KEY','API_SECRET_KEY');

#Create and Send a message
$message_name = new Message('NUMBER_YOU_HAVE_ACCESS_TO', 'YOUR_FLOWROUTE_NUMBER', 'Message content');
$response = $controller->createMessage($message_name);

#Print the response
print_r($response);

Example Request

This assumes that you have the Ruby 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 Messages controller and pass your API credentials
ctl = FlowrouteMessaging::MessagesController.new('API_ACCESS_KEY', 'API_SECRET_KEY')

#Create and send the message
msg = FlowrouteMessaging::Message.new(to='NUMBER_YOU_HAVE_ACCESS_TO', from='YOUR_FLOWROUTE_NUMBER', content='Message content')

#Print the response
print ctl.create_message(msg)

Example Request

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

//Set your callback function
    var cb =  function(err, response){
      if(err){
        console.log(err);
      }
      console.log(response);
    };

//Create and send a message
var msg = {"to": "NUMBER_YOU_HAVE_ACCESS_TO", "from": "YOUR_FLOWROUTE_NUMBER", "content": "Message Content"};
flowroute.MessagesController.createMessage(msg, cb);

Example Response

200 OK

{
    "data": {
        "id": "mdr1-e3672cb28a9d422a9671945c9bc4eb9a"
    }
}

401 Unauthorized

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

403 Forbidden

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

sms v2.0

About

Endpoints

Related Articles

Send an SMS

SMS Limitations

Endpoint

Request Parameters

Body Parameters

to

from

body

Response Format

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Response

200 OK

401 Unauthorized

403 Forbidden