文档首页/ 云客服/ API参考/ 机器人管理/ 对话标识绑定类接口/ 对话标识绑定查询接口
更新时间：2024-09-24 GMT+08:00
查看PDF
分享

对话标识绑定查询接口

场景描述

该接口用于查询对话标识绑定结果。

接口方法

设置成“POST”。

URL

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

请求说明

表1 消息体参数

参数名称

数据类型

参数位置

必选/可选

描述

tenantId

String

body

True

租户ID

accessCode

String

body

False

接入标识,如果不传，则查询租户下所有绑定关系；如果传入，则需要传参数页码pageNum和每页条数pageSize

不超过20位

pageNum

String

body

True

页码

分页查询，查询第几页，首页为1

pageSize

String

body

True

每页多少条

[5,10,20,50,100]

authToken

String

body

True

认证token。

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

source

String

body

False

发起对话识别的源设备。

  • IVR：来自IVR流程
  • OIFDE：表示来自ODFS配置的智能化流程
  • 如果不传该字段，默认查询IVR

    不超过64位

响应说明

参数名称

数据类型

参数位置

必选/可选

描述

errorCode

int

body

False

错误码

成功，不返回errorCode；

失败，参见常用错误码

errorMsg

String

body

False

错误描述

total

long

body

True

总条数

accessInfoList

accessInfo[]

body

True

返回对话绑定关系列表（数组结构）
表2 accessInfo

参数名称

数据类型

参数位置

必选/可选

描述

accessId

String

body

True

内部序号

tenantId

String

body

True

租户ID

accessCode

String

body

True

接入码（被叫号码）

domainId

int

body

False

领域ID

dialogType

int

body

True

对话类型

  • 1：语音导航
  • 2：智能外呼
  • 3：聊天机器人
  • 4：IVR流程

flowCode

String

body

False

流程编码

flowName

String

body

False

流程名称

description

String

body

False

描述

source

String

body

False

发起对话识别的源设备。

  • IVR：来自IVR流程
  • OIFDE：表示来自ODFS配置的智能化流程

chatBotName

String

body

False

机器人名称

usingRecordService

int

body

False

是否使用宇高录制

  • 0：关闭宇高录制
  • 非0：开启宇高录制

报文样例

  • 请求报文 
    {
   "tenantId": "tenant001",
   "accessCode": "10086" ,
   "pageNum": "1" ,
   "pageSize": "10",
   "authToken": "0dbe1**************b505de",
   "source": "OIFDE" 
}
  • 响应报文 
    {
    "total": 2, // long, 总条数
    "accessInfoList" : [{  // Object Array, 对话绑定关系列表
        "accessId":"100001", // String, 内部序号
        "tenantId": "tenantId001", //  String, 租户
        "accessCode": "10086", //  String, 接入标识ID
        "domainId":10001, // int, 领域ID
        "dialogType ":1, // int, 对话类型
        "flowCode" : "flowxxxxxx",//  String, 流程编码
        "description" : "",// String, 发起对话识别的源设备
        "source":"OIFDE",// String, 描述
        "chatBotName":"10086", // String, 机器人名称
        "usingRecordService":0 // int,关闭宇高录制
    },{
        ……
    }]
}

相关文档