25.01.2015 Views

XML API Specification V 2.4.6 - Clickatell

XML API Specification V 2.4.6 - Clickatell

XML API Specification V 2.4.6 - Clickatell

SHOW MORE
SHOW LESS

You also want an ePaper? Increase the reach of your titles

YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.

<strong>XML</strong> <strong>API</strong> <strong>Specification</strong> V2.4.9<br />

This command can take all the parameters of sendmsg, with the addition of a template, and the exception of<br />

both the destination address and the text fields. It must be used before either the senditem or quicksend<br />

command.<br />

Name:<br />

startBatch<br />

Parameters: session_id Required<br />

template<br />

Required<br />

callback<br />

[Optional]<br />

cliMsgId<br />

[Optional]<br />

concat<br />

[Optional]<br />

deliv_ack<br />

[Optional]<br />

deliv_time<br />

[Optional]<br />

escalate<br />

[Optional]<br />

from<br />

[Optional]<br />

max_credits<br />

[Optional]<br />

msg_type<br />

[Optional]<br />

queue<br />

[Optional]<br />

req_feat<br />

[Optional]<br />

udh<br />

[Optional]<br />

unicode<br />

[Optional]<br />

validity<br />

[Optional]<br />

sequence_no<br />

[Optional]<br />

Name:<br />

ResponseVals:<br />

startBatchResp<br />

batch_id<br />

or<br />

fault<br />

sequence_no<br />

[If set]<br />

10.2 Sending messages to existing batch<br />

Send a message to a batch passing the destination mobile number and optional field replacement values. The<br />

fields 1-N that you defined in the startbatch command are used to optionally personalise the message.<br />

Name:<br />

sendItem<br />

Parameters: session_id Required<br />

batch_id<br />

Required<br />

to<br />

Required<br />

fields<br />

[Optional]<br />

sequence_no<br />

[Optional]<br />

Set the field values as per the template set up in startbatch command tag. This tag can only be used within<br />

sendItem command tag<br />

Name:<br />

fields<br />

Parameters: field1 Required<br />

field2<br />

[Optional]<br />

field3<br />

[Optional]<br />

field4<br />

[Optional]<br />

field5<br />

[Optional]<br />

field6<br />

[Optional]<br />

24<br />

www.clickatell.com

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!