Endpoint

POST <sms_callback_url>

Message Object

  • from
    string

    Valid phone number that the SMS message is being sent from. This number must be in E.164 format. e.g. +12065551234

  • to
    string

    Flowroute local or toll-free number receiving the SMS message. This must be a number that you own in your Flowroute account in E.164 format. e.g. +12065551234

  • body
    string

    Optional, if media_url is specified. The plain-text content of the delivered message.

  • direction
    string

    Direction of the message. This will always be inbound.

  • message_type
    string

    Type of the Flowroute phone number receiving the SMS message. This could either be longcode or toll-free.

  • is_mms
    boolean

    This will always be false if you are receiving an SMS. This attribute is defined by the person sending the message. If not specified, then the message will be sent out as SMS if it is text-only. It will be sent as MMS if it has a media_urls value.

  • message_encoding
    integer

    This will always be set to 0 for SMS. To learn more about message encoding, please refer to Message Length & Concatenation.

  • amount_display
    string

    Cost of the message in USD.

  • amount_nanodollars
    integer

    The cost of the message in nanodollars. The displayed nanodollars amount is the USD amount_display value multiplied by 1,000,000,000 (one billion) for a corresponding whole number.

  • timestamp
    datetime

    Date and time that the message was sent.

Response Format

On success, the HTTP status code in the response header is 200 OK and the response body contains the messagerecord ID. On error, the header status code is an error code and the response body contains an error object.