Sending messages

In order to send a message, you must have an active SMS channel and perform a HTTP request to the following endpoint with a valid access key

Send a message

Send a message to a channel

POST/workspaces/{workspaceId}/channels/{channelId}/messages

Authorization

Path parameters

workspaceId*string (uuid)

The ID of the workspace

channelId*string (uuid)

The ID for a channel

Body

senderSender (object)

receiver*Receiver (object)

referenceReference (string)

templatenullable Template (object)

metaMeta (object)

replyToReplyTo (object)

bodyMessageBody

capFrequencyboolean

If set to true, the frequency capping settings of the platform will be used to either allow or reject the message to a contact. Can only be set to true if the message is sent to a contact and .meta.extraInformation.useCase is marketing.

one of

Response

Message was accepted for processing

Body

id*Id-2 (string (uuid))

channelId*ChannelId (string (uuid))

sender*one of

receiver*one of

metaMeta (object)

referenceReference (string)

partsParts (array of object)

status*Status-3 (enum)

acceptedprocessingsentsending_faileddelivereddelivery_faileddeleted

reasonstring

directionDirection (enum)

incomingoutgoing

replyToReplyTo (object)

lastStatusAt*string (date-time)

createdAt*string (date-time)

updatedAt*string (date-time)

detailsstring

This field is used to store additional information related to the message status.

failurenullable Failure (object)

any of

Request

const response = await fetch('/workspaces/{workspaceId}/channels/{channelId}/messages', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "receiver": {
        "contacts": [
          {}
        ]
      }
    }),
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "sender": {
    "connector": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "identifierValue": "text",
      "annotations": {
        "name": "text"
      }
    }
  },
  "receiver": {
    "connector": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "identifierValue": "text",
      "annotations": {
        "name": "text"
      }
    }
  },
  "meta": {
    "referral": {
      "source": "text",
      "title": "text",
      "text": "text",
      "group": "text",
      "metadata": {
        "source_id": "text",
        "source_url": "text",
        "media_url": "text",
        "tracking_id": "text"
      }
    },
    "order": {
      "products": [
        {
          "externalCatalogId": "text",
          "externalProductId": "text",
          "price": {
            "currencyCode": "text"
          }
        }
      ]
    },
    "referredProduct": {
      "externalCatalogId": "text",
      "externalProductId": "text"
    },
    "email": {
      "subject": "text"
    }
  },
  "reference": "text",
  "parts": [
    {
      "platformReference": "text"
    }
  ],
  "status": "accepted",
  "reason": "text",
  "direction": "incoming",
  "replyTo": {
    "id": "text",
    "type": "message"
  },
  "lastStatusAt": "2024-04-29T12:57:42.872Z",
  "createdAt": "2024-04-29T12:57:42.872Z",
  "updatedAt": "2024-04-29T12:57:42.872Z",
  "details": "text",
  "failure": {
    "source": {
      "code": "text",
      "name": "text"
    }
  },
  "body": {
    "type": "text",
    "text": {
      "text": "text",
      "attachments": [
        {
          "mediaUrl": "https://example.com",
          "filename": "text",
          "inline": false
        }
      ],
      "actions": [
        {
          "type": "link",
          "link": {
            "text": "text",
            "url": "https://example.com"
          }
        }
      ],
      "metadata": {
        "subject": "text"
      }
    }
  }
}

When sending outbound messages as well as setting the receiver information you must set message body field in all cases except for sending a message template when you must only set the template field

Body

{
 "receiver": {
   "contacts": [
     {
       "identifierValue": "+31612345678"
     }
   ]
 },
 "body": {...}
}

Template

{
 "receiver": {
   "contacts": [
     {
       "identifierValue": "+31612345678"
     }
   ]
 },
 "template": {...}
}

SMS messages

All SMS channels support sending basic text based messages using SMS. The example below must be set in the message body field

{
 "receiver": {
   "contacts": [
     {
       "identifierValue": "+31612345678"
     }
   ]
 },
 "body": {...}
}

Send an SMS message

To send an SMS text message set the message body as follows:

 {
  "type": "text",
  "text": {
    "text": "Single text message"
  }
}

MMS messages

SMS channels that are installed with MMS capable numbers (currently numbers purchased for the United States and Canada) also support media messaging. You can also verify if the channel is MMS capable via the API as described here.

Image

Single image message

{
  "type": "image",
  "image": {
    "images": [
      {
        "mediaUrl": "https://pbs.twimg.com/profile_images/1546538670936801280/ZBIxKfMq_400x400.jpg"
      }
    ]
  }
}

Single image message with text

{
  "type": "image",
  "image": {
    "images": [
      {
        "mediaUrl": "https://pbs.twimg.com/profile_images/1546538670936801280/ZBIxKfMq_400x400.jpg"
      }
    ],
    "text": "Single image message"
  }
}

Single image message with text and title

{
  "type": "image",
  "image": {
    "images": [
      {
        "mediaUrl": "https://pbs.twimg.com/profile_images/1546538670936801280/ZBIxKfMq_400x400.jpg"
      }
    ],
    "text": "Single image message",
    "metadata": {
        "subject": "Message subject"
      }
  }
}

Multiple image message

When sending multiple image messages it is possible to send up to an array of 10 media URLs.

{
  "type": "image",
  "image": {
    "images": [
      {
        "mediaUrl": "https://pbs.twimg.com/profile_images/1546538670936801280/ZBIxKfMq_400x400.jpg"
      },
            {
        "mediaUrl": "https://file-examples.com/storage/fe56bbd83564ad7489ca047/2017/10/file_example_PNG_500kB.png"
      }
    ]
  }
}

Multiple image message with text

{
  "type": "image",
  "image": {
    "images": [
      {
        "mediaUrl": "https://pbs.twimg.com/profile_images/1546538670936801280/ZBIxKfMq_400x400.jpg"
      },
            {
        "mediaUrl": "https://file-examples.com/storage/fe56bbd83564ad7489ca047/2017/10/file_example_PNG_500kB.png"
      }
    ],
    "text": "Multiple images message"
  }
}

Multiple image message with text and title

{
  "type": "image",
  "image": {
    "images": [
      {
        "mediaUrl": "https://pbs.twimg.com/profile_images/1546538670936801280/ZBIxKfMq_400x400.jpg"
      },
            {
        "mediaUrl": "https://file-examples.com/storage/fe56bbd83564ad7489ca047/2017/10/file_example_PNG_500kB.png"
      }
    ],
    "text": "Multiple images message",
    "metadata": {
        "subject": "Message subject"
      }
  }
}

File

Single file message

{
  "type": "file",
  "file": {
    "files": [
      {
        "mediaUrl": "https://file-examples.com/storage/fee472ce6e64b122ba0c8b3/2017/04/file_example_MP4_480_1_5MG.mp4",
        "contentType": "video/mp4"
      }
    ]
  }
}

Single file message with text

{
  "type": "file",
  "file": {
    "files": [
      {
        "mediaUrl": "https://file-examples.com/storage/fee472ce6e64b122ba0c8b3/2017/04/file_example_MP4_480_1_5MG.mp4",
        "contentType": "video/mp4"
      }
    ],
    "text": "Single file message"
  }
}

Single file message with text and title

{
  "type": "file",
  "file": {
    "files": [
      {
        "mediaUrl": "https://file-examples.com/storage/fee472ce6e64b122ba0c8b3/2017/04/file_example_MP4_480_1_5MG.mp4",
        "contentType": "video/mp4"
      }
    ],
    "text": "Single file message",
    "metadata": {
        "subject": "Message subject"
      }
  }
}

Multiple file message

{
  "type": "file",
  "file": {
    "files": [
      {
        "mediaUrl": "https://file-examples.com/storage/fee472ce6e64b122ba0c8b3/2017/04/file_example_MP4_480_1_5MG.mp4",
        "contentType": "video/mp4"
      },
            {
        "mediaUrl": "https://file-examples.com/storage/fee472ce6e64b122ba0c8b3/2017/11/file_example_MP3_700KB.mp3",
        "contentType": "audio/mpeg"
      }
    ],
    "text": "Multiple files message"
  }
}

Multiple file message with text

{
  "type": "file",
  "file": {
    "files": [
      {
        "mediaUrl": "https://file-examples.com/storage/fee472ce6e64b122ba0c8b3/2017/04/file_example_MP4_480_1_5MG.mp4",
        "contentType": "video/mp4"
      },
            {
        "mediaUrl": "https://file-examples.com/storage/fee472ce6e64b122ba0c8b3/2017/11/file_example_MP3_700KB.mp3",
        "contentType": "audio/mpeg"
      }
    ],
    "text": "Multiple files message"
  }
}

Multiple file message with text and title

{
  "type": "file",
  "file": {
    "files": [
      {
        "mediaUrl": "https://file-examples.com/storage/fee472ce6e64b122ba0c8b3/2017/04/file_example_MP4_480_1_5MG.mp4",
        "contentType": "video/mp4"
      },
            {
        "mediaUrl": "https://file-examples.com/storage/fee472ce6e64b122ba0c8b3/2017/11/file_example_MP3_700KB.mp3",
        "contentType": "audio/mpeg"
      }
    ],
    "text": "Multiple files message",
    "metadata": {
        "subject": "Message subject"
      }
  }
}

Template messages

Using it is possible to create text and media templates that can quickly be reused to send to contacts. Templates must be active before they are used.

The examples below must be set in the message template field

{
 "receiver": {
   "contacts": [
     {
       "identifierValue": "+31612345678"
     }
   ]
 },
 "template": {...}
}

Text templates

Text templates will be sent as SMS messages and are compatible with all SMS channels

{  "projectId":"ce6a2fd6-b2fa-4f5a-a2cd-f3bd15883318",
   "version":"latest",
   "locale":"en",
   "parameters":[
      {
         "type":"string",
         "key":"name",
         "value":"Robert"
      }
   ]
}

Last updated 9 days ago