post https://connect.routee.net/sms/analyze/campaign
Analyzing a bulk sendout is useful when the user needs information about the send out before actually sending it.
RESPONSE PARAMETERS
| KEY | DESCRIPTION |
|---|---|
| contacts | The details for each contact. The key refers to the id of the contact given in the request. |
| contacts.recipient | The mobile phone that corresponds to the given contact id. |
| smsAnalysis.contacts.recipientCountry | The country that corresponds to the given contact id. |
| contacts.blacklisted | Indicates if the contact is in the SMS blacklist. If true the contact will be excluded from the request. |
| numberOfRecipients | The total number of recipients. |
| recipientCountries | The country that each mobile belongs to. The key refers to the mobile of the recipients request property. |
| recipientsPerCountry | The total recipients per country. The key refers to the country. |
| 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. |
| 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. |
| bodyAnalysis | The analysis for the body of the SMS. |
| bodyAnalysis.characters | The total number of characters of message body. |
| bodyAnalysis.parts | The number of actual SMS that will be sent. |
| bodyAnalysis.transcode | Contains information for the transcoded body of the sms message. This will be available only if the message can be transcoded. |
| bodyAnalysis.transcode.message | The transcoded message of the original unicode message. |
| bodyAnalysis.transcode.parts | The number of the parts of the transcoded message. |
| bodyAnalysis.unicode | Indicates if the body contains unicode characters. |
| bodyAnalysis.unsupportedGSMCharacters | Which characters caused the message to be considered as unicode. |
| errors.code | The code of error |
| errors.developerMessage | Message of error |
| errors.property | The numbers of invalid recipients |
ERROR CODES
| STATUS | CODE | DESCRIPTION |
|---|---|---|
| 400 | 400001009 | You don't have enough balance to send the campaign. |
| 400 | 400005000 | In case you haven't specified any recipients or the sender is invalid. |
| 409 | 409009003 | Your account already has a campaign with the given name. |
| 400 | 400009004 | Your campaign has no recipients. Your groups might be empty or all contacts might be blacklisted. |
| 404 | 404002001 | A contact id does not exist. |