List inbound rules
Inbound SMS rules from Message Settings, such as the STOP rule, in the order ClickSend runs them.
GET https://cotlet.dev/api/v1/clicksend/inbound-rules
read
Returns the rules under Message Settings > SMS/MMS > Inbound Rules in creation order, which is the order ClickSend runs them. Each rule has the dedicated number it applies to, how it matches (Match For), the search term, the action (for example MOVE_CONTACT or AUTO_REPLY) and the list it moves contacts to. An account can have any number of rules, but only 10 matching rules trigger for one incoming message.
Parameters
No parameters.
Request
curl https://cotlet.dev/api/v1/clicksend/inbound-rules \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("clicksend", "list_inbound_rules")const result = await cotlet.call('clicksend', 'list_inbound_rules');cotlet call clicksend list_inbound_rulesExample response
{
"rules": [
{
"name": "STOP",
"number": "+15550100188",
"match_for": "Message starts with",
"search_term": "Stop",
"action": "MOVE_CONTACT",
"contact_list": "Opt-Out List"
}
]
}