Sending Messages

Rather than simply returning templates, the CTM can also send email and SMS messages. This is done using the goss.CommsTemplateManager.sendMessage end point.

Limits

All mail servers put limits on the total size of the emails they will accept. In AWS (our main hosting provider) the size limit is 40MB after encoding for the complete email, including embedded images and attachments.

There is also a limit of 50 recipients for a single message (combined "to", "cc" and "bcc"). When sending emails you should be emailing each recipient individually. The use cases for recipients having a message with the same message-id are limited to situations in which the recipients are expected to interact with the message as a group, for example, recipients using reply-all to the email and having a resulting email conversation.

Parameters

Required parameters are listed first.

Examples

Full Params

{
    "data": {
        "endpoint": {
            "params": {},
            "name": "Abc"
        },
        "src": {}
    },
    "recipients": [{
        "sendSMS": false,
        "emailType": "TO,",
        "sendEmail": false,
        "name": "Abc",
        "address": "user@example.com",
        "mobileNumber": "Abc"
    }],
    "template": {
        "application": "Abc",
        "template": "Abc",
        "lang": "Abc",
        "variation": "Abc"
    },
    "from": {
        "name": "Abc",
        "address": "user@example.com"
    },
    "attachments": {
        "urls": [{
            "url": "Abc",
            "name": "Abc"
        }],
        "files": [{
            "path": "Abc",
            "name": "Abc"
        }],
        "mediaItems": [{
            "id": 123,
            "name": "Abc",
            "component": "Abc"
        }],
        "fileStoreItems": [{
            "reference": "Abc"
        }],
        "pdf": {
            "template": "Abc",
            "name": "Abc"
        }
    },
    "overrides": {
        "sms": {
            "body": "Abc"
        },
        "email": {
            "subject": "Abc",
            "body": "Abc"
        }
    }
}

Return Schema