OPTOUT

OPTOUT

RCS campaigns specifically target customers who are registered subscribers to your RCS services. To manage customer preferences, our opt-out feature allows you to block a customer’s number. Once a number is blocked, any attempt to trigger an RCS message to that customer will be automatically rejected by our system. As a result, the customer will not receive the RCS message. This feature ensures that customer preferences are respected and allows for effective communication management.

API Endpoint

https://eu.cpaas.bics.com/api/v2/

Note: Few elements in the endpoint may change from service to service.

POST

{endpoint}rcs/optout

MANDATORY PARAMETERS

Name Descriptions
number Receiver numbers that you want to block.

Example Request

curl -X POST \
  '{endpoint}rcs/optout'
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer 38e896f55670311982434e929559xxxx'
   -d '{
    "number":"9174114xxxxx"
}'

On triggering the above API the specified numbers will be added to your optout list.

Example Response

{
  'status' => OK,
  'code' => 200,
  'message' => 'Number added to optout list',
  'data': {
        'receiver': '918736******',
        'iso': 'IN',
        'created_at': '2022-10-26T06:33:40.000000Z',
        'id': 71
    },
}

Delete number using delete method under your optout list

API Endpoint

https://eu.cpaas.bics.com/api/v2/

Note: Few elements in the endpoint may change from service to service.

DELETE

{endpoint}rcs/optout/{number}

Replace the {number} with the actual number of the RCS that you would like to delete.

Example Request

curl -X DELETE \
  {endpoint}rcs/optout/91873650xxxx \
  -H 'Authorization: Bearer 5b02112fb7xxxxxxxxxxxxxxx' \

Example Response

{
  "status": "OK",
  "code": 200,
  "message": "Deleted successfully",
  "data": []
}