Developer Docs

Table of contents

Method: POST 

Endpoint: /api/stoplist/attach 

Description: method for adding one or more contacts to the RCS stop list. 

Input parameters

Parameter Mandatory Type Description. 
phones Yes array Array of phone numbers 
types Yes array The type of stop list to which you want to add a contact. Possible values: sms, viber, rcs. 

Answer elements

Parameter Type Description. 
id integer id of the contact added to the stop list. 
phone string Phone number of the contact. 
created_at datetime The date when the contact was added to the stop list. 
sms_stoplist boolean Indicates whether the contact is in the SMS stop list. Possible values: true/false. 
viber_stoplist boolean Indicates whether the contact is in the Viber stop list. Possible values: true/false. 
rcs_stoplist boolean Indicates whether there is a contact in the RCS stop list. Possible values: true/false. 

Example of a query

{
   "phones":[
      380661231231
   ],
   "types":[
      "rcs"
   ]
}

An example of an answer

If the request is successfully executed:

{
   "data":[
      {
         "id":9392897,
         "phone":380661231231,
         "created_at":"2022-04-18 19:22:16",
         "sms_stoplist":true,
         "viber_stoplist":true,
         "rcs_stoplist":true
      }
   ]
}