Создание шаблонов (deprecated)

Отправка шаблона на регистрацию

POST https://direct.i-dgtl.ru/api/v1/templates

Метод позволяет отправить на регистрацию шаблоны одного типа к зарегистрированным именам отправителей.

Headers

Name	Type	Description
Authorization*	string	Basic {TOKEN_2}
Content-Type*	string	application/json

Request Body

Name	Type	Description
toAdd*	string	Способ отправки шаблонов
templateType*	string	Тип шаблона
dateFrom*	string	Желаемая дата начала действия шаблона
templates*	array	Массив объектов с шаблонами и именами отправителей
templates.pattern*	string	Текст шаблона
templates.senderNames*	array	Идентификаторы имен отправителей, на которые нужно зарегистрировать шаблон. Допускается регистрация на имена отправителей операторов Мегафон, Билайн, Теле2 и МТС в статусах, начиная с INTERNAL_REVIEW.

200

При отсутствии ошибок в запросе (независимо от валидности шаблонов) вернется HTTP-код 200.

{
    "toAdd": "ALL_VALID",
    "templateType": "SERVICE",
    "dateFrom": "2020-09-01T21:00:00Z",
    "total": 4,
    "added": 2,
    "notAdded": 2,
    "templates": [
        {
            "pattern": "это текст шаблона 1",
            "patternState": "INVALID",
            "correctExample": "это исправленный текст шаблона"
            "senderNames": [
                {
                    "id": 14,
                    "senderName": "sender14",
                    "brand": "BEELINE",
                    "state": "ERROR"
                },
                {
                    "id": 15,
                    "senderName": "se5der14",
                    "brand": "MEGAFON",
                    "state": "ERROR"
                }
            ]
        },
        {
            "pattern": "это текст шаблона 2",
            "patternState": "VALID",
            "senderNames": [
                {
                    "id": 14,
                    "senderName": "sender14",
                    "brand": "BEELINE",
                    "state": "ERROR",
                    "error": {
                        "type": "DUPLICATES_EXISTING"
                        "templateId": 112
                    }
                },
                {
                    "id": 15,
                    "senderName": "sender15",
                    "brand": "MEGAFON",
                    "state": "SUCCESS",
                    "templateId": 12345
                }
            ]
        }
    ]
}

401

Использование невалидного токена / отсутствие заголовка авторизации.

4012

{
    "error": {
        "code": 4012,
        "msg": "Bad credentials"
    }
}

4010

{
    "error": {
        "code": 4010,
        "msg": "Not Authenticated"
    }
}

403

Использование неподходящего токена.

{
    "error": {
        "code": 4030,
        "msg": "Access Denied"
    }
}

422

Несуществующее имя отправителя.

{
    "error": {
        "code": 4220,
        "msg": "Client 5 has not sender name 734"
    }
}

Возможные варианты перечислений:

Параметр	Варианты
toAdd	ALL_OR_NOTHING – будут созданы либо все шаблоны (при условии валидности каждого из них), либо ни одного ALL_VALID – будут созданы все валидные шаблоны
templateType	Типы шаблонов

{% hint style=»warning» %}

• Создание шаблонов типа SERVICE допускается только для имен отправителей операторов Билайн, Мегафон, МТС

• Создание шаблонов типа AUTHORIZE допускается только для имен отправителей операторов Мегафон, Теле2 {% endhint %}

Описание объекта ответа

Параметр	Тип	Описание
toAdd	string	Соответствует toAdd в запросе
templateType	string	Соответствует templateType в запросе
dateFrom	string	Соответствует dateFrom в запросе
total	integer	Общее количество переданных шаблонов
added	integer	Количество добавленных шаблонов
notAdded	integer	Количество не добавленных шаблонов
templates	array	Массив объектов с шаблонами и именами отправителей
templates.pattern	string	Текст шаблона
templates.patternState	string	Статус валидности текста шаблона VALID – текст валиден INVALID – текст не валиден
templates.correctExample	string	Пример текста шаблона с исправленными ошибками
templates.senderNames	array	Массив объектов имен отправителей, на которые регистрировались шаблоны
templates.senderNames.id	integer	Идентификатор имени отправителя
templates.senderNames.senderName	string	Имя отправителя
templates.senderNames.brand	string	Оператор имени отправителя
templates.senderNames.state	string	Статус отправки шаблона на данное имя отправителя: SUCCESS – шаблон отправлен на регистрацию ERROR – произошла ошибка, шаблон не отправлен на регистрацию
templates.senderNames.templateId	integer	Идентификатор созданного шаблона (передается приstate = SUCCESS)
templates.senderNames.error	object	Объект с описанием ошибки (передается приstate = ERROR)
templates.senderNames.error.type	string	Тип ошибки: DUPLICATE – является дубликатом шаблона, который также присутствует в запросе COVERED – содержится в другом шаблоне, который также присутствует в запросе DUPLICATES_EXISTING – является дубликатом существующего в системе шаблона COVERED_BY_EXISTING – содержится в другом шаблоне, который существует в системе
templates.senderNames.error.templateId	integer	Идентификатор шаблона в системе, из-за которого нельзя добавить данный (актуально для ошибок ..._EXISTING)

Пример запроса

Создание сервисных шаблонов «pattern 1» и «pattern 2» на имена отправителей с идентификаторами 14 и 15 и датой начала действия 2020-09-01 21:00:00 UTC.

JSON

POST https://direct.i-dgtl.ru/v1/templates
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Content-Type: application/json
{
  "toAdd": "ALL_VALID",
  "templateType": "SERVICE",
  "dateFrom": "2020-09-01T21:00:00Z",
  "templates": [
    {
      "pattern": "pattern 1",
      "senderNames": [
        14,
        15
      ]
    },
    {
      "pattern": "pattern 2",
      "senderNames": [
        14,
        15
      ]
    }
  ]
}

cURL

curl -X POST 'https://direct.i-dgtl.ru/api/v1/templates' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==' \
-d '{"toAdd":"ALL_VALID","templateType":"SERVICE","dateFrom":"2020-09-01T21:00:00Z","templates":[{"pattern":"это текст шаблона 1","senderNames":[14,15]},{"pattern":"это текст шаблона 2","senderNames":[14,15]}]}'