Pick up responses to messages you have sent. Instead of setting message ID, you should provide a time frame.


Parameter



Description



Required


startA timestamp to start the report from (Format yyyy-mm-dd, Timezone UTC) NO
endA timestamp to end the report at (Format yyyy-mm-dd, Timezone UTC) NO
pagePage number, for pagination NO
maxMaximum results returned per page NO
keywords

Filter if keyword responses should be included. Can be:


‘only’ - only keyword responses will be included‘omit’ - only regular campaign responses will be included


‘both’ - both keyword and campaign responses will be included (default)


NO
include_original

include text of original message


NO


 


Example - get SMS responses for the previous day


curl https://api.transmitsms.com/get-user-sms-responses.json \
  -u 2e24c1cbdd987221e165d543f34b84bf:secret \
  -d start=”2013-01-01 00:00:00”
  -d end=”2013-01-02 00:00:00”

JSON Response



XML Response



{
    page: {
        count: 3,
        number: 1
    },
    total: 5003,
    responses: [
        {
            id: 12345,
            list_id: 567,
            message_id: 4565,
            received_at: "2013-06-21 23:45:11",
            first_name: "Charles",
            last_name: "Gordon",
            msisdn: "61491570156",
            response: "23 Inspiring St, Fairlight"
        }
    ]
}


<?xmlversion="1.0"encoding="UTF-8"?>
<response>
  <page>
    <count>3</count>
    <number>1</number>
  </page>
  <total>5003</total>
  <responses>
    <id>12345</id>
    <list_id>567</list_id>
    <message_id>4565</message_id>
    <received_at>2013-06-21 23:45:11</received_at>
    <first_name>Charles</first_name>
    <last_name>Gordon</last_name>
    <msisdn>61491570156</msisdn>
    <response>23 Inspiring St, Fairlight</response>
  </responses>
</response>