Deleting Invalid Keyword Response Messages
In SMS campaigns, an invalid keyword response message will be sent to originating mobile numbers if the incoming message contains an invalid keyword or a keyword that is inactive or is not defined for the code. These Invalid keyword response messages are found in the Responsys user interface under Campaign management > SMS invalid keyword message.
Use this interface to delete existing invalid keyword response messages.
Note: The Responsys Advanced API is generally available for all Responsys customers.
Service URL:
/rest/api/sms/v1.3/invalidkeywordresponse/delete
Required Path Parameters:
N/A
Request Method:
POST
Request Header:
Authorization=<AUTH_TOKEN>
Content-Type=application/json
Request Body Properties:
| Parameter name | Required? | Data Type | Description |
|---|---|---|---|
isLongCode
|
No | Boolean | Whether or not the keyword is a long code. Learn more. |
code
|
Yes | String | The keyword code to update. Refer to the online help to learn more. |
countryCode
|
Yes | String | The country code for the keyword. |
Invalid_KW_Response_msg
|
No | String | The response message to send to the mobile recipient when an invalid keyword is specified. |
dlt_template_ID
|
No | String | The DLT template ID for the keyword. Required if sending SMS to country codes in India. |
Sample Request Body
{
"isLongCode": true,
"code": "500050005000",
"countryCode": null,
"dltTemplateId": null,
"invalidKeywordResponse": "Invalid 5005. Sorry, we did not understand your response. Please try again with the correct keyword"
}
Sample Response Body
A successful response will echo the request body, with the addition of the success property which indicates whether the delete was successful.
{
"accountId": 1421,
"code": "500050005000",
"invalidKeywordResponse": "Invalid 5005. Sorry, we did not understand your response. Please try again with the correct keyword",
"encodingType": "GSM",
"longCode": true,
"success": true
}