XML API Specification V 2.4.6 - Clickatell

XML API Specification V2.4.9
1. Content
1. Content ................................................................................................................................................. 2
2. Change history ..................................................................................................................................... 3
3. Overview ............................................................................................................................................... 3
4. Introduction ........................................................................................................................................... 4
5. Getting started ...................................................................................................................................... 4
5. Basic XML structure ............................................................................................................................. 6
6. Submitting the XML to the gateway...................................................................................................... 6
7. Basic commands (tags)........................................................................................................................ 6
7.1 Authentication and session ids ....................................................................................................... 6
7.2 Ping ................................................................................................................................................. 7
7.3 Send a message ............................................................................................................................. 7
7.4 Query a message ........................................................................................................................... 8
8. Message parameters (tags) ................................................................................................................. 9
8.1 Table of parameters ....................................................................................................................... 9
8.2 Message parameters in detail ...................................................................................................... 11
9. Additional Commands (tags) .............................................................................................................. 19
9.1 Delete/Stop message ................................................................................................................... 19
9.2 Query balance .............................................................................................................................. 19
9.3 Coverage query ............................................................................................................................ 20
9.4 MMS Push .................................................................................................................................... 20
9.5 WAP push service indication ........................................................................................................ 21
9.6 Get message charge query .......................................................................................................... 22
9.7 Token (voucher) pay ..................................................................................................................... 23
10. Batch messaging .......................................................................................................................... 23
10.1 Start batch ................................................................................................................................ 23
10.2 Sending messages to existing batch........................................................................................ 24
10.3 Quick send to batch.................................................................................................................. 25
10.4 End batch ................................................................................................................................. 25
11. 8-BIT messaging........................................................................................................................... 26
12. Message examples ....................................................................................................................... 26
12.1 Simple examples ...................................................................................................................... 26
12.2 Batch SMS examples ............................................................................................................... 27
12.3 8-bit SMS examples ................................................................................................................. 28
12.4 Multi- Post MT .......................................................................................................................... 29
13. Appendix A: Error codes ............................................................................................................... 31
14. Appendix B: Message statuses .................................................................................................... 32
15. Appendix C: XML DTD ................................................................................................................. 33
16. Appendix D: XML references ........................................................................................................ 35
16.1 Entity references ...................................................................................................................... 35
16.2 Character references................................................................................................................ 35
17. Terminology .................................................................................................................................. 36
18. Contact details .............................................................................................................................. 36
2
www.clickatell.com