Stella Platform Documentation

Stella Platform Documentation

  • 文档
  • 标准设置程序
  • 参考
  • 常见问题
  • Bot API
  • 接口
  • Languages icon中文
    • English

›WhatsApp

概览

  • 文档指南

开始使用

  • 介绍
  • 更新历程
  • 最佳实践
  • 聊天机器人范本

聊天机器人制作平台

  • 工作区域
  • 对话点
  • 附件ID

对话点资讯区

  • Tree ID和Composite ID
  • 基本资讯
  • 触发点
  • 响应
  • 执行动作
  • 重定向
  • 会员标记
  • 数据分析
  • 自然语言处理
  • 进阶

脸书

  • 消息类型
  • 按钮类型
  • 固定菜单
  • 访问令牌
  • 一次性通知
  • 多次通知 (测试版)

Instagram

  • 消息类型

WhatsApp

  • 概览
  • 设定步骤
  • 消息类型

网站聊天室插件

  • 概览
  • 消息类型
  • 按钮类型

微信

  • 消息类型

Slack

  • 消息类型

Telegram

  • 消息类型

集成

  • Dialogflow
  • Stripe
  • LUIS
  • 自定义收件箱集成

数据库

  • 数据库

媒体库

  • 媒体库

频道

  • 概览
  • 网络钩子
  • 频道元数据
  • 營業時間
  • 脸书
  • Instagram
  • 网站聊天室插件
  • WhatsApp
  • 微信
  • Slack(公共应用程式)
  • Slack(自定义应用程式)
  • Teamwork
  • Zendesk
  • 自定义平台

数据分析

  • 会员
  • 分析报表版
  • PSID

设定

  • 概览
  • 语言
  • 配对频道
  • 设置访问控制
  • 访问令牌
  • 追踪设置记录

聊天机器人推送平台

  • 推送内容
  • 目标受众
  • 数据分析

Log

  • 后台记录

WhatsApp消息类型

您可向您的用户发送以下类型的消息:

  • 文字
  • 图片
  • 语音
  • 影片
  • 文件
  • 位置
  • 联络
  • 互动式信息
  • 消息模板

文字

{
  type: "TEXT",
  text: "Hello World!",
}
属性简介必须?
typeTEXT是
text字串;最多2000个字元是

图片

{
  type: "IMAGE",
  text: "I am Sanuker!",
  url: "http://image.png",
}
属性简介必须?
typeIMAGE是
text字串;WhatsApp图片的说明文字否
url图片档案的连结是

小提示:

  • 图片支援以下档案格式,包括.jpeg及.png
  • 图片档案大小建议不多於25MB

语音

{
  type: "AUDIO",
  url: "http://audio.aac",
}
属性简介必须?
typeAUDIO是
url语音档案的连结是

小提示:

  • 语音支援以下档案格式,包括.aac

影片

{
  type: "VIDEO",
  url: "http://video.mp4",
}
属性简介必须?
typeVIDEO是
url影片档案的连结是

小提示:

  • 影片支援以下档案格式,包括.mp4
  • 影片档案大小建议不多於25MB

文件

{
  type: "FILE",
  url: "http://file.pdf",
}
属性简介必须?
typeFILE是
url文件档案的连结是

小提示:

  • 文件支援以下档案格式,包括.pdf
  • 文件档案大小建议不多於25MB

位置

{
  "type": "LOCATION",
  "text": "ABC Company",
  "address": "Room C, 1/F, DFG Building, 101 Rainbow Road",
  "lat": 22.31586918460027,
  "long": 114.20883121469535
}
属性简介必须?
typeLOCATION是
textString; Name of location否
addressString; Addresso of Location否
latLatitude是
longLongitude是

联络

{
  "type": "CONTACTS",
  "contacts": [
    {
      "id": "YXpJfusT",
      "name": {
        "formatted_name": "John Lee",
        "first_name": "John",
        "last_name": "Lee",
        "prefix": "Mr"
      },
      "addresses": [
        {
          "type": "work",
          "city": "Hong Kong",
          "street": "Rainbow Road 131, ABC Building"
        }
      ],
      "emails": [
        {
          "type": "work",
          "email": "workmail123@gmail.com"
        }
      ],
      "phones": [
        {
          "type": "cell",
          "phone": "+852 1234 5678"
        }
      ],
      "urls": [
        {
          "type": "work",
          "url": "www.sanuker.com"
        }
      ],
      "org": {
        "company": " Sanuker"
      }
    }
  ]
}
属性简介必须?
nameString; name of contact是
addressString; contact address否
birthdayString; date否
emailsString; email address否
orgString; company name否
phonesString; phone number否
urlsString; url否

Contact中的每个 Object 都包含一个或多个可选参数,你可以参考此处了解详情。


互动式信息

互动式信息通过提供可点击的按钮,使用户能够快速做出反应。用户不能同时从列表或按钮信息中选择一个以上的选项,但他们可以返回并重新打开以前的信息。

单一产品信息

"type": "WHATSAPP_PRODUCT",
  "body": {
    "text": "Check out our Bag of the Day"
  },
  "action": {
    "catalogId": "4928452840550143",
    "productId": "03-Pack"
  }
属性简介必须?
bodyThe body content of the message (Maximum of 1024 characters)否
footerThe footer content (Maximum of 60 characters)否
actionMust contain
- catalogId: an ID for the catalog you want to use for this message. Retrieve this ID via Commerce Manager.
- productId: a product’s unique identifier (Content ID).
是

多个产品信息

多个产品信息只能包含最多 30 个库存产品的选择。
{
  "type": "WHATSAPP_PRODUCT_LIST",
  "header": {
    "type": "text",
    "text": "Fall Collection"
  },
  "body": {
    "text": "Click view items to see our Fall Collection"
  },
  "action": {
    "catalogId": "4928452840550143",
    "sections": [
      {
        "title": "Urban Essentials",
        "productIds": [
          "01-Pack",
          "02-Bag"
        ]
      },
      {
        "title": "Hiking Essentials",
        "productIds": [
          "03-Pack"
        ]
      }
    ]
  }
}
属性简介必须?
headertype must be text. Contain a text object with the desired content是
bodyThe footer content (Maximum of 1024 characters)是
footerThe footer content (Maximum of 60 characters)否
actionMust contain
- catalogId: an ID for the catalog you want to use for this message. Retrieve this ID via Commerce Manager
- sections: Array of section objects. You must include at least one section
是

sections field

P属性简介必须?
titlea title for each section是
productIdsproduct’s unique identifier (Content ID)是

列表信息

{
  "type": "WHATSAPP_LIST",
  "header": {
    "type": "text",
    "text": "Hello 👋🏻"
  },
  "body": {
    "text": "Sanuker provides chatbot solutions."
  },
  "footer": {
    "text": "Facebook and WhatsApp Official Business Partner"
  },
  "action": {
    "button": "Menu",
    "sections": [
      {
        "title": "section title",
        "rows": [
          {
            "payload": "GREETINGS",
            "title": "Main Menu",
            "description": "Hello!"
          },
          {
            "payload": "ABOUT_SANUKER",
            "title": "About Sanuker",
            "description": "Who are you?"
          }
        ]
      }
    ]
  }
}
属性描述需要?
Header列表信息的标题;它可以是一个文本或媒体。"图片"、"视频"、"文档"否
Body信息的主体内容(最多1024个字符)。是
Footer页脚内容(最多60个字符)否
Action在动作里面,你必须嵌套:
- 一个带有你的按钮内容的按钮字段,以及
- 至少一个部分对象(最多10个)

在部分里面,你必须添加至少一个行对象
是

action Object

属性描述需要?
buttonB按钮内容。它不能是一个空字符串,并且在信息中必须是唯一的(最多20个字符)。是
sections节段对象的数组。最小为1,最大为10是

section Object

属性描述需要?
title节的标题Y(如果信息有多个节)。 |
rows包含一个行的列表。每行必须有一个标题和一个ID。你可以添加一个描述,但它是可选的Y

回复按钮

{
  "type": "WHATSAPP_REPLY_BUTTONS",
  "header": {
    "type": "image",
    "image": {
      "id": "2e5a7aad-e8c7-43ba-ad5e-b298bb32f8af"
    }
  },
  "body": {
    "text": "Sanuker provides chatbot solutions."
  },
  "footer": {
    "text": "Facebook and WhatsApp Official Business Partner"
  },
  "action": {
    "buttons": [
      {
        "type": "reply",
        "reply": {
          "payload": "GREETINGS",
          "title": "Main Menu"
        }
      },
      {
        "type": "reply",
        "reply": {
          "payload": "ABOUT_SANUKER",
          "title": "About Sanuker"
        }
      }
    ]
  }
}
属性描述需要?
Header列表信息的标题;它可以是文本或媒体。"图片", "视频", "文件"否
Body信息的主体内容(最多1024个字符)。是
Footer页脚内容(最多60个字符)否
Action你必须至少添加一个按钮,并包括类型和标题。你不能添加超过3个按钮。是

action Object

属性描述需要?
buttons一个按钮可以包含以下参数。
类型:唯一支持的类型是回复(对于回复按钮信息)
标题。按钮的标题。它不能是一个空字符串,并且必须在信息中是唯一的(最多20个字符)。
是

消息模板

{
  "type": "TEMPLATE",
  "components": [
    {
      "parameters": [
        {
          "image": {
            "id": "57ec1287-6915-4a44-8dc9-9caa620385e1"
          },
          "type": "image"
        }
      ],
      "type": "header"
    },
    {
      "type": "button",
      "sub_type": "quick_reply",
      "index": "0",
      "parameters": [
        {
          "type": "payload",
          "payload": "Contact Sanuker"
        }
      ]
    },
    {
      "type": "button",
      "sub_type": "quick_reply",
      "index": "1",
      "parameters": [
        {
          "type": "payload",
          "payload": "GREETINGS"
        }
      ]
    },
    {
      "type": "button",
      "sub_type": "quick_reply",
      "index": "2",
      "parameters": [
        {
          "type": "payload",
          "payload": "ABOUT_SANUKER"
        }
      ]
    }
  ],
  "languagePolicy": "deterministic",
  "languageCode": "en",
  "namespace": "bc3ac5dd_6dfd_2345_d5f7_123456789bf",
  "elementName": "multiple_button_test_1",
  "accountId": "1234567890"
}

请注意,components是必须的,否则,在使用Bot API的sendResponses时,响应会无法被发送。

消息范本资料

属性简介必须?
Name只能包括小写英文字母丶数字及底线( _ ); 其馀字元或空白均不能接受是
Category选择正确的消息范本类型;详情请参阅支援范本类型是
Language选择正确的消息范本语言;同一消息范本内的所有翻译都推有同一个消息范本名称;在发送消息范本的时候,您须注明该消息范本的发送语言;详情请参阅支援语言是
Content消息范本的内容;针对所有动态参数,您可以{{1}}此格式填写取代`是
Header消息模板的标题;可以是文字或媒体。"图片", "视频", "文档"否
Body消息模板的正文是
Footer信息模板的脚注否
Buttons消息模板的按钮;Call-to-action或快速回复;最多3个按钮。否

最大字符数限制

属性字符数限制
Body (没有Header/Footer时)最多1024个字符
Body (含有Header/Footer时)最多1024个字符
Header60个字符
Footer60个字符

在消息范本中,最大字符数限制并不适用于varaiable。

设置程序

  1. 开启「Response Builder」,于消息类型的下拉选单中选择「WhatsApp Message Template」。

创建消息模板响应
  1. 于「Message Template」选择现有的消息模板。假如您仍未有现成的消息模板,请先向WhatsApp递交消息范本。

  2. 将「Language Policy」语言设定为「Deterministic」。

  3. 为消息模板选择语言。

  4. 以下为自选设定:

  • 如果您的消息模板附有快速回复的按钮,请输入负载触发点。

输入负载触发点
  • 如果您的消息模板有附上图片或影片等多媒体标题,请输入Media ID或url。

添加多媒体
← 设定步骤概览 →
  • 文字
  • 图片
  • 语音
  • 影片
  • 文件
  • 位置
  • 联络
  • 互动式信息
    • 单一产品信息
    • 多个产品信息
    • 列表信息
    • 回复按钮
  • 消息模板
    • 消息范本资料
    • 最大字符数限制
    • 设置程序
Stella Platform Documentation
Docs
Get StartedBot API ReferenceAPI ReferenceStandard Procedures
Community
FAQUser ShowcaseChat with Us
Copyright © 2023 Sanuker Inc. Limited