BSG utilizes HTTP cookies (and similar or complementary technologies) to 1) make this website safe, functional, and accessible (through the use of mandatory cookies) and 2) understand how you use our website (through the use of optional cookies) in order to improve your experience and to provide you with personalized content.

The information in the cookie text files may be related to your personal preferences or your device and is intended to make the site operate according to your expectations. The information contained in cookies does not usually identify your identity directly but is helpful in providing you with a more personalized user experience.

In accordance with the requirements of the General Data Protection Regulation (GDPR) privacy and security law that governs how the personal data of individuals in the EU may be processed and transferred, we provide you the possibility to prohibit the use of certain types of cookies when you use our website.

Read our Cookie Notice and the Privacy Policy for detailed information on how BGS collects and uses cookies. Please note that prohibiting the use of certain types of cookies may affect your interaction with the website and limit the accessibility of services we offer you. Choose the appropriate category below to learn more and to disable cookies.

Accept All cookies*

*Recommended for comfortable use of the site

Accept only necessary cookies

Accept only selected cookies

Necessary cookies

Social media

Analytics

Marketing

Get a list of contacts from RCS stop list

Method : GET

Endpoint : /api/stoplist/

Description: method to get the list of contacts that are in the RCS stop list.

Query string parameters

Parameter	Mandatory	Type	Description.
page[limit]	No	integer	The number of records in the response. The range of values: min – 15, max – 500. The default is 50.
page[offset]	No	integer	Get stop list contacts starting from offset. The default is 0
types	No	string	Type of the stop list for which you want to get the list of contacts. Possible values: sms, viber, rcs. If the sheet stop type is not specified, the method returns data for all sheet stop types.

Answer elements

Parameter	Type	Description.
id	integer	id of the contact that is in 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.
total	string	Total number of contacts.

An example of an answer


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