文档首页/ 云客服/ API参考/ 机器人管理/ 交互记录查询接口
更新时间：2023-09-27 GMT+08:00
查看PDF
分享

交互记录查询接口

场景描述

智能助手平台提供接口给第三方接入方调用，实现智能交互信息记录的查询，此接口只能查询用户最近一次来话的实例。

接口方法

设置成“POST”。

URL

https://IP:PORT/oifde/rest/api/queryHistory

请求说明

参数名称

数据类型

参数位置

必选/可选

描述

tenantId

String

body

True

租间ID。

params

Map<String，Object>

body

True

参数包。详情见表1 params参数

authToken

String

body

True

访问接口的有效Token值。

有效Token信息通过获取Token接口获取。

请参见C3 智能助手平台接口鉴权方式。
表1 params参数

参数名称

数据类型

参数位置

必选/可选

描述

userMobile

String

body

True

用户标识。（语音导航、语音外呼场景传入用户号码，其他交互场景传入用户id）

响应说明

参数名称

数据类型

参数位置

必选/可选

描述

rtnCode

int

body

True

错误码

  • 0或者null：成功
  • 非0表示失败

    或可通过状态码为200判断为成功

rtnMsg

String

body

False

错误描述

beans

Map<String，String>

body

True

返回内容数组。详情见表2 beans参数说明

callId

String

body

True

呼叫唯一标志

callSorId

String

body

True

用户标识，与入参userMobile相同

object

Object

body

False

默认 null(专有局点特有)

bean

String

body

False

默认 null(专有局点特有)
表2 beans参数说明

参数名称

数据类型

参数位置

必选/可选

描述

interNo

String

body

True

内部序号

userSaying

String

body

True

用户和机器人交谈记录的文本

intention

String

body

True

用户意图

systemReply

String

body

True

系统回复

type

String

body

True

回复类型，TTS、voice file或text

timestamp

String

body

True

系统回复时间

responseSource

String

body

True

对话的回复来源

  • 0：机器人回复
  • 1：静默座席回复

报文样例

  • 请求消息样例 
    {
   "tenantId":"123456"，
   "params":{
      "userMobile": "180****9999" 
    }，
   "authToken":"n******************************"
}
  • 响应消息样例 
    {    
     "rtnCode": 0，//接口成功失败标识    
     "rtnMsg": "成功"，//接口成功失败描述
     "beans": [{        
         "interNo":"1"，    //序号        
         "userSaying":"我有多少话费"，  //语音转写结果        
         "intention":"查询话费"，      //用户意图        
         "systemReply":"您好，您当月累计消费100元，话费余额100元"，  //系统回复
         "type":"TTS"，  //回复类型
         "timestamp":"2019-04-25 17:42:10.0"，  //系统回复时间
         "responseSource":"0"  //机器人回复
     }]，
    "object": null，   
    "bean": null，
    "callId": "xytest02131110"，
    "callSorId": "18019919999"
}
父主题： 机器人管理