Send Bulk Messages - Campaigns

Routee allows to send messages to multiple recipients/contacts/groups. This is a paid service. For pricing check here

RESPONSE PARAMETERS

KEYDESCRIPTION
trackingIdThe tracking id used to identify the campaign.
createdAtThe date that this resource was created.
typeThe service type of the campaign.
scheduledDateThe time the campaign is scheduled to run.
campaignNameThe name of the campaign.
fromThe sender of the message.
toThe phone numbers the message is about to be sent to.
bodyThe message you sent.
stateThe state of the campaign.
statusesDefines the number of SMS per message status. Either, Queued, Sent, Unsent, Failed, Delivered, Undelivered. Check here for more information
smsAnalysisThe data analysis the this SMS.
smsAnalysis.contactsThe details for each contact. The key refers to the id of the contact given in the request.
smsAnalysis.contacts.recipientThe mobile phone that corresponds to the given contact id.
smsAnalysis.contacts.recipientCountryThe country that corresponds to the given contact id.
smsAnalysis.contacts.blacklistedIndicates if the contact is in the blacklist. If true the contact will be excluded from the request.
smsAnalysis.numberOfRecipientsThe total number of recipients.
smsAnalysis.recipientCountriesThe country that each mobile belongs to. The key refers to the mobile of the recipients request property
smsAnalysis.recipientsPerCountryThe total recipients per country. The key refers to the country.
smsAnalysis.recipientsPerGroupFor each group the number of recipients that it contains without the blacklisted contacts (in SMS blacklist). The key refers to the group given in the group request property.
smsAnalysis.totalInGroupsThe total number of recipients in all given groups excluding the ones already specified (in contacts and recipients request property) as well as the ones that are blacklisted.
smsAnalysis.bodyAnalysisThe analysis for the body of the SMS.
smsAnalysis.bodyAnalysis.charactersThe total number of characters of message body.
smsAnalysis.bodyAnalysis.partsThe number of actual SMS that will be sent.
smsAnalysis.bodyAnalysis.transcodeContains information for the transcoded body of the SMS message. This will be available only if the message can be transcoded.
smsAnalysis.bodyAnalysis.transcode.messageThe transcoded message of the original unicode message.
smsAnalysis.bodyAnalysis.transcode.partsThe number of the parts of the transcoded message.
smsAnalysis.bodyAnalysis.unicodeIndicates if the body contains unicode characters.
smsAnalysis.bodyAnalysis.unsupportedGSMCharactersWhich characters caused the message to be considered as unicode.
flashIndicates if the message is a flash SMS.
respectQuietHoursIndicates if the SMS should respect the quiet hours.
callbackDefines the notification callback information for an individual SMS message
callback.urlThe URL that Routee will POST to, each time your message status changes to one of the following: Queued, Failed, Sent, Unsent, Delivered, or Network Error. When Routee POSTs back to your service, a HTTP 200 OK response must be returned. If Routee doesn't receive a 200 OK response, it will try to POST again (up to 5 times)
callback.strategyWhen the URL will be called. Two possible values: on every status change (OnChange) or when a final status arrives (OnCompletion)
campaignCallbackDefines the notification callback information for the progress of the SMS campaign.
campaignCallback.urlThe URL that Routee will POST to, each time your campaign status changes to one of the following: Scheduled, Queued, Sent, Running, Finished, or Failed. When Routee POSTs back to your service, a HTTP 200 OK response must be returned. If Routee doesn't receive a 200 OK response, it will try to POST again (up to 5 times).
campaignCallback.strategyWhen the URL will be called. Two possible values: on every status change (OnChange) or when a final status arrives (OnCompletion).
reminderDefines the recipients that will receive a test SMS before the actual SMS is sent.
reminder.minutesBeforeThe minutes before the scheduled date (that the SMS will be sent) for the test SMS to be sent.
reminder.toThe recipients that will get the test SMS before the campaign will start. Must be a list with valid mobile numbers starting with “ + ” and the country code.
contactsThe contacts in the account selected as recipients.
groupsThe groups of contacts in the account selected as recipients.
fallbackValuesDefines the default values in case a contact does not contain any of the selected personalized labels. The key refers to the label name.
ttlThe duration in minutes the delivery of an SMS will be attempted. If the SMS is not delivered within the validity period, then the SMS status will be "Undelivered", with "detailedStatus": "Expired"
errors.codeThe code of error
errors.developerMessageMessage of error
errors.propertyThe numbers of invalid recipients

ERROR CODES

STATUSCODEDESCRIPTION
400400001009You don't have enough balance to send the campaign.
400400005000The sender id is invalid (errorCode: 002), or you haven't specified any recipients (errorCode: 004) or the recipient numbers are not valid mobile numbers (errorCode: 008).

Keep in mind that If your recipients (either in "to", "groups" or "contacts" array) contain at least one invalid number, then the bulk send out will not be dispatched.
Try to exclude the invalid recipients in order your campaign to be sent.
409409009003Your account already has a campaign with the given name.
400400009004Your campaign has no recipients. Your groups might be empty or all contacts might be blacklisted.
404404002001A contact id does not exist.
Language