Preview MMS Template

For testing and debugging purposes, you can preview how the resulting MMS will look like without actually sending.

POST https://mmsc.tsgglobal.world/mms/templates/:id/preview

Renders a preview of the template with the given parameters without sending, where :id is the ID of the created template.

Request body

Name
Type
Description

data.type

string

Must be "mms-template-preview-req"

data.attributes.from

string

Required. Sender number (E.164)

data.attributes.to

array of strings

Required. Recipient numbers (E.164)

data.attributes.params

object

Required. Key-value map of placeholder values. Must match all placeholders defined in the template

Example

Example request

{
  "data": {
    "type": "mms-template-preview-req",
    "attributes": {
      "from": "18003004001",
      "to": ["17818434375"],
      "params": {
        "name": "Jane",
        "company": "TSG"
      }
    }
  }
}

Example response

Example without placeholders

Example request

Example response

Last updated

Was this helpful?