云服务器内容精选

  • 报文样例 请求头: { "x-app-key": "f******************************f" "Authorization": "Bearer 0******************************8" } { "connection": "keep-alive" "content-type": "application/json;charset=UTF-8" } 响应头: 响应参数: { "sipServiceIp": "10.10.96.98", "sipServicePort": 5060, "agents": [ { "workNo": 1522, "accountCode": "aaaa", "sipAccount": "88881619", "sipPwd": "***" }, { "workNo": 1523, "sipAccount": "88881620", "sipPwd": "***" } ] }
  • 响应说明 响应状态码: 200 表2 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 sipServicePort string False 软电话注册端口,1~65535 长度限制:string(5) 1.2 sipServiceIp string False 软电话注册地址,IPV4格式 长度限制:string(50) 1.3 agents array[object] False 座席集合 1.3.1 workNo integer True 座席工号,范围从101到59999 1.3.2 sipAccount string False SIP软电话号码 长度限制:string(24) 1.3.3 sipPwd string False SIP软电话加密前密码 长度限制:string(24) 1.3.4 accountCode string False 关联的Service Cloud登录账号 长度限制:string(100) 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 请求头: x-app-key: XXXXXXXXXXXXXXXXXXXXXXX Content-Type: application/json Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "userAccount":"test123456" } 响应参数: { "resultCode": "0", "resultMessage": "delete AgentAccount success" }
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True 请求成功 1.1 resultCode string True 0成功,1失败 1.2 resultMessage string True 返回消息 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段,用户标识 2 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 accountCode string(64) True 登录账号,最长64个字符串 1.2 password string(64) False 鉴权用户密码,最长64个字符串 1.3 username string(64) False 鉴权用户名,最长64个字符串
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 returnCode string True 返回码 0:成功 1:失败 1.2 description string True 描述 1.3 data object False 返回数据,失败时参数workNo返回空字符串 1.3.1 workNo integer False 座席工号 1.3.2 agentType integer False 座席类型 1.3.3 agentStatus string False 座席状态,默认可用为0 响应状态码: 400 错误的请求:请检查请求路径及参数 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 请求头: x-app-Key:f**********************************e Authorization:Bearer a******************************2 请求参数: { "accountCode": "Agents" } 响应参数: { "returnCode": "0", "data": { "workNo": 7094, "agentType": 5, "agentStatus": "0" }, "description": "query success" } 场景描述:用户名密码登录 请求头: Content-Type:application/json 请求参数: { "accountCode": "Agents", "username": "itau_group", "password": "****************" } 响应参数: { "returnCode": "0", "data": { "workNo": 7094, "agentType": 5, "agentStatus": "0" }, "description": "query success" }
  • 报文样例 场景描述:根据技能队列ID查询座席信息 请求参数: { "skillId":3, "pageSize":10, "pageNum":0 } 响应参数: {"data": [ { "workNo": 107, "accountCode": "xxxxx", "agentType": 4, "agentWeight": 1, "accountName": "xxxxx", "sipAccount": "88880006", "skillWeight": 1 } ], "count": 1, "resultCode": "0" }
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 x-app-key string False appKey字段,用户标识,请联系运营人员获取appKey 2 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 requestParam object True 请求参数 1.1 skillId integer True 技能队列ID 1.2 pageSize integer True 分页大小,最大值为100 1.3 pageNum integer True 分页页号,从0开始
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True 请求成功 1.1 data array[object] False 返回数据 1.1.1 workNo number False 座席工号 1.1.2 agentType number False 座席类型: 4:音频座席; 11:视频座席 5:多媒体座席; 99:全能座席 1.1.3 agentWeight number False 座席权重,权重越高,越优先分配该座席,最低1 1.1.4 accountName string False 用户名称 1.1.5 sipAccount string False 软电话号码 1.1.6 skillWeight number False 技能队列权重,最低1 1.1.7 userAccount string False 座席账号,同创建座席的座席账号 1.2 count integer False 查询座席信息的数量 1.3 resultCode string False 请求成功返回0 ,请求失败返回1,会携带resultMessage,具体错误原因 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 请求头: Content-Type: application/json X-APP-Key: ************************************ Authorization: Bearer ******************************** 请求参数: {"customNos": ["135****1111", "wen11", "kehu@*****.com"]} 响应参数: {"retCode": "0","retMsg": "VerifyParams success"}
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 retMsg string True 失败原因的描述 1.2 retCode string True 返回码,0代表成功,其他为失败 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段,用户标识 2 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 3 Content-Type string False 内容类型,设置为application/json 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 customNos array True 客户号码列表(最多1000个,可以是主叫或被叫)