1. Home
  2. Docs
  3. MO for STOP SMS
  4. Principles & Description

Principles & Description

Principles

It allows users to notify the SP of their wish to unsubscribe by sending a SMS to an appropriate short-code.



Note:

Please note that the MO Stop is mandatory in Ivory Coast and DR Congo as a method of unsubscription.

Description

Please find below the elements needed to set up from our side this feature:

  • A notification URL: the URL where Bizao will notify/send you the neccessary information:
    • In the header
      • HTTP_BIZAO_TOKEN => BIZAO_TOKEN
      • HTTP_BIZAO_ALIAS => BIZAO_ALIAS
    • In the body (sample)
    •             {
                  "inboundSMSMessageNotification":{
                     "callbackData":"xxxxxxxxxxx",
                           "inboundSMSMessage":{
                           "dateaTime":"2019-01-21T12:49:46",
                           "destinationAddress":"+2257752",
                           "messageId":"5c45b1fdfs54654h6f7f53fe20cf",
                           "message":"THE_KEYWORD STOP",
                           "senderAddress":"acr:token"
                           }
                     }
                  }
                  
  • A keyword: the code that your end-user will send followed by the word “STOP”. It has to be a unique value. The same keyword can not be used by several service providers.
    • Sample: “C02 STOP” to 7752

Note:

Please note that a keyword can be linked to only one url but a url can be linked to many keywords.

Country Short-code
Ivory-Coast 7752
RDCongo  444888
Cameroon
Senegal
Tunisia


Example:

For a service called GameStore available in Ivory Coast and Cameroon, the right setting could be the following:

  • Keyword: “GS”
  • Notification url: “https://gamestore.com/notification/mo” (same url for all countries)

How to test your notification url ?

The request below will allow you to test your notification url after a whitelisting to our backend.


  • Bizao-URI: /auth/v1/mo/sp/notify
  • Bizao-Host: api.bizao.com

Your query will contain the Headers below:

Header Description/Content
authorization YOUR_ACCESS_TOKEN
orangeapitoken BIZAO-TOKEN
x-orange-ise2 BIZAO-ALIAS
content-type application/json

The body of your query will contain the parameters below:

Parameter Usage Description
callbackData Optional
dateaTime Optional
destinationAddress Mandatory +2257752 for Ivory Coast and +243444888 for DRC
messageId Optional
message Mandotory YOUR_KEYWORD followed by the word STOP
senderAddress Optional


sample:


curl -X POST \
  https://api.bizao.com/auth/v1/mo/sp/notify \
  -H 'authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'orangeapitoken: BIZAO_TOKEN' \
  -H 'x-orange-ise2: BIZAO_ALIAS' \
  -H 'content-type: application/json' \
  -d '{
  "inboundSMSMessageNotification":{  
        "callbackData":"",
        "inboundSMSMessage":{  
          "dateaTime":"",
          "destinationAddress":"",
          "messageId":"",
          "message":"SACHA STOP",
          "senderAddress":"acr:token"
    }
  }
}'
Was this article helpful to you? Yes No

How can we help?