Получение списка шаблонов
Этот метод возвращает список шаблонов сообщений для отправки кода OTP, позволяя вам фильтровать их по различным параметрам.
Чтобы получить список шаблонов, выполните запрос по этому URL:
GET https://one-api.notificore.ru/api/2fa/authentications/templates
Request parameters
Parameter | Requires | Type | Default | Description |
---|---|---|---|---|
page[offset] | No | integer | 0 | Get 2FA templates starting with offset. |
page[limit] | No | integer | 10 | The number of 2FA templates in the response. |
filter[ids] | No | array($string) | The list of template IDs. | |
filter[status] | No | string | Possible values: requested, rejected, approved. | |
way | No | string | asc | Sort options: asc, desc |
sort | No | string | updated_at | Sorting by template_id, status, name, updated_at. |
Response parameters
Parameter | Type | Description |
---|---|---|
template_id | string | Unique identifier of the template. |
name | string | The name of the template. |
text | string | The text of the message |
countries | string | List of countries for which the template is created. |
status | string | The status of the template. Possible values: Requested, Rejected, Approved. |
updated_at | string | Date and time when the template was created or last modified. The display format is ISO 8601: yyyy-mm-dd hh:mm:ss. |
total | integer | A total number of templates that meet the search conditions. |
Example of response
Ответ в случае успешного запроса:
{ "data": [ { "template_id": "49", "name": "string", "countries": [ "AD", "IT", "PT", "RU" ], "text": "Your Notificore 2FA confirmation code is {code2fa}.", "status": "approved", "updated_at": "2022-04-18 10:55:35" } ], "total": 1 }