📋 Список шаблонов

Методы получения списка шаблонов делятся на два варианта. Пожалуйста, внимательно выбирайте необходимый для Вас вариант!

1️⃣ Получение полного списка шаблонов.

Данный запрос позволяет получить список стран, сервисов и шаблонов, которые были разрешены к отправке в SMS-сообщениях через выданный API-ключ.

Получение списка стран, сервисов и шаблонов

GET https://api.sms.limited/api/templates

Headers

Name	Type	Description
Authorization*	Bearer <api-key>
Host*	api.sms.limited
Content-Type*	application/json

200: OK Successful

{
    "DE": [
        {
            "service_name": "ebayKA",
            "template_text_src": "Example text number 1 - $link$",
            "template_text_eng": "Example text number 1 - $link$",
            "template_text_ru": "Пример текста номер 1 - $link$",
            "template_id": 1
        },
        {
            "service_name": "DHL",
            "template_text_src": "Example text number 1 - $link$",
            "template_text_eng": "Example text number 1 - $link$",
            "template_text_ru": "Пример текста номер 1 - $link$",
            "template_id": 1
        }
        {
            "service_name": "ebayKA",
            "template_text_src": "Example text number 2",
            "template_text_eng": "Example text number 2",
            "template_text_ru": "Пример текста номер 2",
            "template_id": 2
        },
        {
            "service_name": "DHL",
            "template_text_src": "Example text number 2",
            "template_text_eng": "Example text number 2",
            "template_text_ru": "Пример текста номер 2",
            "template_id": 2
        }
    ]
}

401: Unauthorized IP Address is not added to the whitelist

{
  "status": "Error",
  "info": "Your IP Address is not added to the whitelist."
}

📝 Пример использования

Посмотрите, как можно вызвать данный метод через curl:

Пример

curl --location 'https://api.sms.limited/api/templates' \
--header 'Authorization: Bearer <api-key>' \
--header 'Content-Type: application/json' \
--header 'Host: api.sms.limited'

2️⃣ Выборочное получение списка шаблонов.

Данный запрос позволяет выборочно получить список шаблонов по указанному коду страны и её сервису/площадке.

Выборочное получение списка шаблонов.

POST https://api.sms.limited/api/templates

Headers

Name	Type	Description
Authorization*	Bearer <api-key>
Host*	api.sms.limited
Content-Type	application/json

Request Body

Name	Type	Description
country*	DE	Выбор страны, шаблоны которой Вы хотели бы получить
service	ebayKA	Выбор имени сервиса/площадки, шаблоны которой Вы хотели бы получить

200: OK Successful

[
  {
    "text_src": "Example text number 1",
    "text_ru": "Пример текста номер 1",
    "template_id": 1
  },
  {
    "text_src": "Example text number 2 - $link$",
    "text_ru": "Пример текста номер 2 - $link$",
    "template_id": 2
  },
  {
    "text_src": "Example text number 3",
    "text_ru": "Пример текста номер 3",
    "template_id": 3
  },
  {
    "text_src": "Example text number 4",
    "text_ru": "Пример текста номер 4",
    "template_id": 4
  },
  {
    "text_src": "Example text number 5",
    "text_ru": "Пример текста номер 5",
    "template_id": 5
  },
  {
    "text_src": "Example text number 6 $link$",
    "text_ru": "Пример текста номер 6 $link$",
    "template_id": 6
  },
  {
    "text_src": "Example text number 7: www.$link$",
    "text_ru": "Пример текста номер 7: www.$link$",
    "template_id": 5
  },
  {
    "text_src": "Example text number 8 $link$",
    "text_ru": "Пример текста номер 8 $link$",
    "template_id": 6
  }
]

404: Not Found Invalid country or service name

{
  "status": "Error",
  "info": "Please provide valid country or service name"
}

401: Unauthorized IP Address is not added to the whitelist

{
  "status": "Error",
  "info": "Your IP Address is not added to the whitelist."
}

📝 Пример использования

Посмотрите, как можно вызвать данный метод через curl:

Пример

curl --location 'https://api.sms.limited/api/templates' \
--header 'Authorization: Bearer <api-key>' \
--header 'Content-Type: application/json' \
--header 'Host: api.sms.limited' \
--data '{
    "country": "DE",
    "service": "ebayKA"
}'

Body

{
    "country": "",
    "service": ""
}