LINE API

/createLineMessage устарел

Новые интеграции должны использовать Messaging API v2 — передайте platforms: ["LINE"] в Notify и используйте блок line внутри payload.content.localized_content. См. руководство по миграции. Для сообщений с изображениями, каруселями или flex-шаблонами предварительно настройте их как шаблоны LINE в вашей Панели управления Pushwoosh и ссылайтесь на код шаблона через line.template.

Примечание

Перед отправкой сообщений LINE убедитесь, что платформа Line настроена правильно. Узнать больше

createLineMessage Устарел

Используется для отправки сообщений LINE пользователям

POST https://api.pushwoosh.com/json/1.3/createLineMessage

Отправка текстового сообщения

Простые сообщения LINE, состоящие только из обычного текста, без изображений и кнопок. Узнать больше

Совет: Для расширенного форматирования и мультимедийного контента используйте шаблоны сообщений, такие как Flex, изображение или карусель.

Тело запроса

Параметр	Тип	Обязательный	Описание
application	string	Да	Код приложения Pushwoosh
auth	string	Да	Токен доступа API для аутентификации запроса.
notifications	array of objects	Да	Список объектов сообщений LINE для отправки.
content	string	Да	Текст сообщения LINE для отправки. Максимальное количество символов: 5000. Примечание: Если указаны и preset, и content, значение из запроса переопределяет preset.
preset	string	Нет	Код пресета LINE, созданного вами в Панели управления Pushwoosh. Примечание: Если указаны и preset, и content, значение из запроса переопределяет preset.
send_date	string	Да	Дата и время отправки сообщения. Используйте формат YYYY-MM-DD HH:mm или now для немедленной отправки.
devices	array of strings	Да	Список кодов устройств (User ID) для отправки сообщения LINE.

{
    "request": {
    "application": "XXXXXX-XXXXXX",
    "auth": "**************************************",
        "notifications": [
            {
                "content": "test",
                "preset": "preset_code",
                "send_date":"now",
                "devices": ["XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"]
            }
        ]
    }
}

Отправка сообщения с изображением

Вы можете отправить сообщение с изображением пользователям LINE, указав объект изображения в поле шаблона вашего запроса.

Каждое сообщение с изображением требует два URL-адреса изображения: один для полноразмерного изображения (image_url) и другой для предпросмотра (preview_image_url). Когда пользователи нажимают на предпросмотр, открывается полноразмерное изображение. Убедитесь, что оба URL-адреса используют HTTPS (TLS 1.2 или новее) и ведут на общедоступные файлы изображений.

Для получения подробной информации см. раздел Image Message в документации LINE Messaging API.

Тело запроса

Параметр	Тип	Обязательный	Описание
application	string	Да	Код приложения Pushwoosh
auth	string	Да	Токен доступа API, используемый для аутентификации запроса.
notifications	array of objects	Да	Список сообщений для отправки.
content	string	Да	Используется в качестве резервного текста или текста для предпросмотра сообщения. Код пресета LINE, созданного вами в Панели управления Pushwoosh. Примечание: Если указаны и preset, и template, используется template из запроса. Если указаны и preset, и content, content из запроса переопределяет пресет.
send_date	string	Да	Дата и время отправки сообщения. Используйте формат YYYY-MM-DD HH:mm или now для немедленной отправки.
devices	array of strings	Да	Список кодов устройств (User ID) для отправки сообщения LINE.
preset	string	Нет	Код пресета LINE, созданного вами в Панели управления Pushwoosh. Примечание: Если в запросе указаны и preset, и template, значения из template переопределят те, что определены в пресете. Если в одном запросе указаны и preset, и content, content, предоставленный непосредственно в запросе, переопределит контент из preset.
template	object	Да	Шаблон макета сообщения. Поддерживает несколько типов сообщений. Подробности см. ниже.

Параметры шаблона

Тип: image

Параметр	Тип	Обязательный	Описание
image_url	string	Да	URL полноразмерного изображения (должен использовать HTTPS). Максимальная длина: 2000 символов. Формат: JPEG, PNG. Максимальный размер: 10 МБ.
preview_image_url	string	Да	URL изображения для предпросмотра, отображаемого в чате (должен использовать HTTPS). Максимальная длина: 2000 символов. Формат: JPEG, PNG. Максимальный размер: 1 МБ.

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

{
  "request": {
    "application": "XXXXXX-XXXXXX",
    "auth": "**************************************",
    "notifications": [
      {
        "content": "test",
        "send_date": "now",
        "devices": [
          "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
        ],
        "preset": "preset_code",
        "template": {
          "en": {
            "image": {
              "alt_text": "some text",
              "image_url": "https://images.com/1.jpg",
              "preview_image_url": "https://images.com/1.png"
            }
          }
        }
      }
    ]
  }
}

Отправка сообщения с каруселью изображений

Сообщения с каруселью изображений позволяют отображать несколько изображений в формате с горизонтальной прокруткой. Каждое изображение отображается как отдельная, некликабельная колонка, которую пользователи могут пролистывать в интерфейсе чата LINE.

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

Для получения подробной информации см. раздел Image Carousel Template в документации LINE Messaging API.

Тело запроса

Параметр	Тип	Обязательный	Описание
application	string	Да	Код приложения Pushwoosh
auth	string	Да	Токен доступа API, используемый для аутентификации запроса.
notifications	array of objects	Да	Список сообщений для отправки.
content	string	Да	Используется в качестве резервного текста или текста для предпросмотра сообщения. Примечание: Если установлены и content, и template, используется template. Если в одном запросе указаны и preset, и content, content, предоставленный непосредственно в запросе, переопределит контент из preset.
send_date	string	Да	Дата и время отправки сообщения. Используйте формат YYYY-MM-DD HH:mm или now.
devices	array of strings	Да	Список кодов устройств (User ID) для отправки сообщения LINE.
preset	string	Нет	Код пресета LINE, созданного вами в Панели управления Pushwoosh. Примечание: Если в запросе указаны и preset, и template, значения из template переопределят те, что определены в preset. Если в одном запросе указаны и preset, и content, content, предоставленный непосредственно в запросе, переопределит контент из preset.
template	object	Да	Шаблон макета сообщения. Поддерживает несколько типов сообщений. Подробности см. ниже.

Параметры шаблона

Тип: image_carousel

Параметр	Тип	Обязательный	Описание
alt_text	string	Да	Резервный текст, отображаемый в превью пушей и на неподдерживаемых устройствах. Максимум 400 символов.
columns	array of objects	Да	Массив колонок с изображениями (поддерживается от 1 до 10). Каждая колонка содержит изображение.
image_url	string	Да	URL изображения, отображаемого в каждой колонке карусели, указывающий на общедоступный файл JPEG или PNG. Должен использовать HTTPS.

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

{
  "request": {
    "application": "XXXXXX-XXXXXX",
    "auth": "**************************************",
    "notifications": [
      {
        "content": "test",
        "send_date": "now",
        "devices": [
          "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
        ],
        "preset": "preset_code",
        "template": {
          "en": {
            "image_carousel": {
              "alt_text": "some text",
              "columns": [
                { "image_url": "https://images.com/1.jpg" },
                { "image_url": "https://images.com/2.jpg" },
                { "image_url": "https://images.com/3.jpg" }
              ]
            }
          }
        }
      }
    ]
  }
}

Отправка Flex-сообщения

Flex-сообщения — это мощный, настраиваемый тип сообщений, который позволяет создавать структурированные макеты с использованием текста, изображений, кнопок и других компонентов. Они идеально подходят для таких случаев, как квитанции, карточки товаров, меню или любой контент, которому полезна визуальная структуризация.

Чтобы отправить Flex-сообщение, включите в свой запрос объект template с полезной нагрузкой raw. Макет сообщения должен соответствовать спецификации LINE Flex Message.

Совет: Вы можете создавать и просматривать Flex-сообщения с помощью симулятора LINE Flex Message.

Тело запроса

Параметр	Тип	Обязательный	Описание
application	string	Да	Код приложения Pushwoosh
auth	string	Да	Токен доступа API, используемый для аутентификации запроса.
notifications	array of objects	Да	Список сообщений для отправки.
content	string	Да	Используется в качестве резервного текста или текста для предпросмотра сообщения. Примечание: Если установлены и content, и template, используется шаблон. Если указаны и preset, и content, контент из запроса переопределяет пресет.
send_date	string	Да	Когда отправить сообщение. Используйте формат now или YYYY-MM-DD HH:mm.
devices	array of strings	Да	Список токенов устройств LINE (User ID) для получения сообщения.
preset	string	Нет	Код пресета LINE, созданного вами в Панели управления Pushwoosh. Примечание: Если указаны и preset, и template, шаблон переопределяет пресет. Если указаны и preset, и content, контент из запроса переопределяет пресет.
template	object	Да	Шаблон макета сообщения. Поддерживает несколько типов сообщений. Подробности см. ниже.

Параметры шаблона

Для Flex-сообщения используйте raw-структуру.
Тип: raw (Flex)

Параметр	Тип	Обязательный	Описание
alt_text	string	Да	Резервный текст, отображаемый в уведомлениях, превью чатов и цитатах. Максимум 400 символов.
content	object	Да	Макет Flex-сообщения, структурированный с использованием bubble, box, text и других компонентов в соответствии со спецификацией Flex от LINE.

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

{
  "request": {
    "application": "XXXXXX-XXXXXX",
    "auth": "**************************************",
    "notifications": [
      {
        "content": "test",
        "send_date": "now",
        "devices": ["XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"],
        "preset": "preset_code",
        "template": {
          "en": {
            "raw": {
              "alt_text": "My raw template",
              "content": {
                "type": "bubble",
                "body": {
                  "type": "box",
                  "layout": "vertical",
                  "contents": [
                    {
                      "type": "text",
                      "text": "RECEIPT",
                      "weight": "bold",
                      "color": "#1DB446",
                      "size": "sm"
                    }
                    // Additional components...
                  ]
                }
              }
            }
          }
        }
      }
    ]
  }
}