Network Double Opt-in (NDOI) Unsubscribe

Learn how to handle an NDOI request using our API.

GET /api/doi/<account_id>/<api_key>/

Initiate a network DOI unsubscription request.

Curl

curl -XGET -H "Content-type: application/json" 'https://hostname/api/doi/<account_id>/<api_key>/?source=<shortcode>&destination=<msisdn>&keyword=<kw>&frequency=7&amount=100&campaign=Test&provider=<networkprovider>&reference=<your internal reference>&stop'

Python

import requests

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

response = requests.get(
    'https://hostname/api/doi/<account_id>/<api_key>/?source=<shortcode>&destination=<msisdn>&keyword=<kw>&frequency=7&amount=100&campaign=Test&provider=<networkprovider>&reference=<your internal reference>&stop',
    headers=headers,
)

Headers

Name	Value
Content-Type	application/json
Authorization	No Auth

Required Body

Parameter	Type	Example	Description
account_id	string	43e36f50aaf111e272639171000000a9	Your unique Mobivate account id.
api_key	string	3b41d767316541bacef19d1382ac1e12	Your unique associated Mobivate account api-key.
source	integer	12345	The associated shortcode for your service.
destination	integer	XX7432104492	The recipient you want to send this message to.
keyword	string	mv-100620006	Your unique Mobivate keyword for your service.
amount	integer	10	The amount your message will be billed for receiving.
reference	string	ABC1234	Your internal unique reference.
provider	string	safaricom	The network provider this message will be sent via.
stop	string	stop	To indicate a user is being unsubscribed from your service.

Response

200

{
  "200": "MT-c65561314eb34088b6df42d8241aace0"
}

541

{
  "error": "541"
}

For a full list of response codes, please click here.