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

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

<mark style="color:blue;">`GET`</mark> `https://direct.i-dgtl.ru/api/v1/sender-names/{sender_name_id}`

#### Path Parameters

| Name                                               | Type    | Description                     |
| -------------------------------------------------- | ------- | ------------------------------- |
| sender\_name\_id<mark style="color:red;">\*</mark> | integer | Идентификатор имени отправителя |

#### Headers

| Name                                            | Type   | Description       |
| ----------------------------------------------- | ------ | ----------------- |
| Authorization<mark style="color:red;">\*</mark> | string | `Basic {TOKEN_2}` |

::::::{tab-set}

:::::{tab-item} 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"
}
```
:::::


:::::{tab-item} 401

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

::::{tab-set}

:::{tab-item} 4012

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


:::{tab-item} 4010

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

::::

:::::


:::::{tab-item} 403

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

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


:::::{tab-item} 422

Запрашиваемое имя отправителя не существует.

```
{
    "error": {
        "code": 4220,
        "msg": "Client 5 hasn't sender name 10000"
    }
}
```
:::::

::::::


## Описание объекта имени отправителя <a href="#sender-name-object" id="sender-name-object"></a>

| Параметр         | Тип     | Описание                                                                                        |
| ---------------- | ------- | ----------------------------------------------------------------------------------------------- |
| id               | integer | Идентификатор имени отправителя                                                                 |
| senderName       | string  | Имя отправителя                                                                                 |
| channelType      | string  | [Канал трафика](../extra/references/#sender-name-channels)                                      |
| counteragentName | string  | Имя юрлица                                                                                      |
| counteragentInn  | string  | ИНН юрлица                                                                                      |
| dateFrom         | string  | Дата начала действия                                                                            |
| dateTo           | string  | Дата окончания действия                                                                         |
| commonType       | string  | [Тип](../extra/references/#sender-name-types)                                                   |
| brand            | string  | [Оператор](../extra/references/#sender-name-brands) (возвращается при `channelType=SMS`)        |
| countryCode      | string  | [Код страны](../extra/references/#sender-name-countries) (возвращается при `channelType=VIBER`) |
| status           | string  | [Статус](../extra/references/#sender-name-states)                                               |
| fee              | number  | Абонентская плата                                                                               |
| managerComment   | string  | Комментарий менеджера                                                                           |
| rejectedAt       | string  | Дата отклонения                                                                                 |

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

<mark style="color:blue;">`GET`</mark> `https://direct.i-dgtl.ru/api/v1/sender-names`

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

#### Query Parameters

| Name          | Type   | Description                                                                  |
| ------------- | ------ | ---------------------------------------------------------------------------- |
| channel\_type | string | Фильтрация по каналам                                                        |
| brand         | string | <p>Фильтрация по операторам<br><em>Множественный параметр</em></p>           |
| country\_code | string | <p>Фильтрация по странам<br><em>Множественный параметр</em></p>              |
| common\_type  | string | Фильтрация по типу отправителей                                              |
| status        | string | <p>Фильтрация по статусу отправителей<br><em>Множественный параметр</em></p> |

#### Headers

| Name                                            | Type   | Description       |
| ----------------------------------------------- | ------ | ----------------- |
| Authorization<mark style="color:red;">\*</mark> | string | `Basic {TOKEN_2}` |

::::::{tab-set}

:::::{tab-item} 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"
  }
]
```
:::::


:::::{tab-item} 401 Использование невалидного токена

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


:::::{tab-item} 403 Использование неподходящего токена

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


:::::{tab-item} 422 Невалидное значение параметров запроса; ниже приведены несколько примеров ответа

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

::::::


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

| Параметр      | Варианты                                                               |
| ------------- | ---------------------------------------------------------------------- |
| channel\_type | [Каналы имен отправителей](../extra/references/#sender-name-channels)  |
| brand         | [Операторы имен отправителей](../extra/references/#sender-name-brands) |
| countryCode   | [Страны имен отправителей](../extra/references/#sender-name-countries) |
| common\_type  | [Типы имен отправителей](../extra/references/#sender-name-types)       |
| status        | [Статусы имен отправителей](../extra/references/#sender-name-states)   |

## Пример запроса <a href="#example" id="example"></a>

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

::::::{tab-set}

:::::{tab-item} 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==
```
:::::


:::::{tab-item} 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=='
```
:::::

::::::