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 11-digit North American number 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 11-digit North American number format. e.g. 12061231234

  • 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 an SMS DLR.

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.