服务先知

机器人服务先知常见问题和快捷短语企业接口的请求、签名和响应说明。

当访客链接七鱼机器人时，七鱼服务器会调用第三方预判接口，获取企业对该访客的预判信息，该预判信息会展示在热门问题处。调用时会将访客的第三方标识id和访客当前所处页面作为参数调用企业预判接口，调用方式如下： 1·使用POST方式请求企业预判接口 2·接口请求的Content-Type为：application/x-www-form-urlencoded;charset=utf-8 3·调用校验，在调用预判接口时，七鱼会将appSecret，time，nonce三个参数使用sha1哈希算法生成checkSum校验和（同消息接口checksum校验和示例代码），其中timestamp为精确到秒的时间戳，nonce为一串随机生成的字符串,参数放在Http Request Header中传输

请求参数

参数	参数类型	参数说明
appId	String	企业分配给七鱼的appId
nonce	String	描述信息
time	Long	当前UTC时间戳，精确到秒数
checkSum	String	SHA1(appSecret + nonce + time),将三个参数按appSecret、nonce、 time，并转化成16进制的小写字符串作为checkSum
userId	String	开发者的应用里的用户ID，通过CRM接入同步给七鱼
fromPage	String	访客进入机器人的页面链接
content	String	访客在机器人会话中发送的单条消息内容
keyword	String	触发机器人会话转接的关键词

企业接口返回说明

返回类型为JSON，同时进行UTF-8编码

参数	数据类型	必填	说明
guide	String	否	进入机器人时的引导语，字数上限200个字。如果当前值为空，将依次选择服务先知引导语、常见问题引导语之一作为引导语。当接口仅返回引导语不返回问题时，结果无效。
faq	Array	否	对于放置在问题列表的数据，放在faq这一参数内返回。如果企业faq参数返回不为空并且在20个以上，展示faq参数结果；如果faq参数不为空且返回在20个以下，则由置顶问题补全至20个；如果企业faq参数返回为空，若设置了常见问题则展示常见问题，若未设置常见问题则展示置顶问题。
skipQiyuQuestionAppend	boolean	否	是否跳过七鱼常见问题的追加。true：不追加七鱼常见问题，false：追加七鱼的全局置顶常见问题。默认值：false。
card	Object	否	自定义卡片内容
+ cards	Array	是	卡片消息【cards】支持所有的 10 种类型卡片，分别是：标题类型、富文本类型、副标题类型、图片类型、节点流程类型、商品类型、订单类型、按钮类型、跳转链接类型、标签类型。一条卡片消息可以包含多种类型的模板组合。
+ floatCards	Array	否	浮动卡片消息【floatCards】只支持商品类型、按钮类型和标签类型。

cards 和 floatCards 的内容见卡片类型定义

示例

{
  "faq": [
    "热门问题1",
    "热门问题2",
    "热门问题3"
  ],
  "skipQiyuQuestionAppend": true,
  "guide": "常见问题引导语",
  "card": {
    "cards": [
      {
        "img": "https: //res.qiyukf.net/operation/a233f8653cabd00ca9f2ad89b14c22e6",
        "type": "title",
        "content": "Card标题模板",
        "url": "https: //qiyukf.com/docs/guide/web/5-%E4%BC%9A%E8%AF%9D%E6%B6%88%E6%81%AF.html#%E5%95%86%E5%93%81%E5%8D%A1%E7%89%87"
      },
      {
        "type": "rich",
        "content": "富文本模板 红色、24px字号的文本。"
      },
      {
        "img": "https://res.qiyukf.net/operation/e32bbc516ee7c88031aeefd8261b3f8c",
        "type": "subtitle",
        "content": "subtitle模板content",
        "subContent": "subtitle模板subcontent",
        "url": "https: //qiyukf.com/"
      },
      {
        "img": "https: //res.qiyukf.net/operation/e32bbc516ee7c88031aeefd8261b3f8c",
        "type": "image"
      },
      {
        "data": [
          {
            "price": "￥111.11",
            "action": 0,
            "id": "cards_20241118001_1",
            "title": "标题title",
            "picture": "https://res.qiyukf.net/operation/e32bbc516ee7c88031aeefd8261b3f8c",
            "url": "https://item.taobao.com/item.htm?abbucket=14&id=733564471663&ns=1&spm=a21n57.1.0.0.21ae523c0gMVIm&sku_properties=5919063:26593639254",
            "desc": "描述desc"
          },
          {
            "price": "$222.22",
            "action": 1,
            "id": "cards_20241118001_2",
            "title": "标题title",
            "picture": "https://res.qiyukf.net/operation/a36b57015f609344d1ceebef413664c2",
            "url": "https://npcitem.jd.hk/10101726525925.html",
            "desc": "描述desc"
          }
        ],
        "type": "product"
      },
      {
        "type": "link",
        "content": "查看更多LINK",
        "url": "https://res.qiyukf.net/operation/a36b57015f609344d1ceebef413664c2"
      }
    ],
    "floatCards": [
      {
        "img": "https://res.qiyukf.net/operation/e32bbc516ee7c88031aeefd8261b3f8c",
        "type": "subtitle",
        "content": "subtitle模板2",
        "subContent": "subtitle模板2",
        "url": "https: //qiyukf.com/"
      },
      {
        "img": "https: //res.qiyukf.net/operation/e32bbc516ee7c88031aeefd8261b3f8c",
        "type": "image"
      }
    ]
  }
}

服务先知-快捷短语

当访客链接七鱼机器人时，七鱼服务器会调用第三方预判接口，获取企业对该访客的预判信息，该预判信息会展示在输入框上方。调用时会将访客的第三方标识id和访客当前所处页面作为参数调用企业预判接口，调用方式同服务先知-常见问题：

企业接口返回说明

返回类型为JSON，同时进行UTF-8编码

参数	数据类型	必填	说明
bot	Array	否	对于放置在服务直达的数据，放在bot这一参数内返回。最后按顺序依次展示企业返回bot参数、服务先知算法接口(需要开启先知算法开关)、企业运营后台配置参数，重复问题将会被过滤。

示例

{
  "bot": [
    "查物流",
    "查退款",
    "查订单"
  ]
}

服务先知

目录