Get contacts from the Stoplist

The method allows getting a list of contacts that were added to the SMS and/or Viber stop list.

Request URL:

GET http://one-api.bsg.world/api/stoplist

Request parameters:

Parameter	Required	Type	Description
page	No	integer	Paginator page, minimum ― 1. Default ― 1
per_page	No	integer	The number of entries in the response. Minimum ― 10, maximum ― 1000. Default ― 20
types	No	string	Specify the type of the stop list for which we need to return the contact list. Possible values: sms, viber.If the stop list type is not specified, the method will return data for both stop list types

Response parameters:

Parameter	Type	Description
id	integer	ID of the contact added to the stop list
phone	string	Contact’s phone number
created_at	datetime	Date of adding the contact to the stop list
sms_stoplist	boolean	Whether the contact was added to the SMS stop list. Possible values: true or false
viber_stoplist	boolean	Whether the contact was added to the Viber stop list. Possible values: true or false
total	string	The total number of contacts in the stop list

Response sample

If request is successful, you will receive a response:

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