KUkudosity
SMS

Get Responses by MessageID, Keyword or Mobile

Responses to your outgoing messages can be picked up in a few different ways. Your DLR Callback URL in your account settings, is the default URL we post incoming DLR's to. You can also set the DLR Callback URL separately for individual messages, using a parameter on the send-sms call. You can also poll the following endpoints for responses.

post/get-sms-responses.json

Request

  • Base URL
    https://api.transmitsms.com
  • Auth
    HTTP basic

Request body application/x-www-form-urlencoded

message_idinteger required

Numeric ID assigned to the message sent. Required if keyword_id or keyword is not set.

startstring date-time

A date within the last 12 months to start the report from. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. If start and end date not supplied, will get everything from the last 30 days only.

endstring date-time

A date within the last 12 months to end the report at. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. If start and end date not supplied, will get everything from the last 30 days only.

keyword_idinteger required

Numeric ID assigned to the keyword. ID is assigned on creation of keyword in your account. A keyword can be created using add-keyword request. Keyword ID can be returned using the get-keyword request. NOTE A keyword IS NOT a specific string within the message. Required if message_id or keyword not set

keywordstring required

Keyword name. Name is assigned on creation of keyword in your account. A keyword can be created using add-keyword request. Keyword name can be returned using the get-keyword request. NOTE A keyword IS NOT a specific string within the message. Required if message_id or keyword not set

numberinteger required

Filter results by Virtual Mobile Number (VMN). Get responses for messages containing a keyword received on a specific VMN. Numbers can be returned using the get-numbers request. Required if keyword not set

msisdninteger

Filter results by Responder Mobile Number (VMN). Get responses to messages that were from a specific mobile number.

include_originalboolean

Include text of message that reply was sent to.

pageinteger

Page number, for pagination.

maxinteger

Maximum results returned per page.

Response

Successful response

object required

Changes

No recorded changes to this operation across all 2 revisions of this API.