文档首页/ 云客服/ API参考/ 网页客户端接入/ 根据客户输入联想常用语 (queryPhraseByKeyword)
更新时间:2023-09-27 GMT+08:00

根据客户输入联想常用语 (queryPhraseByKeyword)

场景描述

根据用户输入关键词联想推荐常用语,该接口要求渠道配置开启了机器人。

如果无内容返回,请检查租间下是否存在激活的问答组。

接口方法

POST

接口URI

https://域名/apiaccess/ccmessaging/queryPhraseByKeyword,例如域名是service.besclouds.com

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

ccmessaging-token

string

True

  • applyToken接口返回的token值。
  • 会话过程中接口Response Header中返回的ccmessaging-token的值。

2

x-app-key

string

False

appKey字段,用户标识,在API Fabric上配置

3

Authorization

string

False

鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格)

表2 请求体参数

序号

名称

参数类型

是否必选

说明

1

reqBody

ReqBody

True

请求体

表3 ReqBody参数结构

序号

名称

参数类型

是否必选

说明

1.1

strContent

string

True

消息内容

1.2

locale

string

True

语种

请使用不带国家编码的语言,例如使用zh表示 中文,en表示英语等。请参见ISO 639语言编码获取详细信息。

1.3

channel

string

True

渠道类型,当前固定为WEB(表示WEB渠道接入)

响应说明

  • 响应状态码: 200
    表4 RspBody参数结构

    序号

    名称

    参数类型

    是否必选

    说明

    1.1

    question

    string

    True

    相似问问题数组。

    结果最多返回5条记录, 为智能在线助手平台根据关键词匹配的置信度最高的前5条记录。

    1.2

    resultCode

    string

    True

    响应返回码,0表示成功,非0表示失败

    1.3

    resultDesc

    string

    False

    响应返回描述

    • 0:表示成功,不返回描述信息
    • 1:request is no exsit 或 locale is error 或Robot is no exsit 或authToken is no exsit 或doNMSRequest is error或Exception appeared!。
  • 响应状态码: 400

    错误的请求:请检查请求路径及参数。

  • 响应状态码: 401

    未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。

  • 响应状态码: 404

    请求的内容未找到:请检查请求的路径。

  • 响应状态码: 500

    业务失败:请依次确认您请求中各参数的取值。

错误码

无。

报文样例

  • 场景描述:样例报文

    请求头:

    ccmessaging-token: XXXXXXXXX

    请求参数:

    {
    	"strContent": "网格",
    	"locale": "zh",
    	"channel": "WEB"
    }

    响应参数:

    {
    	"question": ["网格版APP在哪里下载", "网格版APP怎么登录?", "网格版APP支持什么手机版本", "登录APP网格版后,没有扫街下单、网格一本账等功能菜单权限", "PC端中屏网格系统怎么登录"],
    	"resultCode": "0"
    }