Retrieve details for a bulk send out - campaign

You can retrieve the details of a specific bulk send out - campaign by its tracking id.

RESPONSE PARAMETERS

trackingId

The tracking id used to identify the campaign.

createdAt

The date that this resource was created.

type

The service type of the campaign.

scheduledDate

The time the campaign is scheduled to run.

campaignName

The name of the campaign.

from

The sender of the message.

to

The phone numbers the message is about to be sent to.

body

The message you sent.

state

The state of the campaign.

statuses

Defines the number of SMS per message status. Either, Queued, Sent, Unsent, Failed, Delivered, Undelivered. For more details check here

smsAnalysis

The data analysis the this SMS.

smsAnalysis.contacts

The details for each contact. The key refers to the id of the contact given in the request.

smsAnalysis.contacts.recipient

The mobile phone that corresponds to the given contact id.

smsAnalysis.contacts.recipientCountry

The country that corresponds to the given contact id.

smsAnalysis.contacts.blacklisted

Indicates if the contact is in the SMS blacklist. If true the contact will be excluded from the request.

smsAnalysis.numberOfRecipients

The total number of recipients.

smsAnalysis.recipientCountries

The country that each mobile belongs to. The key refers to the mobile of the recipients request property

smsAnalysis.recipientsPerCountry

The total recipients per country. The key refers to the country.

smsAnalysis.recipientsPerGroup

For 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.totalInGroups

The 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.bodyAnalysis

The analysis for the body of the SMS.

smsAnalysis.bodyAnalysis.characters

The total number of characters of message body.

smsAnalysis.bodyAnalysis.parts

The number of actual SMS that will be sent.

smsAnalysis.bodyAnalysis.transcode

Contains information for the transcoded body of the SMS message. This will be available only if the message can be transcoded.

smsAnalysis.bodyAnalysis.transcode.message

The transcoded message of the original unicode message.

smsAnalysis.bodyAnalysis.transcode.parts

The number of the parts of the transcoded message.

smsAnalysis.bodyAnalysis.unicode

Indicates if the body contains unicode characters.

smsAnalysis.bodyAnalysis.unsupportedGSMCharacters

Which characters caused the message to be considered as unicode.

flash

Indicates if the message is a flash SMS.

respectQuietHours

Indicates if the SMS should respect the quiet hours.

campaignCallback

Defines the notification callback information for the progress of the SMS campaign.

campaignCallback.url

The URL that Routee will POST to, each time your campaign status changes to one of the following: Scheduled, Queued, Sent, Running, Finished, or Failed.
For more details check here

campaignCallback.strategy

When the URL will be called. Two possible values: on every status change (OnChange) or when a final status arrives (OnCompletion).

reminder

Defines the recipients that will receive a test SMS before and/or after the actual SMS is sent.

reminder.minutesAfter

The minutes after the scheduled date (that the SMS will be sent) that the test SMS will be sent.

reminder.minutesBefore

The minutes before the scheduled date (that the SMS will be sent) that the test SMS will be sent.

reminder.to

The recipients that will get the test SMS before and/or after the campaign will start. Must be a list with valid mobile numbers starting with “ + ” and the country code.

contacts

The contacts in the account selected as recipients.

groups

The groups of contacts in the account selected as recipients.

fallbackValues

Defines the default values when the SMS has labels, in case a contact does not contain any of these labels. The key refers to the label name.

ERROR CODES

STATUS

CODE

DESCRIPTION

404

404009001

The campaign with the given tracking id doesn't exist.

Language