Получение имен отправителей

Содержание

Получение имен отправителей#

Получение имени отправителя по id#

GET https://direct.i-dgtl.ru/api/v1/sender-names/{sender_name_id}

Path Parameters#

Name	Type	Description
sender_name_id*	integer	Идентификатор имени отправителя

Headers#

Name	Type	Description
Authorization*	string	`Basic {TOKEN_2}`

200

{
  "id": 1,
  "senderName": "test",
  "channelType": "SMS",
  "counteragentName": "Контрагент, ООО",
  "counteragentInn": "123451729124",
  "dateFrom": "2020-07-07T21:00:00Z",
  "dateTo": "2020-10-10T00:00:00Z",
  "commonType": "MULTISIGNATURE",
  "brand": "MTS",
  "status": "CLOSED",
  "fee": 0,
  "managerComment": "комментарий менеджера",
  "rejectedAt": "2020-07-09T16:55:01Z"
}

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 hasn't sender name 10000"
    }
}

Описание объекта имени отправителя #

Параметр	Тип	Описание
id	integer	Идентификатор имени отправителя
senderName	string	Имя отправителя
channelType	string	Канал трафика
counteragentName	string	Имя юрлица
counteragentInn	string	ИНН юрлица
dateFrom	string	Дата начала действия
dateTo	string	Дата окончания действия
commonType	string	Тип
brand	string	Оператор (возвращается при `channelType=SMS`)
countryCode	string	Код страны (возвращается при `channelType=VIBER`)
status	string	Статус
fee	number	Абонентская плата
managerComment	string	Комментарий менеджера
rejectedAt	string	Дата отклонения

Получение списка имен отправителей#

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

Метод возвращает массив объектов имен отправителей, подходящих под условия фильтрации.

Query Parameters#

Name	Type	Description
channel_type	string	Фильтрация по каналам
brand	string	Фильтрация по операторам Множественный параметр
country_code	string	Фильтрация по странам Множественный параметр
common_type	string	Фильтрация по типу отправителей
status	string	Фильтрация по статусу отправителей Множественный параметр

Headers#

Name	Type	Description
Authorization*	string	`Basic {TOKEN_2}`

200

[
  {
    "id": 1,
    "senderName": "sms_sender",
    "channelType": "SMS",
    "counteragentName": "Контрагент, ООО",
    "counteragentInn": "123451729124",
    "dateFrom": "2020-07-07T21:00:00Z",
    "dateTo": "2020-10-10T00:00:00Z",
    "commonType": "MULTISIGNATURE",
    "brand": "MTS",
    "status": "CLOSED",
    "fee": 0,
    "managerComment": "комментарий менеджера",
    "rejectedAt": "2020-07-09T16:55:01Z"
  },
  {
    "id": 2,
    "senderName": "viber_sender",
    "channelType": "SMS",
    "counteragentName": "Контрагент, ООО",
    "counteragentInn": "123451729124",
    "dateFrom": "2020-07-07T21:00:00Z",
    "dateTo": "2020-10-10T00:00:00Z",
    "commonType": "PROMO",
    "countryCode": "ru",
    "status": "CLOSED",
    "fee": 0,
    "managerComment": "комментарий менеджера",
    "rejectedAt": "2020-07-09T16:55:01Z"
  }
]

401 Использование невалидного токена

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

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

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

422 Невалидное значение параметров запроса; ниже приведены несколько примеров ответа

{
    "error": {
        "code": 4220,
        "msg": "Unknown brand NEW_BRAND"
    }
}
-----------------------------------------------------------------------------
{
    "error": {
        "code": 4220,
        "msg": "Unknown status DELETED"
    }
}

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

Параметр	Варианты
channel_type	Каналы имен отправителей
brand	Операторы имен отправителей
countryCode	Страны имен отправителей
common_type	Типы имен отправителей
status	Статусы имен отправителей

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

Позволяет получить имена отправителей типа «Мультиподпись» в статусах «Одобрено» и «Закрыто», зарегистрированных на Билайн и Мегафон

JSON

GET https://direct.i-dgtl.ru/api/v1/sender-names?common_type=MULTISIGNATURE&status=APPROVED&status=CLOSED&brand=BEELINE&brand=MEGAFON
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

cURL

curl -X GET 'https://direct.i-dgtl.ru/api/v1/sender-names?common_type=MULTISIGNATURE&status=APPROVED&status=CLOSED&brand=BEELINE&brand=MEGAFON' \
-H 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=='