數位 聊天通道 JSON 結構描述
在用Digital Experience即時聊天 客服專員和聯絡人的實時互動或聊天訊息 非同步聊天,聯絡人隨時傳送訊息並等待回覆通道傳送訊息時使用以下結構。在這些結構描述中,用於元素的所有 ID 都必須唯一。僅當您提及先前定義的元素來確保對該特定元素發生某個事件(例如回傳)時,才允許例外。
以下結構可在幫助網站上獲取:
- 轉盤
- 圖像
- Markdown
- 單個回應中包含多條訊息
- 提示
- 快速回復
- 文字
- URL
下面包含了結構。您還可以下載 ZIP 檔案,其中包含每個結構的 JSON 文字檔案。
使用Digital Experience鏡像工具驗證您計劃與即時聊天通道一起使用的 JSON。
轉盤
{
"prompts": [{
"mediaSpecificObject": {
"dfoMessage": {
"messageContent": {
"type": "PLUGIN",
"payload": {
"elements": [
{
"id": "Ek4tPy1h4",
"type": "MENU",
"elements": [
{
"id": "Uk4tPy1h2",
"type": "FILE",
"url": "https://picsum.photos/300/150",
"filename": "photo.jpg",
"mimeType": "image/jpeg"
},
{
"id": "Ck4tPy1h3",
"type": "TITLE",
"text": "Hello!"
},
{
"id": "Ek4tPy1h1",
"type": "TEXT",
"text": "Lorem Impsum..."
},
{
"id": "Nkm0hRAiE",
"type": "BUTTON",
"text": "Click me!",
"postback": "click-on-button-1"
},
{
"id": "EyCyTRCi4",
"type": "BUTTON",
"text": "Aww don`t click on me",
"postback": "click-on-button-2"
}
]
},
{
"id": "Ek4tPy1h52",
"type": "MENU",
"elements": [
{
"id": "Uk4tPy1h22",
"type": "FILE",
"url": "https://picsum.photos/300/150",
"filename": "photo.jpg",
"mimeType": "image/jpeg"
},
{
"id": "Ck4tPy1h32",
"type": "TITLE",
"text": "Hello!"
},
{
"id": "Ek4tPy1h12",
"type": "TEXT",
"text": "Lorem Impsum..."
},
{
"id": "Nkm0hRAiE2",
"type": "BUTTON",
"text": "Click me!",
"postback": "click-on-button-1"
},
{
"id": "NkGJ6CAiN2",
"type": "BUTTON",
"text": "Aww don`t click on me",
"postback": "click-on-button-2"
}
]
}
]
}
}
}
}
}
]
}
圖像
{
"prompts": [{
"mediaSpecificObject": {
"dfoMessage": {
"messageContent": {
"type": "PLUGIN",
"payload": {
"elements": [{
"id": "bf2521f4-5e85-413f-b6ed-815d1c3905f0",
"type": "FILE",
"filename": "photo.jpg",
"url": "https://picsum.photos/300/150",
"mimeType": "image/jpeg"
}
]
}
}
}
}
}
]
}
Markdown
{
"prompts": [{
"mediaSpecificObject": {
"dfoMessage": {
"messageContent": {
"type": "PLUGIN",
"payload": {
"elements": [
{
"id": "Ukm0hRAiA",
"type": "TEXT",
"mimeType": "text/markdown",
"text": "**bold text**, *italicized text*, [URL](https://www.NICE.com), ~~Strikethrough~~
1. Ordered List 1
2. Ordered List 2
3. Ordered List 3
- Bullet list 1
- Bullet list 2"
}
]
}
}
}
}
}
]
}
單個回應中的多個訊息
{
"prompts": [
{
"transcript": "This is message one.",
"base64EncodedG711ulawWithWavHeader": "",
"audioFilePath": null,
"textToSpeech": null,
"mediaSpecificObject": null
},
{
"transcript": "This is message two.",
"base64EncodedG711ulawWithWavHeader": "",
"audioFilePath": null,
"textToSpeech": null,
"mediaSpecificObject": null
},
{
"transcript": "This is message three.",
"base64EncodedG711ulawWithWavHeader": "",
"audioFilePath": null,
"textToSpeech": null,
"mediaSpecificObject": null
}
]
}
提示
{
"prompts":[{
"transcript":"Welcome! Choose Sales or Support and an agent will be with you shortly."
},
{
"mediaSpecificObject":{
"dfoMessage":{
"messageContent":{
"type":"PLUGIN",
"payload":{
"postback":"",
"elements":[{
"id":"Ek4tPy1h4",
"type":"TEXT_AND_BUTTONS",
"elements":[{
"id":"TID1",
"type":"TEXT",
"text":"Please select an option"
},
{
"id":"BID1",
"type":"BUTTON",
"text":"Sales",
"postback":"payment-button-1"
},
{
"id":"BID2",
"type":"BUTTON",
"text":"Support",
"postback":"payment-button-2"
}
]
}
]
}
}
}
}
}
]
}
快速回覆
{
"prompts": [{
"mediaSpecificObject": {
"dfoMessage": {
"messageContent": {
"type": "QUICK_REPLIES",
"fallbackText": "Text sent if rich message is not available on external platform",
"payload": {
"text": {
"content": "Prompt text"
},
"actions": [
{
"type": "REPLY_BUTTON",
"text": "Button1Text",
"postback": "/Button1"
},
{
"type": "REPLY_BUTTON",
"text": "Button2Text",
"postback": "/Button1"
}
]
}
}
}
}
}
]
}
文字
{
"prompts": [{
"mediaSpecificObject": {
"dfoMessage": {
"messageContent": {
"type": "TEXT",
"payload": {
"text": "Test Outbound Message"
}
}
}
}
}
]
}
URL
{
"prompts": [{
"mediaSpecificObject": {
"dfoMessage": {
"messageContent": {
"type": "PLUGIN",
"payload": {
"elements": [
{
"id": "richLink_7329c009-4a36-493c-8435-80874a15175e",
"type": "MENU",
"elements": [
//{
// "id": "bf2521f4-5e85-413f-b6ed-815d1c3905f0",
// "type": "FILE",
// "filename": "photo.jpg",
// "url": "https://picsum.photos/300/150",
// "mimeType": "image/jpeg"
//},
{
"id": "7329c009-4a36-493c-8435-80874a1517524",
"type": "BUTTON",
"text": "RichLink Title",
"url": "https://www.nice.com/"
}
]
}
]
}
}
}
}
}
]
}