POST <mms_callback_url>

Response Fields

Upon successful configuration, Flowroute will start posting your inbound MMS messages to your MMS 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 MMS Callback URL are set up correctly.

  • data

    Message object composed of the following:

    • attributes

      Different attributes of an inbound MMS message object:

      • amount_display float- The cost of the message in USD.

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

      • body string- The plain-text content of the MMS message that is counted in the total message size. Inbound MMS, or MO (Mobile Originated) messages can be above 750kB depending on the mobile carrier's MMSC (Multimedia Messaging Service Center) and the device sending the message to your Flowroute number.

      • delivery_receipts array of objects- An array of delivery receipt objects containing status information of your message. This is currently not available for MMS.

      • direction string- Direction of the message. This will always be inbound.

      • from string- Source phone number in E.164 format that the MMS message is being sent from.

      • is_mms boolean- This will always be true if you are receiving an MMS.

      • message_encoding integer- Type of encoding that was used to send the message. To learn more about message encoding, please refer to Message Length & Concatenation.

      • message_type string - Type of the Flowroute phone number receiving the MMS message. This could either be longcode or toll-free.

      • status string - Delivery status of the message which is not available for inbound MMS.

      • timestamp datetime - Date and time, to the second, on which the message was sent. This field displays date and time in UTC following the complete date plus hours, minutes, seconds and a decimal fraction of a second ISO 8601 format.

      • to string - Your Flowroute long code or toll-free number in E.164 format that is receiving the MMS message.

    • id

      ID of the MMS message with the mdr2 prefix.

    • relationships

      Object describing the relationships that an MMS message object can have:

      • media object- Contains the array of resource object(s) for the related media.

        • data array of objects- Contains the individual resource object(s) for the related media.

        • id string- A combination of a unique 18-digit number and the media file_name in this format: <number>-<file_name>.<file_extension>

        • type string- The related media file(s) will always have a type of media.

    • type

      This will always be message.

  • included
    array of objects

    An array of media objects included in your inbound MMS message.

    • attributes

      Different attributes of an included media object:

      • file_name string- File name and extension of the media object. e.g., IMG-20171218-WA0000.jpg

      • file_size integer- File size of the media object in bytes.

      • mime_type string- The Multipurpose Internet Mail Extensions (MIME) type which indicates the nature and format of the media object. e.g., image/jpeg

      • url string- A signed URL with an expiration time and a security token which serves as a temporary download link for the media attachment.

    • id

      Unique identifier of the media object which is the same as the ID in the data object(s) contained within the media array.

    • links

      Links object pointing to the media's Flowroute URI that is currently not accessible.

    • type

      The included media object will always have a type of media.