云服务器内容精选

  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 returnCode string False 返回码 0:成功 其他:失败 1.2 description string False 描述 1.3 data object False 删除情况展示 1.3.1 id string False 删除的绑定数据id 1.3.2 name string False 删除的绑定数据"accessCode"+"extCode" 1.3.3 content string False 删除的accessCode 1、全部删除成功或者全部删除失败时,和name一样 2、部分删除成功时,字符串结构为"Success:"+"同name一样"+",Failed:"+"同name一样" 响应状态码: 400 错误的请求:请检查请求路径及参数 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 请求头: Content-Type:application/json Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX X-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "dnids": "1,2" } 响应参数: { "returnCode": "0", "data": { "name": "9911411,99114111", "id": "1127983948544239618,1127986019188238339", "content": "9911411,99114111" }, "description": "data delete success" }
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段,用户标识,请联系运营人员获取appKey 2 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 dnids string True 配置编号(查询被叫时返回的dnid); 删除多个用,隔开;最大删除数1000
  • 报文样例 请求头: Content-Type:application/json Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX X-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "accessCode": "9911411", "mediatypeId": 5, "description": "接入码", "limit":10, "offset":0 } 响应参数: { "returnCode": "0", "data": { "total": 1, "calledRouteList": [ { "id": "1124167935465633793", "accessCode": "9911411", "mediatypeId": 5, "n400Number": null, "description": null, "numCallAttr": 3 } ] }, "description": "success" }
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 data object False - 1.1.1 total number False 数据总量 1.1.2 calledRouteList array[object] False 接入码信息列表 1.1.2.1 id string False 接入码ID 1.1.2.2 accessCode string False 接入码 1.1.2.3 mediatypeId integer False 媒体类型: 2:语音点击通话 5:音视频 18:视频点击通话 19:视频 53:多媒体 1.1.2.4 n400Number string False 接入码页面配置的服务号码,通常为核心网映射的400号码 1.1.2.5 description string False 接入码描述 1.1.2.6 numCallAttr number False 号码属性(3:呼入和呼出;2:呼出;1:呼入) 1.2 returnCode string False 返回码 0:成功 其他:失败 1.3 description string False 描述 响应状态码: 400 错误的请求:请检查请求路径及参数 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段,用户标识,请联系运营人员获取appKey 2 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 accessCode string False 接入码 支持模糊查询 1.2 mediatypeId integer False 媒体类型 2:点击通话 5:音视频 53:多媒体 1.3 description string False 接入码描述 支持模糊查询 1.4 limit integer False 表示每页的查询数量,0-100,默认100,如果输入超过100,将默认查询100条 1.5 offset integer False offset用于确定查询的起始页。offset取值范围为:offset=limit*(page-1),page为需要查询的起始页。offset默认值0,最大值100
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 returnCode string False 返回码 0:成功 其他:失败 1.2 description string False 描述 响应状态码: 400 错误的请求:请检查请求路径及参数 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段,用户标识,请联系运营人员获取appKey 2 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 accessCode string True 接入码;最大长度32字符 1.2 extCode string False 扩展码; 最大长度12字符(如果希望一个接入码能设置多个目的设备。这种情况下可通过配置扩展码的方式来实现,例如,接入码为12345,我们可以添加扩展码1,路由到技能队列A,扩展码2,路由到技能队列B。这样客户可直接拨打123451实现直接接入技能队列A。) 1.3 mediaTypeId integer False 媒体类型;默认值:5 字段可选值:(2:语音点击通话 5:音视频 18:视频点击通话 19:视频 53:多媒体) 说明: 1、传入技能队列(devicetype=1)时,mediaTypeId等于传入的技能队列绑定的mediaTypeId(没有绑定默认5) 2、接入码accessCode所属的媒体类型(查询接入码接口返回的mediaTypeId字段)和该入参mediaTypeId的对应关系如下: 5对应5和19; 53对应53; 2对应2和18 1.4 devicetype integer True 设备类型; 1:技能队列 3:IVR 说明:多媒体渠道不能选择IVR流程 1.5 deviceId integer True 目标设备id(技能队列skillId、IVR的id) 说明:传入技能队列(devicetype=1)时,deviceId的对应的媒体类型要和入参mediaTypeId一致
  • 报文样例 请求头: Content-Type:application/json Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX X-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "accessCode": "9911411", "extCode": "11", "devicetype": 1, "deviceId": 1, "mediaTypeId": 19 } 响应参数: { "returnCode": "0", "description": "data create success" }
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 returnCode string False 返回码 0:成功 其他:失败 1.2 description string False 描述 响应状态码: 400 错误的请求:请检查请求路径及参数 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 请求头: Content-Type:application/json Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX X-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "id": "1125397061153369092", "devicetype": 1, "deviceId": 1 } 响应参数: { "returnCode": "0", "description": "data update success" }
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段,用户标识,请联系运营人员获取appKey 2 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 id string True 被叫ID 1.2 devicetype integer True 设备类型;1:技能队列 3:IVR 1.3 deviceId integer True 目前设备id(技能队列skillId、IVR的id)
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-KEY string False appKey字段,用户标识,请联系运营人员获取appKey 2 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 phoneNo string True 查询的11位手机号码,或者带区号固话。
  • 报文样例 请求头: Content-Type: application/jsonX-APP-KEY: **************************************Authorization: Bearer ************************************** 请求参数: {"phoneNo":"13020017****"} 响应参数: { "returnCode": "0", "data": { "areaCode": "110100", "province": "北京", "city": "北京", "cityCode": "010", "isp": "联通", "postCode": "100000", "phoneNo": "1302001" }, "description": "success"}
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 returnCode string False 返回码,0成功,非0失败 1.2 description string False 返回描述 1.3 data object False 手机号码归属地信息 1.3.1 areaCode string False 地区码 1.3.2 province string False 省 1.3.3 city string False 城市 1.3.4 cityCode string False 城市编码,可能多个,"/"分隔,如果查询的是固话,城市编码可能为空 1.3.5 isp string False 运营商:电信、移动、联通。 如果是固话查询则返回未知 1.3.6 postCode string False 邮政编码,可能多个,"/"分隔,如果查询的是固话,邮政编码可能为空 1.3.7 phoneNo string False 手机号码前7位,或者固话区号 响应状态码: 401 授权失败:1. 参数是否正确有效。 2. 请确认是否购买了相关服务。 3. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求路径可能不对。 响应状态码: 500 参数不对导致业务失败或者服务端内部异常。