Получение контактов из стоп-листа
Этот метод позволяет получить список контактов, которые были добавлены в стоп-лист SMS и/или Viber.
Чтобы получить контакты из стоп-листа, сделайте запрос по этому URL:
GET http://one-api.notificore.ru/api/stoplist
Request parameters:
Parameter | Required | Type | Description |
---|---|---|---|
page[limit] | No | integer | The number of entries in the response. The value range for the parameter: min – 15, max – 500. The default is 30. |
page[offset] | No | integer | Get stop list contacts starting from the offset. The default is 0. |
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 |
Если запрос успешен, вы получите ответ:
{ "data": [ { "id": 9392897, "phone": 85267202829, "created_at": "2022-04-18 19:22:16", "sms_stoplist": true, "viber_stoplist": false } ], "total": 1 }