华为云用户手册

  • 请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 serverInfo JsonObject True 文件服务器信息。 2 userName String True 用户名 3 serverPwd String True 服务密码,明文传递,后台密文保存 serverInfo 序号 参数名 参数类型 是否必选 说明 1 ip String True 文件服务器IP。 2 port String True port 3 filePath String True 文件服务器默认路径 示例:/home/sftp
  • 报文样例 该接口的请求消息体举例如下: { "userName":"zhangsan", "serverInfo":{ "ip":"1.2.3.4", "port":"22", "filePath":"/home/sftp" }, "serverPwd":"******"} 该接口的响应消息体举例如下: {"resultCode": "02000005","description": " 参数长度需要介于8和80之间"}
  • 接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/file/addServer 其中,ip为CC-iSales服务器地址,port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数,取值范围为1~9999。
  • 请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 serverInfo Object True 文件服务器信息。 2 userName String True 用户名 3 serverPwd String False 服务密码。明文传递,后台密文保存,当serviceInfo.IP与原有IP值不一致时,必传 serverInfo 序号 参数名 参数类型 是否必选 说明 1 ip String True 文件服务器IP。 2 port String True port 3 filePath String True 文件服务器默认路径 示例:/home/sftp
  • 报文样例 该接口的请求消息体举例如下: { "userName":"WANGWU", "serverInfo":{ "ip":"5.9.11.11", "port":"22", "filePath":"/home/sftp" }, "serverPwd":"******"} 该接口的响应消息体举例如下: {"returnCode": "0200000","resultCode": "0200000","resultDesc": "success","returnDesc": "success"}
  • 接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/file/{serverId}/updateServer 其中,ip为CC-iSales服务器地址,port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数,取值范围为1~9999。 2 serverId String True 文件服务器ID
  • 接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/file/{serverId}/deleteServer 其中,ip为CC-iSales服务器地址,port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数,取值范围为1~9999。 2 serverId string True 文件服务器ID
  • 响应说明 表3 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功,其他表示失败。 具体见11.1-表4 错误原因码说明。 2 resultDesc String 描述。 3 totalCount int OBS外呼服务器的结果码的总数 4 obsCodes LIST 外呼结果码集合 表4 obsCodes 序号 参数名 参数类型 说明 1 obsCodeDesc String OBS外呼结果码描述 2 obsCode String OBS外呼结果码。
  • 接口URI https://ip:por/rest/isales/v1/openapi/campaigns/{vdnId}/queryOBSResultCode?pageSize={pageSize}&pageNum={pageNum} 其中,ip为CC-iSales服务器地址,port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数,取值范围为1~9999。 2 pageNum int True 页码,取值大于0 3 pageSize int True 表示每页的查询数量。 取值范围:1~50
  • 报文样例 该接口的响应消息体举例如下: { "obsCodes": [ { "obsCodeDesc": "The switch is busy.", "obsCode": "00605" }, { "obsCodeDesc": "The call is rejected.", "obsCode": "00604" }, { "obsCodeDesc": "The called party does not answer the call.", "obsCode": "00603" }, { "obsCodeDesc": "No resource available on the ACD.", "obsCode": "00602" }, { "obsCodeDesc": "The ACD times out.", "obsCode": "00606" } ], "returnCode": "0200000", "resultCode": "0200000", "resultDesc": "query queryOBSResultCode Success!", "totalCount": 120, "returnDesc": "query queryOBSResultCode Success!"}
  • 报文样例 该接口的请求消息体举例如下: { "limit":10, "offset":0} 该接口的响应消息体举例如下: {"returnCode": "0200000","server": [{"port": null,"ip": null,"filePath": null,"userName": "10","serverId": "164681924997097701747271557174"},{"port": "22","ip": "10.21.124.175","filePath": "/home/sftp","userName": "isales","serverId": "164690088271159234793429225848"},{"port": "22","ip": "192.168.0.1","filePath": "/home/sftp","userName": "huawei","serverId": "164697340198671566909690908237"},{"port": "8888","ip": "1.1.1.1","filePath": "/sftp/file","userName": "isales","serverId": "164765479785832713595318363505"},{"port": "22","ip": "10.1.1.1","filePath": "/home/sftp","userName": "zhangsan","serverId": "164765490069279981932006087306"}],"resultCode": "0200000","resultDesc": "success","returnDesc": "success"}
  • 接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/file/queryServer 其中,ip为CC-iSales服务器地址,port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数,取值范围为1~9999。
  • 接口URI https://ip:por/rest/isales/v1/openapi/campaigns/{vdnId}/updateObResult 其中,ip为CC-iSales服务器地址,port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数,取值范围为1~9999。
  • 报文样例 该接口的请求消息体举例如下: {"defId":"1645244637", "displayResult":"就是不接电话8", "obsCodes":["00605","00604"]} 该接口的响应消息体举例如下: { "returnCode": "0200000", "resultCode": "0200000", "resultDesc": "updateObResult Success!", "returnDesc": "updateObResult Success!"}
  • 接口URI https://ip:por/rest/isales/v1/openapi/campaigns/{vdnId}/{defId}/deleteObsResult 其中,ip为CC-iSales服务器地址,port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数,取值范围为1~9999。 2 defId String True 需要删除的外显结果ID
  • 接口URI https://ip:por/rest/isales/v1/openapi/campaigns/{vdnId}/createObResult 其中,ip为CC-iSales服务器地址,port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数,取值范围为1~9999。
  • 报文样例 该接口的响应消息体举例如下: { "returnCode": "0200000", "data": [ { "displayResult": "就是不接电话6", "resultCode": "002", "defId":"12345" } ], "resultCode": "0200000", "resultDesc": "query outboundResult success", "totalCount": 1, "returnDesc": "query outboundResult success"}
  • 报文样例 该接口的请求消息体举例如下: {"resultCode":"007", "displayResult":"就是不接电话7", "obsCodes":["00602","00606"]} 该接口的响应消息体举例如下: { "defId": "1645244637", "returnCode": "0200000", "resultCode": "0200000", "resultDesc": "createObResult Success!", "returnDesc": "createObResult Success!"}
  • 响应说明 表3 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功,其他表示失败。 具体见11.1-表4 错误原因码说明。 2 resultDesc String 描述。 3 totalCount int 外显结果的总数量。 4 data List 外显结果列表。 表4 data 序号 参数名 参数类型 说明 1 displayResult String 外显结果。 2 resultCode String 外显结果码。 3 defId String 外显结果ID。
  • 接口URI https://ip:por/rest/isales/v1/openapi/campaigns/{vdnId}/queryOBSResults?pageSize={pageSize}&pageNum={pageNum} 其中,ip为CC-iSales服务器地址,port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数,取值范围为1~9999。 2 pageSize int True 页容量取值范围1-50。 3 pageNum int True 页码,取值范围大于0。
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 resultCode string True 接口返回码 2 resultDesc string True 接口返回消息描述。 3 surveyAnswerId string True 答卷ID 响应状态码: 400 错误的请求:请检查请求路径及参数 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到:请检查请求的路径 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 请求头: { "x-app-key": ******************** "Authorization": Bearer ************************} 请求参数: { "moduleId": "80031", "result": "save", "surveyId": "987654321", "custId":"123456789", "serviceId1": "987654321"} 响应参数: { "resultCode": "1203000", "surveyAnswerId": "123456789", "resultDesc": "Opration Successful."}
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 2 x-app-key string True appKey字段,用户标识,请联系运营人员获取appKey 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 moduleId string True 模块ID 智能外呼:80031 人工外呼:80081 智能实训:80083 2 result string True 对答卷进行的操作。 save:保存(创建)答卷 submit:提交答卷 3 surveyId string True 问卷ID 4 custId string False 用户ID 5 serviceId1 string False 问卷对应的任务ID
  • 接口URI https://ip:por/rest/isales/v1/openapi/campaigns/{vdnId}/{defId}/queryObsResultDetail 其中,ip为CC-iSales服务器地址,port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数,取值范围为1~9999。 2 defId int True 需要查询的外显结果ID
  • 报文样例 该接口的响应消息体举例如下: { "returnCode": "0200000", "obResult": { "defId": "1402245659", "displayResult": "就是不接电话6", "vdnId": 40, "resultCode": "002", "resultMapList": [ { "mapId": "1059886898", "defId": "1402245659", "failCode": "34609", "vdnId": "40" }, { "mapId": "1162133679", "defId": "1402245659", "failCode": "00008", "vdnId": "40" } ] }, "resultCode": "0200000", "resultDesc": "queryObsResultDetail success", "returnDesc": "queryObsResultDetail success"}
  • 报文样例 该接口的请求消息体举例如下: {"limit": 10,"offset": 0,"beginTime": "2022-08-20 15:55:55","endTime": "2022-08-23 15:55:55","url":""} 该接口的响应消息体举例如下: { "result": [ { "request": "{\"defId\":\"456\",\"vdnId\":2}", "httpStatus": 200, "resultCode": "0200000", "id": "166088991109059950708365448582", "resultDesc": "queryObsResultDetail success", "url": "/rest/isales/v1/openapi/campaigns/2/456/queryObsResultDetail", "operTime": "2022-08-19T14:18:31.000+00:00" } ], "returnCode": "0200000", "resultCode": "0200000", "count": 1, "resultDesc": "queryCalllogs success", "returnDesc": "queryCalllogs success"}
  • 响应说明 表4 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功,其他表示失败。 具体见下表6 错误原因码说明 2 resultDesc String 描述。 3 result OpenapiLog 场景类型列表 表5 OpenapiLog 序号 参数名 参数类型 说明 1 id String 日志id 2 operTime Datetime 日志时间 3 url String 调用url 4 request Object 输入参数 5 resultCode String 原因码。0200000表示成功,其他表示失败。 具体见下表6 错误原因码说明 6 resultDesc String 描述。 7 httpStatus int 接口调用状态码 8 type String 请求类型 表6 错误原因码说明 序号 错误码 说明 1 02000001 参数异常,异常详情在resultDesc中描述。 2 02000005 参数长度错误,错误详情在resultDesc中描述 3 02000006 参数值的类型/格式错误,详情在resultDesc中描述 4 02000007 参数值大小不正确,详情在resultDesc中描述
  • 接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/calllogs 其中,ip为CC-iSales服务器地址,port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数,取值范围为1~9999。
  • 请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 offset int True offset用于确定查询的起始页。 offset取值为:offset=limit*(page-1) page为需要查询的起始页。 2 limit int True 表示每页的查询数量。取值范围:1~100 3 url String False 调用url 该参数有值,查询当前url的调用记录。 该参数为空时,查询所有接口调用记录。 4 beginTime String True 开始时间 格式:yyyy-MM-dd HH:mm:ss 5 endTime String True 结束时间 格式:yyyy-MM-dd HH:mm:ss 结束时间和开始时间间隔不大于7天
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 resultCode string True 接口返回码 2 resultDesc string True 接口返回消息描述。 3 questionId string True 题目ID 4 answerNo int True 题目编号 5 optionIdList array[object] True 题目选项,当题目类型为选择题时有值 6 questionType string True 题目类型 single:单选题 multi:多选题 essay:简答题 voice:语音 voiceOperation:语音+操作 7 content string True 题目内容 响应状态码: 400 错误的请求:请检查请求路径及参数 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到:请检查请求的路径 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
共100000条