API

➡️ Inbound Messages

{
    "aliasId": "6ee6ce94-9940-44a6-a017-d99ed4d97dd7",
  	"direction": "inbound",
    "type": "text",
    "text": "Hi there, this is a sample inbound text containing credit card info: XXXX XXXX XXXX XXXX",
    "timestamp": "2019-08-24T14:15:22Z",
    "redacted": false
}

{
    "aliasId": "6ee6ce94-9940-44a6-a017-d99ed4d97dd7",
    "direction": "inbound",
    "type": "text-with-attachments",
    "text": "Hi there",
    "attachments": [
        {
            "mimeType": "image/png",
            "fileName": "SampleImage.png",
            "fileUrl": "https://example.com/sample-image.png",
            "dropped": false
        },
        {
            "mimeType": "application/pdf",
            "fileName": "SampleFile.pdf",
            "fileUrl": "",
            "dropped": true
        }
    ],
    "timestamp": "2019-08-24T14:15:22Z",
    "redacted": false
}

{
    "aliasId": "6ee6ce94-9940-44a6-a017-d99ed4d97dd7",
    "direction": "inbound",
    "type": "attachments",
    "attachments": [
        {
            "mimeType": "image/png",
            "fileName": "SampleImage.png",
            "fileUrl": "https://example.com/sample-image.png",
            "dropped": false
        },
        {
            "mimeType": "application/pdf",
            "fileName": "SampleFile.pdf",
            "fileUrl": "",
            "dropped": true
        }
    ],
    "timestamp": "2019-08-24T14:15:22Z"
}

⬅️ Outbound Messages

{
    "aliasId": "6ee6ce94-9940-44a6-a017-d99ed4d97dd7",
    "direction": "inbound",
    "type": "text-with-attachments",
    "text": "Hi there",
    "timestamp": "2019-08-24T14:15:22Z",
    "redacted": false
}

{
    "aliasId": "6ee6ce94-9940-44a6-a017-d99ed4d97dd7",
    "direction": "outbound",
    "type": "text-with-attachments",
    "text": "Hi there",
    "attachments": [
        {
            "mimeType": "image/png",
            "fileName": "SampleImage.png",
            "fileUrl": "https://example.com/sample-image.png",
            "dropped": false
        },
        {
            "mimeType": "application/pdf",
            "fileName": "SampleFile.pdf",
            "fileUrl": "",
            "dropped": true
        }
    ],
    "timestamp": "2019-08-24T14:15:22Z",
    "attemptGwDelivery": true
}

{
    "aliasId": "6ee6ce94-9940-44a6-a017-d99ed4d97dd7",
    "direction": "outbound",
    "type": "attachments",
    "attachments": [
        {
            "mimeType": "image/png",
            "fileName": "SampleImage.png",
            "fileUrl": "https://example.com/sample-image.png",
            "dropped": false
        },
        {
            "mimeType": "application/pdf",
            "fileName": "SampleFile.pdf",
            "fileUrl": "",
            "dropped": true
        }
    ],
    "timestamp": "2019-08-24T14:15:22Z",
    "attemptGwDelivery": true
}

↩️ Announcement

Supports markdown content 😌 Cheat sheet below:

{
    "aliasId": "6ee6ce94-9940-44a6-a017-d99ed4d97dd7",
    "direction": "announcement",
    "type": "text",
    "text": "Sample **Announcement**",
    "timestamp": "2019-08-24T14:15:22Z"
}

Markdown Cheat Sheet:

Formatting	Synax
Bold	Embed within double star symbols (**)
Italics	Embed within single underscore symbols (_)