云服务器内容精选

  • 报文样例 请求头: Content-Type:application/json X-APP-KEY:XXXXXXXXXXXXXXXXXXXXXXX Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "skillId": 3, "description": "2021ok", "maxWaitTime": 60 } 响应参数: { "returnCode": "0", "description": "Update Skill successfully" }
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-KEY string False appKey字段,用户标识,请联系运营人员获取appKey 2 Authorization string True 鉴权信息,值为Bearer + tokenByAKSK接口的返回值中的AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 description string False 技能简称或描述,不超过50个字符(允许的字符包括中文、字母、数字) 1.2 maxWaitTime number False 最大排队等待时间,单位秒,最大值60000 1.3 maxWaitNum number False 最大排队等待人数,最大值10000 1.4 maxAgentWrapupTime number False 整理态时长,单位秒,最大值3600 1.5 skillParam object False 技能队列参数信息,媒体类型为53或2或18时,只有noAgents、busy和timeOut三项配置,媒体类型为53时deviceType的值只能为1;媒体类型为5或19时noAgents、busy、timeOut、answerFunction和waitVoice配置必填 1.5.1 noAgents object True 无人上班配置 1.5.1.1 deviceType string False 设备类型。 3:IVR 1:技能队列 1.5.1.2 transferType string True 处理策略。 Release:释放,此时同级其他参数不填 Transfer:转接,此时同级其他参数必填 1.5.1.3 value number False 技能队列时取skillId,IVR时取IVR流程编号id 1.5.2 busy object True 排队遇忙、溢出配置 1.5.2.1 deviceType string False 设备类型 3:IVR 1:技能队列 1.5.2.2 transferType string True 处理策略。 Release:释放,此时同级其他参数不填 Transfer:转接,此时同级其他参数必填 1.5.2.3 value number False 技能队列时取skillId,IVR时取IVR流程编号id 1.5.3 answerFunction string False 业务代表应答方式配置,0报工号2不报语音 1.5.4 timeOut object True 排队超时配置 1.5.4.1 deviceType string False 设备类型 3:IVR 1:技能队列 1.5.4.2 transferType string True 处理策略。 Release:释放,此时同级其他参数不填 Transfer:转接,此时同级其他参数必填 1.5.4.3 value number False 技能队列时取skillId,IVR时取IVR流程编号id 1.5.5 waitVoice object False 排队等待配置 1.5.5.1 parameterType string True Voice:Voice,此时同级其他参数不填 IVR:IVR,此时同级其他参数必填 1.5.5.2 id string False IVR时取IVR流程编号id 1.6 skillId integer True 技能队列ID
  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "message": "", "retcode": "0", "result": { "workno": "20011", "name": "20011", "status": "4", "ctiStatus": "1", "groupid": 1, "groupname": "jst", "skilllist": [ { "name": "clicktodial_jst", "id": 10, "mediatype": 2 }, { "name": "callback", "id": 2, "mediatype": 4 }, { "name": "webchat", "id": 3, "mediatype": 1 }, { "name": "email", "id": 4, "mediatype": 6 }, { "name": "voice_hym", "id": 5, "mediatype": 5 }, { "name": "voice", "id": 6, "mediatype": 5 }, { "name": "webchat_jst", "id": 9, "mediatype": 1 } ], "mediatype": "TTT", "vdnid": 6, "phonenumber": "70942", "currentstatetime": 1210, "logindate": 1501125758000, "callids": [], "inMultimediaConf": 0, "currentStateReason": 0 } }
  • 响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下: 0:成功 非0:失败 3 result object 查询成功后,返回座席对象列表。 该对象的参数说明请参见表4。 表4 result对象参数说明 序号 名称 参数类型 说明 3.1 workno string 座席工号 3.2 name string 座席名称 3.3 status int 座席状态,参见表1 3.4 ctiStatus int 座席平台状态,请参考表2 3.5 groupid int 座席班组ID 3.6 groupname string 未使用该返回参数 3.7 skilllist list 座席技能对象列表 该对象的参数说明请参见表5。 3.8 callids list 未使用该返回参数 3.9 mediatype string 签入媒体服务器是否成功,T表示成功,F表示失败,三位分别表示CTIServer、WebM、MailM。只有签入CTIServer成功,才能进行音视频呼叫业务处理;只有签入WebM成功,才能进行文字交谈业务处理;当前不支持签入MailM。 3.10 vdnid int 所属VDN ID 3.11 phonenumber string 座席电话号码 3.12 currentstatetime long 当前状态时长(秒) 3.13 logindate long 签入时间,时间戳(毫秒) 3.14 inMultimediaConf int 是否在多媒体会议中。 0表示不在多媒体会议中。 1表示在多媒体会议中。 3.15 currentStateReason int 当前状态原因码
  • 接口URI https://ip:port/agentgateway/resource/agentgroup/{agentid}/agentbyworkno/{workno} 其中,ip为agentgateway服务器地址,port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。 2 workno string True 待查询的座席工号,取值范围:101~59999。 该座席工号必须与前面agentid为同一vdn下面的座席。
  • 响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下: 0:成功 非0:失败 3 result array 查询成功后,返回技能队列信息的对象。 该对象的参数说明请参见表4。 表4 result对象参数说明 序号 名称 参数类型 说明 3.1 name string 技能名称 3.2 id int 技能ID 3.3 mediatype int 媒体类型。其中: 1:文字交谈 2:点击通话 4:回呼请求 5:普通音视频电话 15:预测呼出 16:预浏览呼出 17:消息呼叫 19:视频普通呼叫 51:多媒体Web Chat 53:Social Chat 3.4 serviceType int 业务类型编号 3.5 realFlag int 1表示实队列。0表示虚队列。
  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "message": "", "retcode": "0", "result": [ { "name": "voice", "id": 1, "mediatype": 5, "serviceType": 1, "realFlag": 1 }, { "name": "callback", "id": 2, "mediatype": 4, "serviceType": 1, "realFlag": 1 }, { "name": "webchat", "id": 3, "mediatype": 1, "serviceType": 1, "realFlag": 1 }, { "name": "email", "id": 4, "mediatype": 6, "serviceType": 3, "realFlag": 1 } ] }
  • 接口URI https://ip:port/agentgateway/resource/queuedevice/{agentid}/ivrinfo 其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下: 0:成功 非0:失败 3 result array 查询成功时,返回IVR信息。 该对象的参数说明请参见表4 表4 result参数说明 序号 名称 参数类型 说明 3.1 access string 流程接入码。 3.2 id int IVR流程ID。 3.3 description string IVR流程描述。 3.4 serviceNo int 服务ID。
  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "result": [ { "access": "1321", "id": 1, "description": "252", "serviceNo": 1 } ], "message": "success", "retcode": "0" }
  • 报文样例 请求头: Content-Type:application/jsonX-APP-KEY:XXXXXXXXXXXXXXXXXXXXXXXAuthorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "limit": "10", "offset": 0} 响应参数: { "returnCode": "0", "total": 1, "data": [ { "skillId": 1, "maxAgentWrapupTime": 5, "maxWaitTime": 60, "name": "defaultVideoSkill", "mediaTypeId": 19, "description": "2021ok", "maxWaitNum": 100, "skillParam": { "noAgents": { "transferType": "Release" }, "busy": { "transferType": "Release" }, "answerFunction": "0", "timeOut": { "transferType": "Release" }, "waitVoice": { "parameterType": "Voice" } } } ], "description": "success"}