云服务器内容精选

  • 错误结果码 表6 错误原因码说明 序号 错误码 说明 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 参数个数不能大于规定个数 接口配置流控,五分钟执行一次,针对429状态,提示返回:“请勿频繁操作,请稍后再试。”。ValidateExceptionHandler中正在处理。
  • 报文样例 该接口的请求消息体举例如下: 无 该接口的响应消息体举例如下: { "countDetail": [ { "calledCount": 0, "batchDetail": [], "campaignId": "1798316116", "finishCount": 0, "unCallCount": 0, "totalCount": 3, "totalCallSucc": 2, "totalCalledCount": 3, "totalFinishCount": 3, "dailyFinishCount": 3, "dailyCalledCount": 3, "dailyCallSucc": 2, "dailyCount": 3 }, { "calledCount": 0, "batchDetail": [ { "calledCount": 0, "finishCount": 0, "unCallCount": 1, "batchId": "123456", "totalCount": 3, "totalCallSucc": 2, "totalCalledCount": 3, "totalFinishCount": 3, "dailyFinishCount": 3, "dailyCalledCount": 3, "dailyCallSucc": 2, "dailyCount": 3 }, { "calledCount": 0, "finishCount": 0, "unCallCount": 1, "batchId": "66666", "totalCount": 3, "totalCallSucc": 2, "totalCalledCount": 3, "totalFinishCount": 3, "dailyFinishCount": 3, "dailyCalledCount": 3, "dailyCallSucc": 2, "dailyCount": 3 } ], "campaignId": "1549589640", "finishCount": 0, "unCallCount": 3 } ] }
  • 接口URI https://ip:port/rest/isales/v2/openapi/campaigns/{vdnId}/statistics?campaignId={campaignId}&batchId={batchId} 其中,ip为CC-iSales服务器地址,port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数,取值范围为1~9999。 2 campaignId String False 外呼数据ID 该参数有值,查询当前任务的全量和所有批次。 该参数为空时,查询所有任务的全量和所有批次。 3 batchId String False,该字段有值,则campaignId必传。 批次号,映射t_isl_data表customField字段。 该参数有值时,查询当前任务的全量和所传批次。
  • 响应说明 表3 消息体参数说明 序号 参数名 参数类型 说明 1 countDetail Array 返回每个任务的数量。 具体见表4 表4 countDetail结构 序号 参数名 参数类型 说明 1.1 campaignId String 外呼数据ID。 1.2 unCallCount int 该活动ID下的剩余未拨打总量。 1.3 calledCount int 当天已拨打量。 1.4 finishCount int 已完成呼叫总量 1.5 batchDetail Array 返回每个customField(批次号)值的数量 具体见表 batchDetail结构。 1.6 totalCalledCount int 该活动已拨打总量 1.7 totalCallSucc int 该活动接通呼叫总量 1.8 totalFinishCount int 该活动已完成呼叫总量 1.9 totalCount int 该活动总呼叫量(含完成,呼叫中,未呼叫) 1.10 dailyCalledCount int 当天已拨打量 1.11 dailyCallSucc int 当天接通呼叫总量 1.12 dailyFinishCount int 当天已完成呼叫总量 1.13 dailyCount int 当天呼叫量(含完成,呼叫中,未呼叫) 表5 batchDetail结构 序号 参数名 参数类型 说明 1.5.1 batchId String 代表增加外呼数据时的批次id。 取值与customField一致。 1.5.2 unCallCount int 该活动ID下的剩余未拨打总量。 1.5.3 calledCount int 当天已拨打量。 1.5.4 finishCount int 已完成呼叫总量 1.5.5 totalCalledCount int 该活动已拨打总量 1.5.6 totalCallSucc int 该活动接通呼叫总量 1.5.7 totalFinishCount int 该活动已完成呼叫总量 1.5.8 totalCount int 该活动总呼叫量(含完成,呼叫中,未呼叫) 1.5.9 dailyCalledCount int 当天已拨打量 1.5.10 dailyCallSucc int 当天接通呼叫总量 1.5.11 dailyFinishCount int 当天已完成呼叫总量 1.5.12 dailyCount int 当天呼叫量(含完成,呼叫中,未呼叫)
  • 报文样例 该接口的请求消息体举例如下: { "callDataList": [ { "sessionId": "00750", "called": "80021" }, { "sessionId": "00850", "called": "80022" }, { "sessionId": "00950", "called": "80023" }, { "sessionId": "01050", "called": "80024" } ] } 该接口的响应消息体举例如下: { "returnCode": "0200000", "returnObject": { "totalSize": 2, "dataIdList": [ { "called": "88880399", "dataId": "1803096731904991234" }, { "called": "88880399", "dataId": "1803096731997265922" } ] }, "resultCode": "0200000", "resultDesc": "create data succeeded", "returnDesc": "create data succeeded" }
  • 错误结果码 表8 错误原因码说明 序号 错误码 说明 1 0200001 参数异常,异常详情在resultDesc中描述。 2 0200006 数据库操作异常。 3 0200007 外呼活动不存在。 4 0200018 存在重复的号码。 5 0200019 当前状态不允许追加号码。 6 0200020 号码数量超过了最大规格20w条。 7 0200022 接口调用太快。 8 0200024 添加的号码中存在黑名单号码。 9 0200029 超过了每次添加允许的最大值。 10 0200030 时间格式不正确。 11 02000001 参数值为空 12 02000002 参数包含非法字符 13 02000003 参数长度不能大于规定长度 14 02000004 参数长度不能小于规定长度 15 02000005 参数长度需要介于规定长度之间 16 02000006 参数值类型不正确 17 02000007 参数值大小不正确 18 02000008 参数转换异常,请检查请求参数 19 02000009 参数组合不正确,请检查请求参数 20 02000010 hour和minute必须同时存在 21 02000011 参数个数不能大于规定个数
  • 响应说明 表5 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功,其他表示失败。 具体见表8。 2 resultDesc String 描述。 3 returnCode String 原因码。0200000表示成功,其他表示失败。 具体见表8。 4 returnDesc String 描述。 5 returnObject Object 参见表6。 表6 returnObject参数说明 序号 参数名 参数类型 说明 5.1 totalSize int 当前系统需要外呼的数据总数。 5.1 datalist Object 参见表7。 表7 datalist参数说明 序号 参数名 参数类型 说明 5.1 called String 新增的外呼号码。 5.1 dataId String 新增外呼号码及其对应的dataId。
  • 接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/calldata/{campaignId} 其中,ip为CC-iSales服务器地址,port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数,取值范围为1~9999。 2 campaignId int True 外呼活动的ID。
  • 使用说明 前提条件 已经申请了开发者账号。 外呼活动已经创建。 使用限制 外呼活动未完成的外呼记录数不超过20W。 同一个外呼任务,每次只能增加20条,且前后接口调用时间不能小于1秒。 每次追加的被叫号码不能有重复。 每次追加的被叫号码中不能与黑名单号码重复,或者被叫号码在黑名单号码中并为其配置了限制周期和限制次数(但外呼次数不能超过限制周期内的限制次数)。 已完成的任务不允许追加号码。 执行中的任务不允许新增外呼号码。
  • 接口URI /rest/isales/v1/openapi/campaigns/{vdnId}/calldata/{campaignId}/{dataId} 其中,ip为CC-iSales服务器地址,port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数,取值范围为1~9999。 2 campaignId int True 外呼活动的ID。 3 dataId int True 外呼数据的ID。
  • 响应说明 表3 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功,其他表示失败。 具体见表7。 2 resultDesc String 描述。 3 returnCode String 原因码。0200000表示成功,其他表示失败。 具体见表7。 4 returnDesc String 描述。 5 data Object 该条data下的号码以及属性。 具体见表4 表4 data数据说明 序号 参数名 参数类型 说明 5.1 dataId String 外呼数据ID。 5.2 properties List 业务属性。 具体见表5 5.3 calledNos List 外呼号码 具体见表6 表5 properties数据说明 序号 参数名 参数类型 说明 5.2.1 propCode String 属性编码。 5.2.2 propName String 属性名称。 5.2.3 propValue 取决于具体的属性类型 属性值 表6 calledNos数据说明 序号 参数名 参数类型 说明 5.3.1 calledNo String 外呼号码。 5.3.2 type String 号码分类。
  • 错误结果码 表7 错误原因码说明 序号 错误码 说明 1 0200001 参数异常,异常详情在resultDesc中描述。 2 0200007 外呼活动不存在。 3 02000001 参数值为空 4 02000002 参数包含非法字符 5 02000003 参数长度不能大于规定长度 6 02000004 参数长度不能小于规定长度 7 02000005 参数长度需要介于规定长度之间 8 02000006 参数值类型不正确 9 02000007 参数值大小不正确 10 02000008 参数转换异常,请检查请求参数 11 02000009 参数组合不正确,请检查请求参数 12 02000010 hour和minute必须同时存在 13 02000011 参数个数不能大于规定个数
  • 报文样例 该接口的请求消息体举例如下: 无 该接口的响应消息体举例如下: { "returnCode": "0200000", "data": { "dataId": "11330737561851183104", "calledNos": [ { "calledNo": "88881951", "type": null } ], "properties": [ { "propValue": "12312", "propName": "属性1", "propCode": "1" }, { "propValue": "123", "propName": "属性2", "propCode": "12" }, { "propValue": null, "propName": "属性3", "propCode": "123" } ] }, "resultCode": "0200000", "resultDesc": "query data success", "returnDesc": "query data success" }
  • 错误结果码 表5 错误原因码说明 序号 错误码 说明 1 0200001 参数异常,异常详情在resultDesc中描述。 2 0200006 数据库操作异常。 3 0200007 外呼活动不存在。 4 0200028 当前状态不允许删除号码。 5 0200030 时间格式不正确。 6 02000001 参数值为空 7 02000002 参数包含非法字符 8 02000003 参数长度不能大于规定长度 9 02000004 参数长度不能小于规定长度 10 02000005 参数长度需要介于规定长度之间 11 02000006 参数值类型不正确 12 02000007 参数值大小不正确 13 02000008 参数转换异常,请检查请求参数 14 02000009 参数组合不正确,请检查请求参数 15 02000010 hour和minute必须同时存在 16 02000011 参数个数不能大于规定个数
  • 响应说明 表4 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功,其他表示失败。 具体见表5。 2 resultDesc String 描述。 3 returnCode String 原因码。0200000表示成功,其他表示失败。 具体见表5。 4 returnDesc String 描述。 5 successCount int 成功数量