获取接口信息接口

场景描述

此接口为CTI-OBS提供整个交互过程中各个接口路径。

接口方法

Post

接口URI

https://域名/rest/isales/v1/openapi/obs/business/interface，例如域名是service.besclouds.com。

请求说明

表1 请求头参数
序号	名称	参数类型	是否必选	说明
1	Authentication	String	True	token鉴权字段，请配置为鉴权接口中返回的refreshToken参数值。
2	Content-Type	String	False	"application/json"

表2 请求体参数
序号	参数	是否必选	类型	描述
1	version	是	String	版本信息

响应说明

响应状态码: 200

表3 响应体参数
序号	名称	参数类型	说明
1	result	string	错误码。取值如下： 0：成功非0：失败
2	resultData	Object	查询成功后，返回结果信息的对象。

表4 resultData对象
序号	参数	类型	描述
1	version	string	版本信息
2	refreshToken	string	刷新token请求路径
3	getTask	string	获取任务请求路径
4	getUserData	string	读取外呼数据请求路径
5	getHoliDay	string	获取节假日请求路径
6	pushCallOutRlt	string	结果回写请求路径
7	pushMidRlt	string	推送中间状态路径
8	pushTaskStatus	string	更新任务中间状态路径

错误码

响应状态码: 400
错误的请求：请检查请求路径及参数。
响应状态码: 401
未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。
响应状态码: 403
鉴权失败。
响应状态码: 404
请求的内容未找到：请检查请求的路径。
响应状态码: 500
业务失败：请依次确认您请求中各参数的取值。

报文样例

请求头：

Authentication:Bearer e3fca9398eaa5cef4b57b523b9c75fae
Content-Type:application/json

请求消息：

{
"version":311
}

响应消息：

{
"result":0,  // 0：成功，其他失败
    "resultData": {
        "version":310,
        "refreshToken":"/iSales/refreshToken ",
        "getTask":"/iSales/getTask", 
        "getUserData":"/iSales/getUserData",
"getHoliDay":"/iSales/ getHoliDay",
"pushCallOutRlt":"/iSales/pushCallOutRlt",
"pushMidRlt":"/iSales/ pushMidRlt",
"pushTaskStatus":"/iSales/pushTaskStatus",   // 可选
}
}

父主题： CC-iSales联调CTI-OBS接口

上一篇：获取外呼任务接口

下一篇：获取节假日信息接口