Request a message dispatch
It creates a multi-channel and multi-language message for multiple recipients. Please note that there is a limit of 1000 recipients per request.
Body
Required
Dispatch request payload
-
Optional scheduled date and time for a deferred message delivery in UTC format (e.g., 'yyyy-MM-dd'T'HH:mm:ss'Z'). Must be in the future and no more than 365 days from the current date. If null, the message will be sent immediately and cannot be cancelled. A scheduled dispatch can be cancelled only up to 5 minutes before the specified date and time.
-
Set true if you want to fix msisdn numbers with the countryCodeDefault. If numbers in the recipient list don't have interational prefix, set this flag to true otherwise recipients with invalid numbers will be skipped.
-
Required if countryCodeFixEnabled is true
-
Optional custom metadata linked to the dispatch. Sent as 'dispatchMetadata' parameter of "Message Status Update" webhook.
curl \
--request POST 'https://api.nifteem.com/v1/api/dispatch' \
--header "X-API-Key: $API_KEY" \
--header "Content-Type: application/json" \
--data '{"message":{"translations":{"en":{"contents":[{"text":{"body":"Hello {{firstname}}! This is a simple SMS test."}}]}},"languageDefault":"en"},"channels":{"sms":{"senderId":"{{SMS_SENDER_ID}}"}},"recipients":[{"placeholders":{"firstname":"Mark"},"recipientIdentifiers":[{"channelIdType":"MSISDN","channelIdentifier":"+39347XXXXXXX"}]},{"placeholders":{"firstname":"Robert"},"recipientIdentifiers":[{"channelIdType":"MSISDN","channelIdentifier":"+39349XXXXXXX"}]}],"countryCodeDefault":"IT","countryCodeFixEnabled":true}'{
"message": {
"translations": {
"en": {
"contents": [
{
"text": {
"body": "Hello {{firstname}}! This is a simple SMS test."
}
}
]
}
},
"languageDefault": "en"
},
"channels": {
"sms": {
"senderId": "{{SMS_SENDER_ID}}"
}
},
"recipients": [
{
"placeholders": {
"firstname": "Mark"
},
"recipientIdentifiers": [
{
"channelIdType": "MSISDN",
"channelIdentifier": "+39347XXXXXXX"
}
]
},
{
"placeholders": {
"firstname": "Robert"
},
"recipientIdentifiers": [
{
"channelIdType": "MSISDN",
"channelIdentifier": "+39349XXXXXXX"
}
]
}
],
"countryCodeDefault": "IT",
"countryCodeFixEnabled": true
}{
"message": {
"translations": {
"en": {
"contents": [
{
"text": {
"body": "Hello {{firstname}}! This is a simple RCS with SMS fallback test."
}
}
]
}
},
"languageDefault": "en"
},
"channels": {
"rcs": {
"senderId": "{{RCS_SENDER_ID}}"
},
"sms": {
"senderId": "{{SMS_SENDER_ID}}"
}
},
"recipients": [
{
"placeholders": {
"firstname": "Mark"
},
"recipientIdentifiers": [
{
"channelIdType": "MSISDN",
"channelIdentifier": "+39347XXXXXXX"
}
]
},
{
"placeholders": {
"firstname": "Robert"
},
"recipientIdentifiers": [
{
"channelIdType": "MSISDN",
"channelIdentifier": "+39349XXXXXXX"
}
]
}
]
}{
"message": {
"translations": {
"en": {
"contents": [
{
"text": {
"body": "Hello {{firstname}}! this is a reminder for your appointment on {{date}} at {{time}}. Call us at +39 02 000XXXXX"
}
}
],
"channelContents": {
"rcs": [
{
"text": {
"body": "Hello {{firstname}}, this is a reminder for your appointment on {{date}} at {{time}} with {{doctorname}} at {{location}}. Please arrive 10 minutes early. Need to reschedule or have questions? Call us at +39 02 000XXXXX . See you soon!"
}
}
]
}
}
},
"languageDefault": "en"
},
"channels": {
"rcs": {
"senderId": "{{RCS_SENDER_ID}}"
},
"sms": {
"senderId": "{{SMS_SENDER_ID}}"
}
},
"recipients": [
{
"placeholders": {
"date": "14/02/2025",
"time": "14:14",
"location": "Via Roma, 48 - Milano",
"firstname": "Mark",
"doctorname": "Dr. John Smith"
},
"recipientIdentifiers": [
{
"channelIdType": "MSISDN",
"channelIdentifier": "+39347XXXXXXX"
}
]
}
]
}{
"template": {
"id": "0K2QG0XXXXXX"
},
"recipients": [
{
"placeholders": {
"date": "31/01/2025",
"time": "14:14",
"firstname": "Mark"
},
"recipientIdentifiers": [
{
"channelIdType": "MSISDN",
"channelIdentifier": "39347XXXXXXX"
}
]
}
],
"countryCodeDefault": "IT",
"countryCodeFixEnabled": true
}{
"dispatchId": "0K0FHMEJ4DPFZ",
"scheduleDate": "2025-03-05T12:00:10Z",
"rejectedRecipients": []
}