Two Way SMS assistance

Hi,

I have successfully generated an sms using a SOAP UI client calling the AP below is the source code:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Header>
        <Request xmlns="http://ws.easylink.com/RequestResponse/2011/01" xmlns:ns2="http://ws.easylink.com/JobSubmit/2011/01">
            <ReceiverKey>https://messaging.easylink.com/soap/sync</ReceiverKey>
            <Authentication>
                <XDDSAuth>
                    <RequesterID>XXXXX</RequesterID>
                    <Password>XXXXX</Password>
                </XDDSAuth>
            </Authentication>
        </Request>
    </S:Header>
    <S:Body>
        <ns2:JobSubmitRequest xmlns="http://ws.easylink.com/RequestResponse/2011/01" xmlns:ns2="http://ws.easylink.com/JobSubmit/2011/01">
            <ns2:DocumentSet/>
            <ns2:Message>
                <ns2:JobOptions>
                    <ns2:SmsOptions/>
                </ns2:JobOptions>
                <ns2:Destinations>
                    <ns2:Sms>
                        <ns2:Phone>0419203387</ns2:Phone>
                    </ns2:Sms>
                </ns2:Destinations>
                <ns2:Reports>
                    <ns2:DeliveryReport>
                        <ns2:DeliveryReportType>detail</ns2:DeliveryReportType>
                    </ns2:DeliveryReport>
                </ns2:Reports>
                <ns2:Contents>
                    <ns2:Part>
                        <ns2:Document>
                            <ns2:DocType>text</ns2:DocType>
                            <ns2:DocData format="text">This is a reminder for your dental appointment at XYZ clinic on 1234 to confirm your attendance please reply Yes to confirm No to cancel. </ns2:DocData>
                        </ns2:Document>
                    </ns2:Part>
                </ns2:Contents>
            </ns2:Message>
        </ns2:JobSubmitRequest>
    </S:Body>
</S:Envelope>

What I am looking to achieve is to send the above SMS message via the API (already tested OK) and then use the API and make a web services (SOAP) call to retreive the sender responses as per MyPortal Reports > data retreival function.

I cannot determine the best approach to achiveve this from the documentation.

Thanks in advance.

Find more posts tagged with

Comments

skamens

When SMS responses (known as "mobile-originated", or MO messages) are received by our system and stored for retrieval, they are placed into a database called the Forms database. As a result, the API function to use to retrieve SMS data is called FormData (https://apiforums.easylink.com/emapidocs/26/FormData/index.html).

However, I'm afraid getting set up for 2 way SMS is not so simple. A reply to an SMS message has no connection to the original message that was sent. The only way the system can route an inbound SMS message to a database for you to retrieve it is if you have an SMS short code that is specific to your account.

If you are in the process of getting a short code and you wish to begin development of the retrieval functionality, we can work with you so you can simulate responses by inserting them into the database yourself.

I would recommend discussing your plans with your account team (sales representative and sales engineer) so you are comfortable with the way SMS works on our system.

John Garwood

Hi,

Please see below sending a FormDataRequest:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Header>
        <Request xmlns="http://ws.easylink.com/RequestResponse/2011/01">
            <ReceiverKey>https://messaging.easylink.com/soap/sync</ReceiverKey>
            <Authentication>
                <XDDSAuth>
                    <RequesterID>XXXXX</RequesterID>
                    <Password>xxxxxx</Password>
                </XDDSAuth>
            </Authentication>
        </Request>
    </S:Header>


   <S:Body>
     <FormDataRequest xmlns="http://ws.easylink.com/FormData/2011/01">


         <Domain>MR</Domain>

         <NumToRetrieve>5</NumToRetrieve>

         <ResponseFilter>
            <All action="leaveAsItIs"/>
         </ResponseFilter>

         <CampaignName>test</CampaignName>
         <FormName>SMS_61408223137</FormName>

      </FormDataRequest>

   </S:Body>
</S:Envelope>

1. Can you please advise exatly what the CampaignName is?

2. The FormName is the same name as what is being generated in my portal > reports

3. Using the dateTime tag, throws back a 'child element is not expected at this point' exception. Any ideas?

Please feel free to add or rewrite the above soap request.

Thanks.

skamens

In answer to your questions:

1. Can you please advise exatly what the CampaignName is?

The database where the SMS responses are stored can be used for multiple different types of forms; it supports the concept of a campaign under which a group of logically connected forms are stored.

For the purpose of handling SMS responses, you should specify the CampaignName as the same as the FormName (SMS_61408223137).

2. The FormName is the same name as what is being generated in my portal > reports

Yes, this is what I would expect you to use.

3. Using the dateTime tag, throws back a 'child element is not expected at this point' exception. Any ideas?

The sample you provided doesn't show how you tried to use the date/time tags, but is it possible that you didn't wrap the date/time requests with the DateRange element? It would look something like this:

</DateRange>

If you'll let us know what user ID you are using for your request (you don't need to provide the password), we should be able to verify that the right things are in place for you. You can send it out-of-bad if you'd like.