Создание шаблонов
post
https://direct.i-dgtl.ru/api
/v1/templates
Отправка шаблона на регистрацию
Возможные варианты перечислений:
Параметр
Варианты
toAdd
  • ALL_OR_NOTHING – будут созданы либо все шаблоны (при условии валидности каждого из них), либо ни одного
  • ALL_VALID – будут созданы все валидные шаблоны
templateType
  • Создание шаблонов типа SERVICE допускается только для имен отправителей операторов Билайн, Мегафон, МТС
  • Создание шаблонов типа AUTHORIZE допускается только для имен отправителей операторов Мегафон, Теле2

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

Параметр
Тип
Описание
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
cURL
1
POST https://direct.i-dgtl.ru/v1/templates
2
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
3
Content-Type: application/json
4
{
5
"toAdd": "ALL_VALID",
6
"templateType": "SERVICE",
7
"dateFrom": "2020-09-01T21:00:00Z",
8
"templates": [
9
{
10
"pattern": "pattern 1",
11
"senderNames": [
12
14,
13
15
14
]
15
},
16
{
17
"pattern": "pattern 2",
18
"senderNames": [
19
14,
20
15
21
]
22
}
23
]
24
}
Copied!
1
curl -X POST 'https://direct.i-dgtl.ru/api/v1/templates' \
2
-H 'Content-Type: application/json' \
3
-H 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==' \
4
-d '{"toAdd":"ALL_VALID","templateType":"SERVICE","dateFrom":"2020-09-01T21:00:00Z","templates":[{"pattern":"это текст шаблона 1","senderNames":[14,15]},{"pattern":"это текст шаблона 2","senderNames":[14,15]}]}'
Copied!