Knowledge Base

Important Notice

SMS API 2.1 is released in 'beta' and any feedback/errors should be forwarded to Technical Support.

Broadcast


API Response

If the routine was executed successfully, the body of our response will be in XML containing several pieces of information, as described here:

<result>
<broadcastID>The allocated broadcastID</broadcastID>
<recipients>The total number of recipients</recipients>
<balanceType>The type of balance used</balanceType>
<credits>The total number of credits used</credits>
<balance>The new balance following the broadcast</balance>
<neglected>The messageID's of those SMS which were neglected</neglected>
</result>

The messageID allocated to an individual recipient is the sequential position in which the recipient came. smsID's are made by combining broadcastID's and messageID's and so applications that need to allocated smsID's to individual messages should pair the broadcastID, e.g. MT0017295001, with the sequential position of the SMS. For example, if there were three recipients for a message, the smsID's would be MT0017295001-1 for the first one, MT0017295001-2 for the second and MT0017295001-3 for the third.

However, this does not apply to messages which exceed that maximum length and must therefore be split up as part of a long messaging procedure. Although we will aim to solve this issue in future releases, the only way to know the messageID for the different segments of a long message is to split them up before sending them.