Push (Partner Limit)

概述

當您需要向特定的用戶發送個性化的訊息時，您可以利用 FIRST LINE 的 PUSH API 來進行整合。這種整合方式可以讓您更有效地傳達訊息。

此外，使用 PUSH API 也可以幫助您節省時間和資源，因為您不需要自己從頭開始建立訊息傳遞系統。只需簡單的幾步操作，您就可以開始發送個性化的訊息給您的用戶。

API

curl -X POST
    -H "Content-Type: application/json"
    目前為商業夥伴限定，暫不開放。

Response

回傳為 JSON 格式，而 HTTP status 為代碼 200，表示發送成功。

{}

URL Parameters

Parameter	Description
contactable_type	管道類型包括以下選項： 即時聊天：App\LivechatContact LINE OA：App\LineContact Facebook Messenger：App\FbContact Instagram：App\IgContact Telegram：App\TelegramContact Viber：App\ViberContact 微信：App\WechatContact
contactable_id	對應管道類型客戶系統編號
type	訊息類型分為以下幾種： text：文字 carousel：輪播 image_carousel：圖片輪播 button：按鈕 quickreply：快速回覆
message	message 資訊是根據不同的訊息類型所定義的內容。舉例來說，當 type 設定為 text 時，message 的內容可能會是 '嗨！你好嗎！'。
is_force	當交談處於某些特定狀態，如客戶正與專員對話時，預設是不允許透過API發送訊息的。但若設定值為 1，即表示將強制發送訊息，即便交談已經開始。

Message 欄位訊息格式

文字訊息 Text

{
  "type": "text",
  "message": "要傳送的文字訊息"
}

按鈕 Button

屬性	介紹
explain_text	內文描述
options[].label	按鈕或選項的文字描述
options[].value	要發送的訊息值
options[].type	選項的類型（如 text、phonenumber、url）
options[].number	電話號碼(僅在 type 為 phonenumber 時存在)
options[].url	需要開啟的網址(僅在 type 為 url 時存在)

{
  "type": "button",
  "message": {
        "explain_text": "內文描述",
        "options": [
            {
                "label": "按鈕文字",
                "value": "發送訊息",
                "type": "text"
            },
            {
                "label": "撥打電話",
                "type": "phonenumber",
                "number": "[phone]"
            },
            {
                "label": "開啟網址",
                "type": "url",
                "url": "https://www.firstline.cc/"
            }
        ]
    }
}

快速回覆 Quick Reply

屬性	介紹
explain_text	內文訊息，文字欄位
options[].label	選項的標籤
options[].value	選項的值
options[].type	選項的類型，例如：url 或 text
options[].url	當選項類型為url時，該選項對應的網址 (僅在type為url時存在)

{
  "type": "quickreply",
  "message": {
        "explain_text": "內文訊息",
        "options": [
            {
                "label": "#001",
                "value": "001",
                "type": "url",
                "url": "https://www.firstline.cc/"
            },
            {
                "label": "#002",
                "value": "002",
                "type": "text"
            },
            {
                "label": "#003",
                "value": "003",
                "type": "text"
            }
        ]
    }
}

輪播訊息 Carousel

用於發送可左右滑動的輪播內容。每一個輪播項目均包含圖片、簡短的描述與按鈕。

屬性	介紹
alt_text	提示消息或當消息格式不受支援時發送
columns[].image_url	背景圖片的URL地址
columns[].title	標題
columns[].text	文本描述
columns[].actions[].text	操作按鈕或連結的文本
columns[].actions[].value	操作按鈕或連結的值
columns[].actions[].url	操作按鈕或連結的URL (僅在type為url時存在)
columns[].actions[].type	操作按鈕或連結的類型，例如：url 或 text
columns[].actions[].label	操作按鈕或連結的標籤 (如果存在)

{
  "type": "carousel",
  "message": {
    "alt_text": "Message format not supported.",
    "columns": [
      {
        "image_url": "https://www.firstline.cc/assets/images/illustration/header.png",
        "title": "全方位客服系統",
        "text": "整合多種溝通管道，包括電話、LINE、Facebook、即時聊天、WhatsApp等，讓您能高效地提供客戶支援和銷售服務。",
        "actions": [
          {
            "text": "Nike",
            "value": "Nike",
            "url": "https://www.firstline.cc/",
            "type": "url"
          },
          {
            "label": null,
            "value": null,
            "type": "url",
            "url": "https://www.firstline.cc/",
            "text": "FIRST LINE 客服系統"
          },
          {
            "label": null,
            "value": "其他",
            "type": "text",
            "url": null,
            "text": "其他"
          }
        ]
      },
    ]
}

圖片輪播 Image Carousel

屬性	介紹
alt_text	提示消息或當消息格式不受支援時發送
columns[].image_url	背景圖片的URL地址
columns[].action.type	操作的類型（可能為null），例如：url 或 text
columns[].action.url	操作的URL地址（可能為null）
columns[].action.value	操作的值（可能為null）
columns[].button.text	按鈕的文本
columns[].button.background_color	按鈕的背景顏色，為 HEX 顏色代碼
columns[].button.border_color	按鈕的邊框顏色，為 HEX 顏色代碼
columns[].button.color	按鈕的文字顏色，為 HEX 顏色代碼
columns[].badge.text	標籤的文本
columns[].badge.background_color	標籤的背景顏色，為 HEX 顏色代碼
columns[].badge.border_color	標籤的邊框顏色，為 HEX 顏色代碼
columns[].badge.color	標籤的文字顏色，為 HEX 顏色代碼

{
    "type": "image_carousel",
    "message": {
        "alt_text": "Message format not supported.",
        "columns": [
            {
                "image_url": "https://www.firstline.cc/assets/images/illustration/header.png",
                "action": {
                    "type": null,
                    "url": null,
                    "value": null
                },
                "button": {
                    "text": "立即註冊",
                    "background_color": "#09091A",
                    "border_color": "#09091A",
                    "color": "#09091A"
                },
                "badge": {
                    "text": "SALE",
                    "background_color": "#eb4d4b",
                    "border_color": "#eb4d4b",
                    "color": "#FFFFFF"
                }
            }
        ]
    }
}