All Collections
API and Integration
2-Way SMS using SOAP API
2-Way SMS using SOAP API

How to send a 2-way SMS using SOAP API

Amy avatar
Written by Amy
Updated over a week ago

To send a 2-way SMS, call the method api2WaySendSms.

Parameter

Description

Presence

ticket

The ticket used to validate this request returned from a call to apiValidateLogin

Mandatory

sms_from

If replies are to be pushed back to a URL, the parameter should be set to ‘api2way’
If replies are to be pushed back to the main account email address, the parameter should be set to ‘reply2carl’

Mandatory

sms_to

MSIDSN of the recipient that the message will be sent to. Eg: 61447100250 (Do not use + before the country code)

Mandatory

msg_content

Message to be sent

Mandatory

msg_type

Depreciated. Should be set to ‘text’

Mandatory

userfield

A user-defined string will be posted back to the server to help determine which message is being replied to

Mandatory

unicode

Depreciated. Should be set to ‘0’

Mandatory

schedule

To schedule the message to be sent some
time/date in the future. Leave blank to send immediately. Time/Date format is:
"yyyy‐mm‐dd hh:mm:ss"

Mandatory

Send 2-Way SMS Response

SOAP Response from SMSGlobal contains the following:
dest: The number the message was sent to
msgid: SMSGlobal Message Id
bid: Unused

Example

Below is an example 2-Way Sms Request when using the SOAP interface.
Ticket: 88c1234b0abfee64841c2b3e11225353
sms_from: api2way
sms_to: 61447100250
msg_content: Hello World
msg_type: text
userfield: abc123
unicode: 0
schedule:


An example of a SOAP 2-way request:

<?xml version='1.0' ?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV=
"http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<ns1:api2WaySendSms xmlns:ns1=''>
<ticket>
88c1234b0abfee64841c2b3e11225353
</ticket>
<sms_from>
api2way
</sms_from>
<sms_to>
61447100250
</sms_to>
<msg_content>
Hello World
</msg_content>
<msg_type>
text
</msg_type>
<userfield>
abc123
</userfield>
<unicode>
0
</unicode>
<schedule>
</schedule>
</ns1:api2WaySendSms>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Did this answer your question?