云服务器内容精选

  • 响应说明 响应状态码: 200 表4 响应体参数 序号 名称 参数类型 是否必选 说明 1 resultCode String True 原因码。0200000表示成功,其他表示失败。 错误码请参考表5。 2 recordList List false 通话记录。 2.1 interNo string True 内部序号 2.2 systemReply string True 系统回复。 系统回复为IVR流程或智能IVR流程中的语音文件时,语音文件有杂音或为音乐将会无法准确转写为文本信息。 语音文件或 TTS 文本在通话过程中如果被打断无法播放完整,查询出来的系统回复也会是完整的语音文件内容。 2.3 userSaying string True 用户回复 2.4 intention string True 用户意图 2.5 systemReplyTime string True 系统回复时间 2.6 requestTime string True 用户请求时间 2.7 responseSource string True 回复来自机器人还是静默座席。 机器人--0,静默座席--1 3 resultDesc String true 返回描述信息 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值
  • 请求说明 表2 请求头参数 序号 名称 参数类型 是否必选 说明 1 Authorization string True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 2 Content-Type string True 固定填 application/json; charset=UTF-8。 表3 请求体参数 序号 名称 参数类型 是否必选 说明 1 callId String true 通话记录ID,用于与CTI平台的话单等通话数据关联。通过查询外呼结果或者外呼结果回调接口中返回的callId字段获取。
  • 错误码 表5 错误原因码说明 序号 错误码 说明 1 0200001 参数异常,异常详情在resultDesc中描述。 2 02000001 参数值为空 3 02000002 参数包含非法字符 4 02000003 参数长度不能大于规定长度 5 02000004 参数长度不能小于规定长度 6 02000005 参数长度需要介于规定长度之间 7 02000006 参数值类型不正确 8 02000007 参数值大小不正确 9 02000008 参数转换异常,请检查请求参数 10 02000009 参数组合不正确,请检查请求参数 11 02000010 hour和minute必须同时存在 12 02000011 参数个数不能大于规定个数
  • 报文样例 请求头: Content-Type:application/json;charset=UTF-8 Authorization:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "callId" : "1688028889-836" } 响应参数: { "returnCode": "0200000", "recordList": [ { "interNo": "1", "userSaying": null, "systemReply": "啊您看我们请专门负责的同事和您简要介绍一下展会亮点您看可以吗只要和外贸相关的企业对于我们展会都会有兴趣的", "intention": null, "systemReplyTime": "2022-05-31 20:13:08", "requestTime": "2022-05-31 20:13:10", "responseSource": "0" }, { "interNo": "2", "userSaying": "null", "systemReply": "您好,欢迎使用智能机器人", "intention": null, "systemReplyTime": "2022-05-31 20:13:08", "requestTime": "2022-05-31 20:13:08", "responseSource": "0" } ], "resultCode": "0200000", "resultDesc": "success", "returnDesc": "success" }
  • 接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callRecord。 其中,ip为CC-iSales服务器地址,port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 参数名 数据类型 选取原则 说明 vdnId int 必选 虚拟呼叫中心ID。 取值的类型为整数,取值范围为1~9999。
  • 报文样例 请求头: Content-Type:application/json;charset=UTF-8 Authorization:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "callId" : "1688028889-836", "page":1, "limit":10 } 响应参数: { "returnCode": "0200000", "recordList": [ { "interNo": "1", "userSaying": null, "systemReply": "啊您看我们请专门负责的同事和您简要介绍一下展会亮点您看可以吗只要和外贸相关的企业对于我们展会都会有兴趣的", "intention": null, "systemReplyTime": "2022-05-31 20:13:08", "requestTime": "2022-05-31 20:13:10", "responseSource": "0" }, { "interNo": "2", "userSaying": "null", "systemReply": "您好,欢迎使用智能机器人", "intention": null, "systemReplyTime": "2022-05-31 20:13:08", "requestTime": "2022-05-31 20:13:08", "responseSource": "0" } ], "resultCode": "0200000", "resultDesc": "success", "returnDesc": "success" }
  • 错误码 表5 错误原因码说明 序号 错误码 说明 1 0200001 参数异常,异常详情在resultDesc中描述。 2 02000001 参数值为空 3 02000002 参数包含非法字符 4 02000003 参数长度不能大于规定长度 5 02000004 参数长度不能小于规定长度 6 02000005 参数长度需要介于规定长度之间 7 02000006 参数值类型不正确 8 02000007 参数值大小不正确 9 02000008 参数转换异常,请检查请求参数 10 02000009 参数组合不正确,请检查请求参数 11 02000010 hour和minute必须同时存在 12 02000011 参数个数不能大于规定个数
  • 请求说明 表2 请求头参数 序号 名称 参数类型 是否必选 说明 1 Authorization string True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 2 Content-Type string True 固定填 application/json; charset=UTF-8。 表3 请求体参数 序号 名称 参数类型 是否必选 说明 1 callId String true 通话记录ID,用于与CTI平台的话单等通话数据关联。通过查询外呼结果或者外呼结果回调接口中返回的callId字段获取。 2 page int true page为需要查询的起始页。 取值范围:1~1000 3 limit int true 表示每页的查询数量。 取值范围:1~100
  • 接口URI https://ip:port/rest/isales/v2/openapi/campaigns/{vdnId}/callRecord。 其中,ip为CC-iSales服务器地址,port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 参数名 数据类型 选取原则 说明 vdnId int 必选 虚拟呼叫中心ID。 取值的类型为整数,取值范围为1~9999。
  • 响应说明 响应状态码: 200 表4 响应体参数 序号 名称 参数类型 是否必选 说明 1 resultCode String True 原因码。0200000表示成功,其他表示失败。 错误码请参考表5。 2 recordList List false 通话记录。 2.1 interNo string True 内部序号 2.2 systemReply string True 系统回复。 系统回复为IVR流程或智能IVR流程中的语音文件时,语音文件有杂音或为音乐将会无法准确转写为文本信息。 语音文件或TTS文本在通话过程中如果被打断无法播放完整,查询出来的系统回复也会是完整的语音文件内容。 2.3 userSaying string True 用户回复 2.4 intention string True 用户意图 2.5 systemReplyTime string True 系统回复时间 2.6 requestTime string True 用户请求时间 2.7 responseSource string True 回复来自机器人还是静默座席。 机器人--0,静默座席--1 3 resultDesc String true 返回描述信息 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值
  • 响应说明 表4 响应体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功,其他表示失败。 2 resultDesc String 描述。 3 returnCode String 原因码。0200000表示成功,其他表示失败。 4 returnDesc String 描述。 5 totalCount int 外呼结果总数 6 data JSONArray 结果json,详见表5。 表5 data参数说明 序号 参数名称 参数类型 描述 6.1 campaignId String 外呼任务的id 6.2 sessionId String 标识用户的ID 6.3 called String 被叫号码 6.4 callTimeStr String 呼叫时间,格式为:yyyy-mm-dd hh:mm:ss 6.5 callStatus int 呼叫结果(5: 呼叫失败,6: 呼叫成功) 6.6 failCode String 失败的原因码。 6.7 resultCode String 失败的原因码对应的外显结果码。外显结果码可以自定义,失败原因码与外显结果码相互关联。 6.8 vdnId int 外呼号码所属VDN ID。 6.9 callId String 通话记录ID,用于与CTI平台的话单等通话数据关联。 6.10 recordPath String 通话录音文件的存储路径。 说明: 该字段仅在使用接续时(SAAS组网),才返回值,其他情况返回为空。
  • 报文样例 该接口的请求消息体举例如下: { "sessionId": "1202_test013", "pageSize": 500, "pageNum": 1 } 该接口的响应消息体举例如下: { "resultCode":"0200000", "resultDesc":"Query Success!", "returnCode":"0200000", "returnDesc":"Query Success!", "totalCount": 2, "data": [ { "campaignId": "3", "sessionId": "1202_test013", "called": "60584", "callTimeStr": "2020-08-30 20:00:00", "callStatus": 6, "failCode": "0", "resultCode": "OB99999", "vdnId": 11, "callId": "0023-134864174", "recordPath": "Y:/1/11/20200830/3408/0949218.V3" }, { "campaignId": "3", "sessionId": "1202_test013", "called": "60584", "callTimeStr": "2020-08-30 20:05:00", "callStatus": 6, "failCode": "0", "resultCode": "OB99999", "vdnId": 11, "callId": "0023-134864893", "recordPath": "Y:/1/11/20200830/3408/0942113.V3" } ] }
  • 错误结果码 表6 错误原因码说明 序号 错误码 说明 1 0200001 参数异常,异常详情在resultDesc中描述。 2 0200007 外呼活动已经不存在。 3 0200008 开始时间和结束时间不是同时存在,或者同时不存在。 4 0200009 开始时间或者结束时间的格式不正确。 5 0200010 开始时间不是早于结束时间。 6 0200011 开始时间和结束时间相差的天数超过30天。 7 02000001 参数值为空 8 02000002 参数包含非法字符 9 02000003 参数长度不能大于规定长度 10 02000004 参数长度不能小于规定长度 11 02000005 参数长度需要介于规定长度之间 12 02000006 参数值类型不正确 13 02000007 参数值大小不正确 14 02000008 参数转换异常,请检查请求参数 15 02000009 参数组合不正确,请检查请求参数 16 02000010 hour和minute必须同时存在 17 02000011 参数个数不能大于规定个数
  • 接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callresult/{campaignId} 其中,ip为CC-iSales服务器地址,port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数,取值范围为1~9999。 2 campaignId int True 外呼任务Id