Unsubscribe VIA MT Unsubscribe Notification

This document will go over how to unsubscribe a user via an MT message.

GET /srs/api/sendsms

Manually unsubscribe a user from your service using our API by using an unsubscription notification.

Curl

curl -XGET -H "Content-type: application/json" 'https:hostname/srs/api/sendsms?USER_NAME=<account_id>&PASSWORD=<API_Key>&ORIGINATOR=<Short_code>&RECIPIENT=<MSISDN>&PROVIDER=<network>&MESSAGE_TEXT=<URL_encoded_message>&KEYWORD=<product_id>&STARTED=<YYYY-MM-DD HH:MM>+STOP&CLASS=PAUSE'

Python

import requests

headers = {
    'Content-type': 'application/json',
}

response = requests.get(
    'http://https:hostname/srs/api/sendsms?USER_NAME=<account_id>&PASSWORD=<API_Key>&ORIGINATOR=<Short_code>&RECIPIENT=<MSISDN>&PROVIDER=<network>&MESSAGE_TEXT=<URL_encoded_message>&KEYWORD=<product_id>&STARTED=<YYYY-MM-DD HH:MM>+STOP&CLASS=PAUSE',
    headers=headers,
)

When calling the Unsubscribe API, +STOP needs to be added also to indicate this is an unsubscription request.

Headers

Name	Value
Content-Type	application/json
Authorization	No Auth

Body

Parameter	Type	Example	Description
account_id	string	43e36f50aaf111e272639171000000a9	Your unique Mobivate account id.
password	string	3b41d767316541bacef19d1382ac1e12	Your unique associated Mobivate account api-key.
originator	integer	12345	The associated shortcode for your service.
recipient	integer	XX7432104492	The recipient you want to send this message to.
provider	string	Safaricom	The network you plan to send the SMS message via.
message_text	string	YOU%20HAVE%20UNSUBSCRIBED	Your URL encoded message.
started	string	2023-09-13 11:01	The date/timestamp of when your message was sent.
keyword	string	mv-100620006	Your unique Mobivate keyword for your service.
class	string	PAUSE	The class of the message, in this case PAUSE.

Response

200

{
  "MT-aabbccddeeff00112233445566778899"
}

511

{
  "error": "Username or Password incorrect"
}