Поиск контактов в стоп-листе
Метод для поиска контактов в стоп-листе.
При поиске можно использовать операции: like, =, >, >=, <, <=.
Чтобы найти контакты в стоп-листе, сделайте запрос по этому URL:
GET http://one-api.notificore.ru/api/stoplists/search
Request parameters:
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| page[offset] | No | int | 0 | Get contacts starting from offset |
| page[limit] | No | int | 50 | Number of contacts in response |
| sort | No | string | id | Sort by conditions: id, phone |
| way | No | string | asc | Sorting options: asc, desc |
| search[operator] | No | string | = | Operator for finding values: like, =, >, >=, <, <= |
| search[field] | No | string | no | Field for search: id, type, phone, date |
| search[value] | No | string | no | Value for search |
Response parameters:
| Parameter | Type | Description |
|---|---|---|
| id | integer | Contact ID |
| phone | integer | Phone number |
| created_at | string | Date of adding the contact to the stop list. Display format ISO 8601: yyyy-mm-dd hh:mm:ss |
| 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 |
Если запрос успешен, вы получите ответ:
{
"data": [
{
"id": 9392897,
"phone": 12345678900,
"created_at": "2022-04-18 19:22:16",
"sms_stoplist": true,
"viber_stoplist": false
}
],
"meta": {
"page": {
"total": 1,
"limit": 30,
"offset": 0
},
"search": {
"field": "id",
"operator": "like",
"value": "string"
}
}
}