Создание имен отправителей

Создание имени отправителя (SMS)

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

При помощи данного метода можно отправить на регистрацию имя отправителя для SMS-трафика.
Для имен типа PROMO необходимо прикрепление файлов.

Headers

Name	Type	Description
Authorization*	string	Basic {TOKEN_2}
Content-Type*	string	multipart/form-data

Request Body

Name	Type	Description
name*	string	Название части содержимого file1, file2, file3… – для прикладываемых файлов body – для основного json’а
filename	string	Название прикладываемого файла Указывается дляname=file
channelType*	string	Канал трафика, для которого регистрируется имя отправителя.
commonType*	string	Тип имени отправителя
brand*	string	Оператор
dateFrom*	string	Желаемая дата начала действия Время с датой вида «yyyy-MM-ddThh:mm:ssZ»; не ранее чем следующий день
senderName*	string	Имя отправителя Для Мегафона должно соответствовать выражению [A-z0-9.!-]{3,11} Для остальных операторов [A-z0-9.+-\s]{3,11}
counteragentName*	string	Имя юрлица
counteragentInn*	string	ИНН юрлица

200

Возвращается объект имени отправителя, соответствующий полученному json.

{
  "id": 1,
  "channelType": "SMS",
  "commonType": "PROMO",
  "brand": "MTS",
  "dateFrom": "2020-07-07T21:00:00Z",
  "senderName": "test",
  "counteragentName": "Контрагент, ООО",
  "counteragentInn": "123451729124",
  "status": "PRE_REVIEW",
  "fee": 2000
}

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": "Date from isn't greater than now"
    }
}
-----------------------------------------------------------------------------
{
    "error": {
        "code": 4220,
        "msg": "Unknown brand NEW_BRAND"
    }
}
-----------------------------------------------------------------------------
{
    "error": {
        "code": 4220,
        "msg": "Invalid channel type"
    }
}
-----------------------------------------------------------------------------
{
    "error": {
        "code": 4220,
        "msg": "Duplicates with existing name (id = 1161)"
    }
}

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

Параметр	Варианты
channelType	SMS
commonType	Типы имен отправителей
brand	Операторы имен отправителей

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

JSON

POST https://direct.i-dgtl/ru/api/v1/sender-names
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Content-Type: multipart/form-data; boundary=--part
--part
Content-Disposition: form-data; name="file1"; filename="document1.pdf"
< ./path/document1.pdf
--part
Content-Disposition: form-data; name="file2"; filename="document2.png"
< ./path/document2.png
Content-Disposition: form-data; name="body"
Content-Type: application/json
{
  "channelType": "SMS",
  "commonType": "PROMO",
  "brand": "MTS",
  "dateFrom": "2020-07-07T21:00:00Z",
  "senderName": "test",
  "counteragentName": "Контрагент, ООО",
  "counteragentInn": "123451729124"
}

cURL

curl -X POST 'https://direct.i-dgtl.ru/api/v1/sender-names' \
-H 'Content-Type: multipart/form-data;boundary=--part' \
-H 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==' \
-F 'body={"channelType":"SMS","commonType":"PROMO","brand":"MTS","dateFrom":"2020-07-07T21:00:00Z","senderName":"test","counteragentName":"Контрагент, ООО","counteragentInn":"123451729124"}' \
-F 'file1=@path/document1.pdf'
-F 'file2=@path/document2.png'