應用 API 元件 - Messenger

功能簡介

JSON API 是一個進階元件,提供您強大的自由度與功能。透過 JSON API,您將可以連結機器人與您的伺服器後端,完成高度彈性的回應與額外功能。
您可以發送多種不同 HTTP 請求方法,讓機器人解析您的伺服器回應並回覆訊息。
具體而言,您將可以執行:
  1. 1.
    創建動態訊息
  2. 2.
    執行 postbacks
  3. 3.
    取得並設定使用者參數(即將到來)
  4. 4.
    轉向其他節點(即將到來)

回傳參考

我們將解析您回傳的 JSON,以此為根據發送訊息給您的顧客。更多訊息請參考 Messenger API 文件

發送文字

以下回應將發送文字訊息。
1
{
2
"messages": [
3
{ "text": "歡迎使用最聰明的聊天機器人平台 —— YOCTOL.AI" },
4
{ "text": "您打算創建怎樣的機器人呢?" }
5
]
6
}
Copied!

發送圖片

目前圖片格式支援 JPG、PNG、GIF,以下回應將發送圖片訊息。
1
{
2
"messages": [
3
{
4
"attachment": {
5
"type": "image",
6
"payload": {
7
"url": "https://yoctol.ai/images/logo.svg"
8
}
9
}
10
}
11
]
12
}
Copied!
您也可以發送既有的 Facebook 貼文圖片,這樣就不用重新上傳囉!
1
{
2
"messages": [
3
{
4
"attachment": {
5
"type": "template",
6
"payload": {
7
"template_type": "media",
8
"elements": [
9
{
10
"media_type": "image",
11
"url": "https://www.facebook.com/Yoctol/photos/2200581453590553",
12
"buttons": [
13
{
14
"title": "前往 Yoctol!",
15
"type": "web_url",
16
"url": "https://www.yoctol.com/"
17
}
18
]
19
}
20
]
21
}
22
},
23
"quick_replies": [
24
{
25
"content_type": "text",
26
"title": "我也想加入優拓!",
27
"payload": <TEXT PAYLOAD>
28
}
29
]
30
}
31
]
32
}
Copied!

發送影片

以下回應將發送影片檔案。目前 Messenger 僅支援 25MB 以下的 MP4。
1
{
2
"messages": [
3
{
4
"attachment": {
5
"type": "video",
6
"payload": {
7
"url": "https://ytstatic.blob.core.windows.net/yoctol-ai-website/landing-page.mp4"
8
}
9
}
10
}
11
]
12
}
Copied!
當然,您也可以使用既有的 Facebook 貼文影片來發送!
1
{
2
"messages": [
3
{
4
"attachment": {
5
"type": "template",
6
"payload": {
7
"template_type": "media",
8
"elements": [
9
{
10
"media_type": "video",
11
"url": "https://www.facebook.com/Yoctol/videos/1733376656977704/",
12
"buttons": [
13
{
14
"title": "來看看 Yoctol",
15
"type": "web_url",
16
"url": "https://www.yoctol.com/"
17
}
18
]
19
}
20
]
21
}
22
},
23
"quick_replies": [
24
{
25
"content_type": "text",
26
"title": "That's cool!",
27
"payload": <TEXT PAYLOAD>
28
}
29
]
30
}
31
]
32
}
Copied!

發送語音

以下回應將發送語音檔案;目前 Messenger 僅支援 25MB 以下的 MP3、OCG、WAV 語音檔。
1
{
2
"messages": [
3
{
4
"attachment": {
5
"type": "audio",
6
"payload": {
7
"url": "https://ccrma.stanford.edu/~jos/mp3/bachfugue.mp3"
8
}
9
}
10
}
11
]
12
}
Copied!

發送檔案

以下回應將發送檔案。目前 Messenger 僅支援 25MB 以下的檔案,不分檔案類型。
1
{
2
"messages": [
3
{
4
"attachment": {
5
"type": "file",
6
"payload": {
7
"url": "http://www.africau.edu/images/default/sample.pdf"
8
}
9
}
10
}
11
]
12
}
Copied!

發送圖文模組

以下回應將發送圖文模組。請注意圖文模組中的每一個項目都包含圖片、描述、與按鈕。
1
{
2
"messages": [
3
{
4
"attachment": {
5
"type": "template",
6
"payload": {
7
"template_type": "generic",
8
"image_aspect_ratio": "square",
9
"elements": [
10
{
11
"title": "Yoctol Image 1",
12
"image_url": "https://www.yoctol.com/images/amazingBrain.png",
13
"subtitle": "Size: M",
14
"buttons": [
15
{
16
"type": "web_url",
17
"url": "https://www.yoctol.com",
18
"title": "View Item"
19
}
20
]
21
},
22
{
23
"title": "Yoctol Image 2",
24
"image_url": "https://www.yoctol.com/images/amazingBrain.png",
25
"subtitle": "Size: L",
26
"default_action": {
27
"type": "web_url",
28
"url": "https://www.yoctol.com",
29
},
30
"buttons": [
31
{
32
"type": "web_url",
33
"url": "https://www.yoctol.com",
34
"title": "View Item"
35
}
36
]
37
}
38
]
39
}
40
}
41
}
42
]
43
}
Copied!

發送清單範本

以下回應將發送清單範本,更多設定請參考 Messenger 清單範本
1
{
2
"messages": [
3
{
4
"attachment": {
5
"type": "template",
6
"payload": {
7
"template_type": "list",
8
"top_element_style": "large",
9
"elements": [
10
{
11
"title": "Yoctol List Image 1",
12
"image_url": "https://www.yoctol.com/images/amazingBrain.png",
13
"subtitle": "Size: M",
14
"buttons": [
15
{
16
"type": "web_url",
17
"url": "https://www.yoctol.com",
18
"title": "查看商品"
19
}
20
]
21
},
22
{
23
"title": "Yoctol List Image 2",
24
"image_url": "https://www.yoctol.com/images/amazingBrain.png",
25
"subtitle": "Size: L",
26
"default_action": {
27
"type": "web_url",
28
"url": "https://www.yoctol.com",
29
},
30
"buttons": [
31
{
32
"type": "web_url",
33
"url": "https://www.yoctol.com",
34
"title": "查看商品"
35
}
36
]
37
}
38
]
39
}
40
}
41
}
42
]
43
}
Copied!

按鈕

以下回應將發送按鈕。您可以設定各個按鈕的動作,例如打開網站。更多關於按鈕的用法,請參考 Messenger 按鈕
1
{
2
"messages": [
3
{
4
"attachment": {
5
"type": "template",
6
"payload": {
7
"template_type": "button",
8
"text": "您好",
9
"buttons": [
10
{
11
"type": "web_url",
12
"url": "https://www.yoctol.com",
13
"title": "打開網站"
14
}
15
]
16
}
17
}
18
}
19
]
20
}
Copied!
另外您也可以傳送特殊按鈕,例如撥打電話、分享。
1
{
2
"messages": [
3
{
4
"attachment": {
5
"type": "template",
6
"payload": {
7
"template_type": "generic",
8
"elements": [
9
{
10
"title": "想知道更多嗎?",
11
"image_url": "https://www.yoctol.com/images/amazingBrain.png",
12
"subtitle": "可以和我們直接聯絡!若覺得我們的服務很棒,請不吝分享給大家!",
13
"buttons": [
14
{
15
"type": "phone_number",
16
"phone_number": "+886223222168",
17
"title": "打給客服"
18
},
19
{
20
"type": "element_share"
21
}
22
]
23
}
24
]
25
}
26
}
27
}
28
]
29
}
Copied!

快速回覆

以下回應將發送快速回覆。
1
{
2
"messages": [
3
{
4
"text": "請問你喜歡剛才提供的餐點嗎?",
5
"quick_replies": [
6
{
7
"title": "超愛!",
8
}
9
]
10
}
11
]
12
}
Copied!
Last modified 2yr ago
Copy link