Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:loc="http://www.csapi.org/schema/parlayx/sms/send/v2_3/local">
        <soapenv:Header/>
        <soapenv:Body>
            <loc:sendSms>
                <!--1 or more repetitions:-->
                <loc:addresses>tel:16048183614</loc:addresses>
                <loc:senderName></loc:senderName>
                <loc:message>Message 1 on 12-01-2012</loc:message>
                <!-- Optional -->
                <loc:receiptRequest>
                    <endpoint>http://yourendpoint.com/SmsNotificationService/services/SmsNotification</endpoint>
                    <interfaceName>SmsNotification</interfaceName>
                    <correlator>1010</correlator>
                </loc:receiptRequest>
            </loc:sendSms>
        </soapenv:Body>
    </soapenv:Envelope>

loc:address -  Telephone number of the subscriber. You can send a message to up to 10 subscribers in a single request.

loc:senderName -  Short code or name that you want the subscriber to see as being the sender. Leave this blank for now; normally you would register a name with TELUS to use this.

loc:message -  Message body that you want to send 

loc:receiptRequest -  Optional, request that the service send you a delivery receipt

    endpoint -  The URL to which to send the delivery receipt

    interfaceName -  Optional, name of your interface

    correlator - ID used to track this SMS message

 Response

The response you receive will look something like this:

    <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
        <soap:Body>
            <ns2:sendSmsResponse xmlns:ns2=http://www.csapi.org/schema/parlayx/sms/send/v2_3/local xmlns:ns3="http://www.csapi.org/schema/parlayx/common/v2_1">
                <ns2:result>267417690</ns2:result>
            </ns2:sendSmsResponse>
        </soap:Body>
    </soap:Envelope>

result -  String reference that can be used to retrieve additional message delivery information from getSmsDeliveryStatus method, detailed below.

Delivery Receipt

And if you asked for a delivery receipt, you will also get the following response when delivery is confirmed:
    <?xml version="1.0" encoding="UTF-8"?>
    <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
        <soap:Body>
            <ns2:notifySmsDeliveryReceipt xmlns:ns2="http://www.csapi.org/schema/parlayx/sms/notification/v2_2/local" xmlns:ns3="http://www.csapi.org/schema/parlayx/common/v2_1">
                <ns2:correlator>1010</ns2:correlator>
                <ns2:deliveryStatus>
                    <address>tel:16048183614</address>
                    <deliveryStatus>DeliveredToTerminal</deliveryStatus>
                </ns2:deliveryStatus>
            </ns2:notifySmsDeliveryReceipt>
        </soap:Body>
    </soap:Envelope>

correlator -  Matches the correlator value specified in your receiptRequest

address -  Phone number that the message was sent to

deliveryStatus -  Status of the message, indicating whether your target was confirmed to have received the message or not

Get SMS Delivery Status SOAP Service

This service is to be used in conjunction with the Send SMS service above. If you want to get further information out of your response from the Send SMS service, you can use the getSMSDeliveryStatus method. Your request would look like this:

Request

< soapenv:Envelope xmlns:soapenv = "http://schemas.xmlsoap.org/soap/envelope/"
    < soapenv:Header />
    < soapenv:Body >
       < loc:getSmsDeliveryStatus >
          < loc:requestIdentifier >267417690</ loc:requestIdentifier >
       </ loc:getSmsDeliveryStatus >
    </ soapenv:Body >
</ soapenv:Envelope >
requestIdentifier -  Matches the result value from a previous send SMS response

Response

Then, the response will look like this:
< soap:Envelope xmlns:soap = "http://schemas.xmlsoap.org/soap/envelope/" >
    < soap:Body >
       < ns2:getSmsDeliveryStatusResponse xmlns:ns2 = "http://www.csapi.org/schema/parlayx/sms/send/v2_3/local"
          < ns2:result >
             < address >tel:16048183614</ address >
             < deliveryStatus >DeliveredToTerminal</ deliveryStatus >
          </ ns2:result >
       </ ns2:getSmsDeliveryStatusResponse >
    </ soap:Body >
</ soap:Envelope >
This looks a lot like the delivery receipt, except that there is no correlator.
Image Added