Messaging

Sending messages

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

When you send a message, a contact is automatically created with a contactId matching the receiver's identifier if one doesn't already exist. For instance, sending an email generates a contact with an email identifier, while sending an SMS creates one with a phone number identifier.

Send a message

Send a message to a channel

post

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

Authorizations

useraccessKey

Path parameters

workspaceIdstring uuidrequired

The ID of the workspace

channelIdstring uuidrequired

The ID for a channel

Body

senderobject

receiverobjectrequired

referencestring

A reference to the message. This can be used to identify the message in the channel.

Example: my-own-identifier

templatenullable object

metaobject

replyToobject

bodyMessageBody

notificationChannelNotification

tagsstring[]

Tags to associate with the message. Tags are converted to lower case and tags that do not exist are automatically created. You can view your created tags in the UI. You can specify up to 10 tags per message.

shortLinksnullable object

SMS link shortening options. When using templates, please refer to the template level shortLinks instead.

scheduledForstring date-time

Scheduled time to send message at. Must be formated as RFC3339 timestamp. When set, the message status will be scheduled until it's sent. Messages scheduled for a time in the past or within 10 minutes of the request may be sent immediately. Messages scheduled farther than 35 days will be rejected.

validityinteger

Validity determines for how many seconds a message is valid. If none is provided, the channel message type will be used to determine it. A promotional, conversational or transactional channel message is valid for 36 hours (129600 seconds). A message sent from a 2FA channel is valid for 10 minutes (600 seconds).

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.

enableLinkTrackingboolean

If set to true and message is a test/campaign message, web tracking parameters will be appended to the links in the message.

ignoreQuietHoursboolean

If set to true, quiet hours settings will be ignored and the message will be sent as soon as possible.

ignoreGlobalHoldoutboolean

Do not check if the recipient is part of global holdout. To be used to send transactional messages.

any of

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/channels/{channelId}/messages' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"sender":{"connector":{"annotations":{},"identifierValue":"[e-mail]"}},"receiver":{"contacts":[{"id":"a1405560-c8d3-4b1a-877d-3f449ad95352","identifierKey":"emailaddress","identifierValue":"[e-mail]","type":"cc","identifiers":[{"identifierKey":"emailaddress","identifierValue":"[e-mail]"}]}]},"reference":"my-own-identifier","template":{"projectId":"a1405560-c8d3-4b1a-877d-3f449ad95352","version":"a1405560-c8d3-4b1a-877d-3f449ad95352","parameters":[{"key":"text","type":"string"}],"variables":{},"shortLinks":{},"attachments":[{"mediaUrl":"https://example.com","filename":"text"}],"utmParameters":[{"key":"text","value":"text"}]},"meta":{"referral":{"metadata":{}},"order":{"products":[{"price":{}}]},"referredProduct":{},"email":{"headers":{},"from":{}},"pushNotifications":{"gatewayTypeOverride":"apns"},"flow":{},"journey":{},"campaign":{},"extraInformation":{"ANY_ADDITIONAL_PROPERTY":"anything"}},"replyTo":{"type":"message","id":"text"},"body":{"type":"text","text":{"text":"text","actions":[{"type":"link","link":{"text":"text"}}],"attachments":[{"mediaUrl":"https://example.com","filename":"text"}],"metadata":{"telegram":{"parseMode":"Markdown"},"headers":{},"whatsapp":{},"line":{"emoji":{"items":[{"index":1,"productId":"text","emojiId":"text"}]}}}}},"notification":{},"tags":[null],"shortLinks":{"domain":"text"}}'

202

400

404

409

422

202

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "meta": {
    "referral": {
      "metadata": {}
    },
    "order": {
      "products": [
        {
          "price": {}
        }
      ]
    },
    "referredProduct": {},
    "email": {
      "headers": {},
      "from": {}
    },
    "pushNotifications": {
      "gatewayTypeOverride": "apns"
    },
    "navigatorId": "123e4567-e89b-12d3-a456-426614174000",
    "navigatorMessageId": "123e4567-e89b-12d3-a456-426614174000",
    "flow": {},
    "journey": {},
    "campaign": {},
    "extraInformation": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "reference": "my-own-identifier",
  "parts": [
    {
      "platformReference": "text"
    }
  ],
  "status": "accepted",
  "reason": "text",
  "direction": "incoming",
  "origin": {
    "type": "text",
    "id": "text"
  },
  "replyTo": {
    "type": "message",
    "id": "text",
    "order": 1
  },
  "lastStatusAt": "2025-02-18T22:45:19.713Z",
  "createdAt": "2025-02-18T22:45:19.713Z",
  "updatedAt": "2025-02-18T22:45:19.713Z",
  "failure": {
    "code": 1,
    "description": "Unsupported media type",
    "source": {
      "code": "text",
      "name": "text"
    }
  },
  "tags": [
    "text"
  ],
  "shortLinks": {
    "domain": "text"
  },
  "scheduledFor": "2025-02-18T22:45:19.713Z",
  "details": "text",
  "sender": {
    "connector": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "identifierValue": "text",
      "annotations": {
        "name": "text"
      },
      "types": [
        "text"
      ]
    }
  },
  "receiver": {
    "connector": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "identifierValue": "text",
      "annotations": {
        "name": "text"
      },
      "types": [
        "text"
      ]
    }
  },
  "body": {
    "type": "text",
    "text": {
      "text": "text",
      "actions": [
        {
          "type": "link",
          "link": {
            "text": "text"
          }
        }
      ],
      "attachments": [
        {
          "mediaUrl": "https://example.com",
          "filename": "text"
        }
      ],
      "metadata": {
        "telegram": {
          "parseMode": "Markdown"
        },
        "headers": {},
        "whatsapp": {},
        "line": {
          "emoji": {
            "items": [
              {
                "index": 1,
                "productId": "text",
                "emojiId": "text"
              }
            ]
          }
        }
      }
    }
  }
}

Message was accepted for processing

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

Multiple recipient messages are only possible through the Email platform. For other platforms, a message with multiple reciever entries will be rejected.

Body

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

Template

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

Uploading media

When sending messages that contain media links these must be publicly accessible. Otherwise you can upload media by creating requesting a pre-signed media URL. Firstly make a POST request to the following endpoint with the content type of the media you will be uploading set in the request body.

There are two methods for generating a presigned URL: one is channel-independent, allowing it to be used across any channel, while the other restricts usage to a specified channel ID.

Create a presigned media upload

post

/workspaces/{workspaceId}/channel-media/presigned-upload

Authorizations

useraccessKey

Path parameters

workspaceIdstring uuidrequired

The ID of the workspace

Body

contentTypestringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/channel-media/presigned-upload' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"contentType":"text"}'

200

404

422

200

{
  "mediaUrl": "https://example.com",
  "uploadUrl": "https://example.com",
  "uploadMethod": "text",
  "uploadFormData": {}
}

OK

Create a presigned media upload

post

/workspaces/{workspaceId}/channels/{channelId}/presigned-upload

Authorizations

useraccessKey

Path parameters

workspaceIdstring uuidrequired

The ID of the workspace

channelIdstring uuidrequired

The ID for a channel

Body

contentTypestringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/channels/{channelId}/presigned-upload' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"contentType":"text"}'

200

404

422

200

{
  "mediaUrl": "https://example.com",
  "uploadUrl": "https://example.com",
  "uploadMethod": "text",
  "uploadFormData": {}
}

OK

From the response you will get the following details:

mediaUrl: This will be the URL you set in any message bodies where you send the uploaded media

uploadUrl: This is the URL you will need to make a request to to upload your media file

uploadMethod: This is the HTTP method to make an upload i.e. POST

uploadFormData: Set this as the fields in form-data of your POST request along with an additional field called file. This should include your file data. An example using CURL

No need to specify any AccessKey on the below call as all the required data is provided in the form data.

curl -X POST \
  # uploadFormData
  -F Content-Type='...' \
  -F acl='private' \
  -F bucket='channels..' \
  -F key='b2d..b123' \
  -F policy='eyJle...dfQ==' \
  -F x-amz-algorithm='AWS4-HMAC-SHA256' \
  -F x-amz-credential='ASIA..' \
  -F x-amz-date='20230501T192504Z' \
  -F x-amz-meta-allowed-paths='workspace\b2..' \
  -F x-amz-meta-channel-id='ac0..f19e' \
  -F x-amz-security-token='IQoo..qqq' \
  -F x-amz-signature='RcU9...XLw=' \
  # the file to upload
  -F file=@local-filename.txt \
  # the URL
  https://channels...s3.amazonaws.com/

Once you have uploaded the file using the mediaUrl, this should be used as the URL when sending messages with media.

Retrieving messages

Retrieve a list of messages of a channel

List messages by channel ID

It retrieves a list of messages from a given channel ID

get

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

Authorizations

useraccessKey

Path parameters

workspaceIdstring uuidrequired

The ID of the workspace

channelIdstring uuidrequired

The ID for a channel

Query parameters

limitinteger

Limits the number of results to return

pageTokenstring

Pagination token that keeps of track of the current position in the list

reverseboolean

Order in which to retrieve the results

platformany of

Filter based on platform name

directionenum

Options: incoming, outgoing

idstring uuid[]

navigatorIdstring uuid

messageTypeenum[]

statusenum[]

startAtstring date-time

Start date for the query

endAtstring date-time

End date for the query

fromstring[]

sender identifier for the message

tostring[]

recipient identifier for the message

failureCodeinteger[]

failureSourceCodestring[]

failureSourceNamestring[]

countryCodestring[]

tagstring[]

Filter based on tag

emailSubjectstring

Full text search on email subject

batchIdstring uuid

The ID for a batch

Responses

text/csvapplication/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/workspaces/{workspaceId}/channels/{channelId}/messages' \
  --header 'Authorization: Bearer jwt'

200

404

422

200

{
  "startAt": "2025-02-18T22:45:19.713Z",
  "endAt": "2025-02-18T22:45:19.713Z",
  "nextPageToken": "text",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "channelId": "123e4567-e89b-12d3-a456-426614174000",
      "meta": {
        "referral": {
          "metadata": {}
        },
        "order": {
          "products": [
            {
              "price": {}
            }
          ]
        },
        "referredProduct": {},
        "email": {
          "headers": {},
          "from": {}
        },
        "pushNotifications": {
          "gatewayTypeOverride": "apns"
        },
        "navigatorId": "123e4567-e89b-12d3-a456-426614174000",
        "navigatorMessageId": "123e4567-e89b-12d3-a456-426614174000",
        "flow": {},
        "journey": {},
        "campaign": {},
        "extraInformation": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "reference": "my-own-identifier",
      "parts": [
        {
          "platformReference": "text"
        }
      ],
      "status": "accepted",
      "reason": "text",
      "direction": "incoming",
      "origin": {
        "type": "text",
        "id": "text"
      },
      "replyTo": {
        "type": "message",
        "id": "text",
        "order": 1
      },
      "lastStatusAt": "2025-02-18T22:45:19.713Z",
      "createdAt": "2025-02-18T22:45:19.713Z",
      "updatedAt": "2025-02-18T22:45:19.713Z",
      "failure": {
        "code": 1,
        "description": "Unsupported media type",
        "source": {
          "code": "text",
          "name": "text"
        }
      },
      "tags": [
        "text"
      ],
      "shortLinks": {
        "domain": "text"
      },
      "scheduledFor": "2025-02-18T22:45:19.713Z",
      "details": "text",
      "sender": {
        "connector": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "identifierValue": "text",
          "annotations": {
            "name": "text"
          },
          "types": [
            "text"
          ]
        }
      },
      "receiver": {
        "connector": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "identifierValue": "text",
          "annotations": {
            "name": "text"
          },
          "types": [
            "text"
          ]
        }
      },
      "body": {
        "type": "text",
        "text": {
          "text": "text",
          "actions": [
            {
              "type": "link",
              "link": {
                "text": "text"
              }
            }
          ],
          "attachments": [
            {
              "mediaUrl": "https://example.com",
              "filename": "text"
            }
          ],
          "metadata": {
            "telegram": {
              "parseMode": "Markdown"
            },
            "headers": {},
            "whatsapp": {},
            "line": {
              "emoji": {
                "items": [
                  {
                    "index": 1,
                    "productId": "text",
                    "emojiId": "text"
                  }
                ]
              }
            }
          }
        }
      }
    }
  ]
}

OK

Retrieve list of messages of a workspace

List messages by workspace ID

It retrieves a list of messages from a given workspace ID

get

/workspaces/{workspaceId}/channels/messages

Authorizations

useraccessKey

Path parameters

workspaceIdstring uuidrequired

The ID of the workspace

Query parameters

limitinteger

Limits the number of results to return

channelIdstring[]

The ID for a channel

pageTokenstring

Pagination token that keeps of track of the current position in the list

reverseboolean

Order in which to retrieve the results

platformany of

Filter based on platform name

directionenum

Options: incoming, outgoing

idstring uuid[]

messageTypeenum[]

statusenum[]

startAtstring date-time

Start date for the query

endAtstring date-time

End date for the query

fromstring[]

sender identifier for the message

tostring[]

recipient identifier for the message

failureCodeinteger[]

failureSourceCodestring[]

failureSourceNamestring[]

countryCodestring[]

tagstring[]

Filter based on tag

emailSubjectstring

Full text search on email subject

Responses

text/csvapplication/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/workspaces/{workspaceId}/channels/messages' \
  --header 'Authorization: Bearer jwt'

200

404

422

200

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "channelId": "123e4567-e89b-12d3-a456-426614174000",
      "meta": {
        "extraInformation": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "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",
              "quantity": 1,
              "price": {
                "amount": 1,
                "exponent": 1,
                "currencyCode": "text"
              }
            }
          ]
        },
        "referredProduct": {
          "externalCatalogId": "text",
          "externalProductId": "text"
        },
        "email": {
          "subject": "text",
          "headers": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "from": {
            "username": "text",
            "displayName": "text"
          }
        },
        "navigatorId": "123e4567-e89b-12d3-a456-426614174000",
        "navigatorMessageId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "reference": "text",
      "parts": [
        {
          "platformReference": "text"
        }
      ],
      "status": "accepted",
      "reason": "text",
      "direction": "incoming",
      "replyTo": {
        "id": "text",
        "order": 1,
        "type": "message"
      },
      "lastStatusAt": "2025-02-18T22:45:19.713Z",
      "createdAt": "2025-02-18T22:45:19.713Z",
      "updatedAt": "2025-02-18T22:45:19.713Z",
      "failure": {
        "code": 1,
        "source": {
          "code": "text",
          "name": "text"
        }
      },
      "tags": [
        "text"
      ],
      "shortLinks": {
        "domain": "text"
      },
      "scheduledFor": "2025-02-18T22:45:19.713Z",
      "details": "text",
      "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"
          }
        }
      },
      "body": {
        "type": "text",
        "text": {
          "text": "text",
          "actions": [
            {
              "type": "link",
              "link": {
                "text": "text",
                "url": "https://example.com"
              }
            }
          ],
          "attachments": [
            {
              "mediaUrl": "https://example.com",
              "filename": "text",
              "inline": true
            }
          ],
          "metadata": {
            "subject": "text",
            "headers": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "whatsapp": {
              "previewUrl": true
            },
            "line": {
              "emoji": {
                "items": [
                  {
                    "index": 1,
                    "productId": "text",
                    "emojiId": "text",
                    "length": 1
                  }
                ]
              }
            }
          }
        }
      }
    }
  ],
  "nextPageToken": "text"
}

OK

Retrieve a single message

Get message by message ID

Get a channel message

get

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

Authorizations

useraccessKey

Path parameters

workspaceIdstring uuidrequired

The ID of the workspace

messageIdstring uuidrequired

The ID for a message

channelIdstring uuidrequired

The ID for a channel

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/workspaces/{workspaceId}/channels/{channelId}/messages/{messageId}' \
  --header 'Authorization: Bearer jwt'

200

404

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "meta": {
    "referral": {
      "metadata": {}
    },
    "order": {
      "products": [
        {
          "price": {}
        }
      ]
    },
    "referredProduct": {},
    "email": {
      "headers": {},
      "from": {}
    },
    "pushNotifications": {
      "gatewayTypeOverride": "apns"
    },
    "navigatorId": "123e4567-e89b-12d3-a456-426614174000",
    "navigatorMessageId": "123e4567-e89b-12d3-a456-426614174000",
    "flow": {},
    "journey": {},
    "campaign": {},
    "extraInformation": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "reference": "my-own-identifier",
  "parts": [
    {
      "platformReference": "text"
    }
  ],
  "status": "accepted",
  "reason": "text",
  "direction": "incoming",
  "origin": {
    "type": "text",
    "id": "text"
  },
  "replyTo": {
    "type": "message",
    "id": "text",
    "order": 1
  },
  "lastStatusAt": "2025-02-18T22:45:19.713Z",
  "createdAt": "2025-02-18T22:45:19.713Z",
  "updatedAt": "2025-02-18T22:45:19.713Z",
  "failure": {
    "code": 1,
    "description": "Unsupported media type",
    "source": {
      "code": "text",
      "name": "text"
    }
  },
  "tags": [
    "text"
  ],
  "shortLinks": {
    "domain": "text"
  },
  "scheduledFor": "2025-02-18T22:45:19.713Z",
  "details": "text",
  "sender": {
    "connector": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "identifierValue": "text",
      "annotations": {
        "name": "text"
      },
      "types": [
        "text"
      ]
    }
  },
  "receiver": {
    "connector": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "identifierValue": "text",
      "annotations": {
        "name": "text"
      },
      "types": [
        "text"
      ]
    }
  },
  "body": {
    "type": "text",
    "text": {
      "text": "text",
      "actions": [
        {
          "type": "link",
          "link": {
            "text": "text"
          }
        }
      ],
      "attachments": [
        {
          "mediaUrl": "https://example.com",
          "filename": "text"
        }
      ],
      "metadata": {
        "telegram": {
          "parseMode": "Markdown"
        },
        "headers": {},
        "whatsapp": {},
        "line": {
          "emoji": {
            "items": [
              {
                "index": 1,
                "productId": "text",
                "emojiId": "text"
              }
            ]
          }
        }
      }
    }
  }
}

OK

Retrieve all message interactions on a message

List message interactions

List message interactions

get

/workspaces/{workspaceId}/channels/{channelId}/messages/{messageId}/interactions

Authorizations

useraccessKey

Path parameters

workspaceIdstring uuidrequired

The ID of the workspace

messageIdstring uuidrequired

The ID for a message

channelIdstring uuidrequired

The ID for a channel

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/workspaces/{workspaceId}/channels/{channelId}/messages/{messageId}/interactions' \
  --header 'Authorization: Bearer jwt'

200

404

200

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "messageId": "123e4567-e89b-12d3-a456-426614174000",
      "channelId": "123e4567-e89b-12d3-a456-426614174000",
      "platformId": "text",
      "messagePartId": "123e4567-e89b-12d3-a456-426614174000",
      "messageReference": "text",
      "messagePartsCount": 1,
      "createdAt": "2025-02-18T22:45:19.713Z",
      "details": "text",
      "type": "clicked",
      "messageTags": [
        "text"
      ],
      "receiver": {
        "connector": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "identifierValue": "text",
          "annotations": {
            "name": "text"
          },
          "types": [
            "text"
          ]
        }
      },
      "context": {
        "id": "text",
        "type": "text",
        "tags": [
          "text"
        ]
      },
      "metadata": {
        "prefetched": true,
        "link": {
          "name": "text",
          "url": "text"
        },
        "button": {
          "payload": "text"
        },
        "reaction": {
          "emoji": "text",
          "action": "text"
        },
        "conversion": {
          "type": "text",
          "status": "text",
          "method": "text",
          "timestamp": "2025-02-18T22:45:19.713Z"
        },
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

OK

Retrieving media

Retrieve pre-signed media uploads

For media that you have uploaded to be sent in a channels message you can retrieve this as follows

Retrieve media from incoming messages

For media sent to your channel you can download this media from the following endpoint

Get message media

Get media from a message

get

/workspaces/{workspaceId}/messages/{messageId}/media/{fileId}

Authorizations

useraccessKey

Path parameters

workspaceIdstringrequired

messageIdstringrequired

fileIdstringrequired

Query parameters

redirectboolean

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/workspaces/{workspaceId}/messages/{messageId}/media/{fileId}' \
  --header 'Authorization: Bearer jwt'

200

302

400

404

200

No body

Return file location