Документація для розробників
RCS
SMS / 2Way SMS API
Viber API
Number Intelligence
Контакти
Відправники
Списки
Стоп-листи
Статистика
Отримати статус відправників SMS
Метод дає змогу:
- отримати список усіх створених заявок на реєстрацію відправника для сервісу SMS
- отримати заявки на реєстрацію відправника SMS, що відповідають заданим вхідним параметрам.
Щоб отримати статус відправників SMS, виконайте запит:
| GET https://one-api.bsg.world/api/senders/requests/sms |
Параметри запиту:
| Параметр | Обовʼязковий | Тип | За замовчуванням | Опис |
|---|---|---|---|---|
| page[offset] | Ні | integer | 0 | Отримати заявки на реєстрацію відправника, починаючи зі зсуву offset |
| page[limit] | Ні | integer | 50 | Кількість заявок у відповіді |
| sort | Ні | string | id | Сортування за полями: id, sender, status, country_code, created at |
| way | Ні | string | asc | Варіанти сортування: asc, desc |
| filter[status] | Ні | string | no |
Фільтр для отримання заявок у вибраному статусі:
|
| filter[id] | Ні | integer | no | Фільтр для отримання заявки за її ідентифікатором |
| filter[country_code] | Ні | string | no |
Фільтр для отримання заявок за країною реєстрації відправника.
Формат згідно зі стандартом ISO 3166-1 |
| filter[sender] | Ні | string | no |
Фільтр для отримання заявок за іменем відправника SMS.
До 15 символів |
| filter[created_at] | Ні | string | null | Фільтр для отримання заявок за вказаною датою подання заявки на реєстрацію, yyyy-mm-dd |
Параметри відповіді:
| Параметр | Тип | Опис |
|---|---|---|
| id | integer | Ідентифікатор заявки на реєстрацію відправника |
| sender | string | Імʼя відправника SMS |
| status | string | Application status |
| created_at | string | Дата й час створення заявки на реєстрацію відправника. Формат ISO 8601: yyyy-mm-dd hh:mm:ss |
| registered_at | string|null | Дата реєстрації відправника |
| status_changed_at | string|null | Дата й час зміни статусу заявки на реєстрацію відправника. Формат ISO 8601: yyyy-mm-dd hh:mm:ss |
| country_code | string | Країна відправника згідно зі стандартом ISO 3166-1 Alpha-2 |
| code_of_company | string | Company code |
| tax_number | string | Ідентифікатор юридичної особи |
| type | string | Тип відправника: sms |
| site_url | string|null | Company URL |
| name | string|null | Прізвище, імʼя та по батькові |
| legal_name | string|null | Назва юридичної особи |
| address | string|null | Адреса юридичної особи |
| informing_purpose | string|null | Мета інформування |
| comment | string|null | Comment |
| rejection_reason | string|null | Причина відхилення заявки на реєстрацію відправника. Відображається лише для заявок зі статусом «rejected» |
| description | string|null | Service description |
Якщо запит виконано успішно, ви отримаєте відповідь:
{
"data": [
{
"id": 3152,
"sender": "sender",
"status": "new",
"created_at": "2021-04-27 19:44:06",
"registered_at": "2021-04-27 19:44:06",
"status_changed_at": "2021-04-27 19:44:06",
"country_code": "UA",
"code_of_company": "123123123",
"tax_number": "123123123",
"type": "sms",
"site_url": "https://dev-app.bsg.world",
"name": "name",
"legal_name": "juridical_name",
"address": "juridical_address",
"informing_purpose": "informing_purpose",
"comment": "comment",
"rejection_reason": "rejection_reason",
"description": "description"
}
],
"meta": {
"page": {
"total": 1,
"offset": 20,
"limit": 40
}
}
}
Зацікавлені у спеціальній пропозиції?
Готові розширювати можливості?
Давайте обговоримо.
Надіслати