跳到内容
用户指南支持 请求演示 登录
Pushwoosh.com

LINE API

createLineMessage

Anchor link to

用于向用户发送 LINE 消息

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

发送文本消息

Anchor link to

仅包含纯文本、不带图片或按钮的简单 LINE 消息。了解更多

提示： 如需高级格式和富媒体，请使用 Flex、图片 或 轮播 等消息模板。

请求正文
Anchor link to
参数
类型
必需描述
application字符串是Pushwoosh application code
auth字符串是用于验证请求的 API access token。
notifications对象数组是要发送的 LINE 消息对象列表。
content字符串是要发送的 LINE 消息的文本。最大字符限制：5000。
注意： 如果同时包含 preset 和 content，请求中的值将覆盖 preset。
preset字符串否您在 Pushwoosh Control Panel 中创建的 LINE preset 的代码。注意： 如果同时包含 preset 和 content，请求中的值将覆盖 preset。
send_date字符串是发送消息的日期和时间。使用 YYYY-MM-DD HH:mm 格式或 now 立即发送。
devices字符串数组是要发送 LINE 消息的设备代码（用户 ID）列表。
{
    "request": {
    "application": "XXXXXX-XXXXXX",
    "auth": "**************************************",
        "notifications": [
            {
                "content": "test",
                "preset": "preset_code",
                "send_date":"now",
                "devices": ["XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"]
            }
        ]
    }
}

发送图片消息

Anchor link to

您可以通过在请求的 template 字段中指定一个图片对象，向 LINE 用户发送图片消息。

每条图片消息都需要两个图片 URL：一个用于全尺寸图片 (image_url)，另一个用于预览图片 (preview_image_url)。当用户点击预览图时，会打开全尺寸图片。请确保两个 URL 都使用 HTTPS（TLS 1.2 或更高版本），并链接到可公开访问的图片文件。

有关详细信息，请参阅 LINE Messaging API 文档中的图片消息部分。

请求正文
Anchor link to
参数
类型
必需描述
application字符串是Pushwoosh application code
auth字符串是用于验证请求的 API access token。
notifications对象数组是要发送的消息列表。
content字符串是用作消息的备用或预览文本。您在 Pushwoosh Control Panel 中创建的 LINE preset 的代码。
注意： 如果同时包含 preset 和 template，则使用请求中的 template。
如果同时包含 preset 和 content，请求中的 content 将覆盖 preset。
send_date字符串是发送消息的日期和时间。使用 YYYY-MM-DD HH:mm 格式或 now 立即发送。
devices字符串数组是要发送 LINE 消息的设备代码（用户 ID）列表。
preset字符串否您在 Pushwoosh Control Panel 中创建的 LINE preset 的代码。
注意： 如果请求中同时包含 preset 和 template 参数，template 中的值将覆盖 preset 中定义的值。
如果同一请求中同时包含 preset 和 content，请求中直接提供的 content 将覆盖 preset 中的内容。
template对象是消息布局模板。支持多种消息类型。详见下文。
模板参数
Anchor link to

类型： image

参数
类型
必需描述
image_url字符串是全尺寸图片的 URL（必须使用 HTTPS）。最大长度： 2000 个字符。格式： JPEG、PNG。最大大小： 10 MB。
preview_image_url字符串是聊天中显示的预览图片的 URL（必须使用 HTTPS）。最大长度： 2000 个字符。格式： JPEG、PNG。最大大小： 1 MB。
请求示例
Anchor link to
{
  "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"
            }
          }
        }
      }
    ]
  }
}

发送图片轮播消息

Anchor link to

图片轮播消息允许您以水平滚动的格式显示多张图片。每张图片都显示为一个独立的、不可点击的列，用户可以在 LINE 聊天界面中滑动浏览。

这种格式非常适合以引人入胜的方式展示商品、促销活动或视觉选择。

有关详细信息，请参阅 LINE Messaging API 文档中的图片轮播模板部分。

请求正文
Anchor link to
参数
类型
必需描述
application字符串是Pushwoosh application code
auth字符串是用于验证请求的 API access token。
notifications对象数组是要发送的消息列表。
content字符串是用作消息的备用或预览文本。
注意： 如果同时设置了 content 和 template，则使用 template。
如果同一请求中同时包含 preset 和 content，请求中直接提供的 content 将覆盖 preset 中的内容。
send_date字符串是发送消息的日期和时间。使用 YYYY-MM-DD HH:mm 格式或 "now"。
devices字符串数组是要发送 LINE 消息的设备代码（用户 ID）列表。
preset字符串否您在 Pushwoosh Control Panel 中创建的 LINE preset 的代码。
注意： 如果请求中同时包含 preset 和 template 参数，template 中的值将覆盖 preset 中定义的值。
如果同一请求中同时包含 preset 和 content，请求中直接提供的 content 将覆盖 preset 中的内容。
template对象是消息布局模板。支持多种消息类型。详见下文。
模板参数
Anchor link to

类型： image_carousel

参数
类型
必需描述
alt_text字符串是在推送预览和不支持的设备上显示的备用文本。最大 400 个字符。
columns对象数组是图片列数组（支持 1-10 个）。每列包含一张图片。
image_url字符串是每个轮播列中显示的图片的 URL，指向一个可公开访问的 JPEG 或 PNG 文件。必须使用 HTTPS。
请求示例
Anchor link to
{
  "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 消息

Anchor link to

Flex 消息是一种功能强大、可自定义的消息类型，允许您使用文本、图片、按钮和其他组件创建结构化布局。它们非常适合用于收据、产品卡片、菜单或任何需要视觉结构化的内容。

要发送 Flex 消息，请在请求中包含一个带有 raw 负载的 template 对象。消息布局必须遵循 LINE Flex 消息规范。

提示： 您可以使用 LINE Flex 消息模拟器来设计和预览 Flex 消息。

请求正文
Anchor link to
参数
类型
必需描述
application字符串是Pushwoosh application code
auth字符串是用于验证请求的 API access token。
notifications对象数组是要发送的消息列表。
content字符串是用作消息的备用或预览文本。
注意： 如果同时设置了 content 和 template，则使用模板。
如果同时包含 preset 和 content，请求中的内容将覆盖 preset。
send_date字符串是发送消息的时间。使用 "now" 或 YYYY-MM-DD HH:mm 格式。
devices字符串数组是接收消息的 LINE 设备令牌（用户 ID）列表。
preset字符串否您在 Pushwoosh Control Panel 中创建的 LINE preset 的代码。
注意： 如果同时包含 preset 和 template，模板将覆盖 preset。
如果同时包含 preset 和 content，请求中的内容将覆盖 preset。
template对象是消息布局模板。支持多种消息类型。详见下文。
模板参数
Anchor link to

对于 Flex 消息，请使用原始结构。 类型：raw (Flex)

参数
类型
必需描述
alt_text字符串是在通知、聊天预览和引用中显示的备用文本。最大 400 个字符。
content对象是Flex 消息布局，根据 LINE 的 Flex 规范使用 bubble、box、text 和其他组件进行结构化。
请求示例
Anchor link to
{
  "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...
                  ]
                }
              }
            }
          }
        }
      }
    ]
  }
}