# Отправка MMS

## Отправка MMS-сообщений

<mark style="color:green;">`POST`</mark> `https://direct.i-dgtl.ru/api/v1/message`

Метод позволяет отправлять массив одиночных сообщений **(от 1 до 1000)**

#### Headers

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

#### Request Body

Чтобы прикрепить изображение, используйте поле imageUrl для отправки MMS абонентам МТС. Для отправки абонентам МегаФона добавьте хэш изображения в поле imageHash.

| Name                                                  | Type    | Description                                                                                                                                                                                                                                                                                              |
| ----------------------------------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| channelType<mark style="color:red;">\*</mark>         | string  | Канал отправки (`MMS`)                                                                                                                                                                                                                                                                                   |
| senderName<mark style="color:red;">\*</mark>          | string  | Имя отправителя. Необходимо использовать SMS-имена в статусе "Одобрено"                                                                                                                                                                                                                                  |
| destination<mark style="color:red;">\*</mark>         | string  | Номер абонента                                                                                                                                                                                                                                                                                           |
| content<mark style="color:red;">\*</mark>             | object  | Контент сообщения                                                                                                                                                                                                                                                                                        |
| content.contentType<mark style="color:red;">\*</mark> | string  | Тип контента, всегда `text`                                                                                                                                                                                                                                                                              |
| content.text<mark style="color:red;">\*</mark>        | string  | Текст сообщения. От 1 до 268 символов                                                                                                                                                                                                                                                                    |
| content.title                                         | string  | Заголовок сообщения. От 1 до 30 символов                                                                                                                                                                                                                                                                 |
| imageUrl<mark style="color:red;">\*</mark>            | string  | Ссылка на изображение. Наличие изображения является обязательным условиям для отправки                                                                                                                                                                                                                   |
| imageHash                                             | string  | Поле для хэша изображения для отправки абонентам «МегаФона». Для получения хэша обратитесь к вашему менеджеру                                                                                                                                                                                            |
| tags                                                  | array   | Теги сообщения (массив строк). Каждый тег должен соответствовать выражению `^\w+$` (допускаются буквы в любом регистре, цифры и нижнее подчеркивание "\_")                                                                                                                                               |
| useLocalTime                                          | boolean | <p>Флаг, отвечающий за таймзону, в которой будет отправлено сообщение:<br><strong><code>true</code></strong> – отправка в таймзоне абонента<br><strong><code>false</code></strong> – отправка по МСК<br><em>По умолчанию true</em></p>                                                                   |
| localSendTime                                         | string  | <p>Нижняя граница допустимого времени отправки сообщения (с учетом значения<code>useLocalTime</code>)<br>Дата в формате <code>YYYY-MM-DD hh:mm:ss</code> в диапазоне от (текущее время в UTC - 12 часов) до (текущее время в UTC + 7 дней)<br><em>По умолчанию сообщение будет отправлено сразу</em></p> |
| localCompletionTime                                   | string  | Верхняя граница допустимого времени отправки сообщения (с учетом `useLocalTime`) в диапазоне от `localSendTime` до (текущее время в UTC + 70 дней)                                                                                                                                                       |
| ttl                                                   | integer | <p>Время жизни сообщения в секундах. По истечении ttl сообщению устанавливается финальный статус.<br><code>60 ≤ ttl ≤ 86400</code></p>                                                                                                                                                                   |
| hours                                                 | array   | Допустимые часы отправки (массив чисел). В массиве могут быть переданы целые числа от 0 до 23, каждое из которых соответствует разрешенному для отправки интервалу с учетом `useLocalTime`; значения должны быть уникальны.                                                                              |
| days                                                  | array   | Допустимые дни отправки (массив чисел). В массиве могут быть переданы целые числа от 1 (пн) до 7 (вс), каждое из которых соответствует разрешенному для отправки дню недели; значения должны быть уникальны.                                                                                             |
| shortUrl                                              | boolean | <p>Флаг, отвечающий за сокращение ссылок в сообщении:<br><code>true</code> - ссылки в тексте сообщения и кнопках будут сокращены<br>По умолчанию false</p>                                                                                                                                               |
| callbackUrl                                           | string  | Адрес для отправки callback                                                                                                                                                                                                                                                                              |
| callbackEvents                                        | array   | События, по которым будут отправлены callback (массив строк). При наличии `callbackUrl` и отсутствии `callbackEvents` в запросе, будет отправлен callback по событию `delivered`.                                                                                                                        |
| externalMessageId                                     | string  | Внутренний id сообщения в вашей системе. До 100 символов.                                                                                                                                                                                                                                                |

::::::{tab-set}

:::::{tab-item} 200

В случае успешного запроса возвращается ответ, в котором перечислены идентификаторы сообщений и коды результата. При значении errors = false гарантируется, что все переданные сообщения успешно созданы.

```
{
  "errors": false,
  "items": [
    {
      "messageUuid": "063474ec-a34f-4558-90c5-984395000004",
      "code": 201
    },
    {
      "messageUuid": "063564ec-a34f-4558-90c5-984395000005",
      "code": 201
    }
  ]
}
```
:::::


:::::{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": "Invalid msisdn"
    }
}
-----------------------------------------------------------------------------
{
    "error": {
        "code": 4220,
        "msg": "Invalid text length in viber content (0)"
    }
}
-----------------------------------------------------------------------------
{
    "error": {
        "code": 4220,
        "msg": "Invalid caption length in viber content (3)"
    }
}
-----------------------------------------------------------------------------
{
    "error": {
        "code": 4220,
        "msg": "Invalid caption length in viber content (3)"
    }
}
```
:::::


:::::{tab-item} 402

Payment Required. Недостаточно средств на балансе.

```javascript
{
    "error": {
        "code": 402,
        "msg": "Insufficient funds"
    }
}
```
:::::

::::::


{% hint style="warning" %}
Рекомендуемое время ожидания ответа: 70 секунд.\
Как правило, ответ на запрос возвращается не более чем за несколько секунд, но таймаут величиной в 70 секунд позволяет гарантированно получить ответ на запрос, в том числе в ситуациях повышенной нагрузки.
{% endhint %}

{% hint style="info" %}
Для использования личного домена в сокращенных ссылках необходимо обратиться в поддержку
{% endhint %}

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

| Параметр       | Варианты                                                              |
| -------------- | --------------------------------------------------------------------- |
| callbackEvents | [События для отправки callback](../extra/references/#callback-events) |



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

::::::{tab-set}

:::::{tab-item} JSON

```
POST https://direct.i-dgtl.ru/api/v1/message
Authorization: Basic QWxhZGRpbjpvc...
Content-Type: application/json
[
  {
    "senderName": "SENDER",
    "channelType": "MMS",
    "content": {
      "contentType": "text",
      "text": "Текст MMS-сообщения",
      "imageUrl": "Ссылка на изображение для МТС"
      "imageHash": "Хэш изображения для МегаФон"
    },
    "destination": "79999999999"
  }
]
```
:::::


:::::{tab-item} cURL

```
curl -X POST 'https://direct.i-dgtl.ru/api/v1/message' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic QWxhZGRpbjpvc...' \
-d '[{"senderName":"i-digital_bot","channelType":"MMS","content":{"contentType":"text","text":"Текст MMS-сообщения", "imageUrl": "Ссылка на изображение", "imageHash": "Ссылка на хэш"},"destination":"79999999999"}]'
```
:::::

::::::


{% hint style="info" %}
В примере указан минимальный набор параметров, который позволяет моментально отправить MMS-сообщение. Вы можете кастомизировать контент, время отправки, настроить коллбэки, добавить теги и внутренний идентификатор, используя опциональные параметры, описанные выше на данной странице.&#x20;
{% endhint %}
