华为云用户手册

  • 响应说明 表3 响应体参数 参数名称 数据类型 参数位置 必选/可选 描述 errorCode Int body True 错误码 返回0:成功 其他值:失败 errorMsg String body False 错误信息 total Int body False 总记录数 jobs RpaDetailJobResult[] body False 任务列表,成功时必须返回。 表4 RpaDetailJobResult 参数说明 参数名称 数据类型 参数位置 必选/可选 描述 uid String body False 任务UUID jobName String body False 任务名称 createTime String body False 任务创建时间 startTime String body False 任务开始时间 status String body False 任务状态,枚举类型为: init:待执行 running:运行 success:完成 suspend:暂停 mode string body False 执行方式:once、repeat runMode string body False 运行模式:在线online;离线offline timeout Integer body False 任务的超时时间,单位s description string body False 任务描述
  • 报文样例 请求消息头 Content-Type:application/json; charset=UTF-8userName:ODFS_SYS_OPENAPItoken:******************** 请求体消息 {"body": {"state": {"code": 0,"success": true },"body": {"aid": "FJKkMeepk8l","lattices": [{"begin": 4360,"end": 5970,"lid": 0,"onebest": "喂接通了吗?","spk": 0 }] } }} 响应体消息 { "retCode": "0", "retMsg": "success"}
  • 响应说明 响应状态码: 200 表7 响应体参数 序号 参数名 参数类型 说明 1 retCode String 0,成功,其他为失败。 2 retMsg String 失败原因的描述。 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 请求说明 表2 请求体参数 序号 参数名 参数类型 是否必选 说明 1 body Object True 回写结果。 该对象的参数说明请参见表3。 表3 body参数说明 序号 参数名 参数类型 是否必选 说明 1.1 state Object True 转写状态。 该对象的参数说明请参见表4。 1.2 body Object True 回写结果body体。 该对象的参数说明请参见表5。 表4 state参数说明 序号 参数名 参数类型 是否必选 说明 1.1.1 code String True 转写的结果编码。 1.1.2 success boolean True 转写是否成功,true标识成功,false标识失败。 表5 body参数说明 序号 参数名 参数类型 是否必选 说明 1.2.1 aid String True 音频文件唯一标识符,由客户端传入。 1.2.2 lattices List True 转写结果。 该对象的参数说明请参见表6。 表6 lattices参数说明 序号 参数名 参数类型 是否必选 说明 1.2.2.1 lid int True 片段序列号。 1.2.2.2 begin int True 分片开始时间。 1.2.2.3 end int True 分片结束时间。 1.2.2.4 onebest String True 转写后的文本。 1.2.2.5 spk int True 说话人的角色。
  • 报文样例 场景描述:丢弃邮件 URL:请求成功报文 请求头: x-app-Key:************************************ Authorization:Bearer ******************************** 请求参数: { "emailId":"10195068940994050"} 响应参数: { "returnCode": "0", "description": "dropMail success"}
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段,用户标识 2 Authorization string False 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 emailId string True email ID
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 returnCode string True 返回码。0:成功,3:邮件ID不存在 1.2 description string True 响应描述 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 联动状态 标示符 AgentEvent_linkagePhoneStatus 作用 表示某个座席话机状态。 附带信息 result:表示话机状态事件。0:摘机;1:挂机;2:通话中;3:话机上线;4:话机离线;5:振铃 示例: {"message":"","retcode":"0","event":{"eventType":"AgentEvent_linkagePhoneStatus","workNo":"120","content":{"result":2}}} 父主题: 话机联动事件
  • 报文样例 场景描述:WhatsAPP发送模板消息支持oAuth认证 URL:请求成功报文 请求头: {"x-app-key":"268e19b9-aae6-488a-bec6-5c9a67692946","Authorization":"Bearer 2febd549********************b9daff1","Content-Type":"application/json"} 请求参数: { "bulkId": "2853BC8B21D23F473AB9AE41B75F34FC18D322B91B01F60FAF206ACEBA9EF7BD", "whatsApp": { "templateName": "1", "templateData": [], "language": "zh_CN" }, "destinations": [ { "messageId": "46dbab11-f9cc-4d32-852b-cbba988b7d08", "to": { "phoneNumber": "155****8467" } } ]} 响应参数: { "messages": [ { "messageId": "10011", "to": { "phoneNumber": "173****6067" }, "status": { "groupName": "send-test", "groupId": 113, "name": "sendMessage", "description": "description", "id": 1 } } ], "bulkId": "20221025"}
  • 响应说明 响应状态码: 200 表12 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 messages array[object] True 已发送消息对象数组,每条消息一个对象 1.1.1 to object True 消息目的地地址 1.1.1.1 phoneNumber string True 目标电话号码。电话号码必须是国际格式(例如:41793026727) 1.1.2 status object True status对象 1.1.2.1 groupId number True 状态组id 1.1.2.2 groupName string True 状态组名称 1.1.2.3 id number True 状态id 1.1.2.4 name string True 状态名称 1.1.2.5 description string True 状态的可读描述。 1.1.2.6 action string False 应采取的消除错误的操作。 1.1.3 messageId string True 唯一标识已发送消息的ID 1.2 bulkId string True 唯一标识请求的ID。 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 错误的请求:请依次确认您请求中各参数的取值。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 2 x-app-key string True appKey字段,用户标识,在ApiFabric工具上配置 3 Content-Type string True 内容类型 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 scenarioKey string False 唯一标识发送消息时将使用的方案的方案密钥。如果未设置此字段,将使用默认方案。 AICC不会发送此字段。 1.2 bulkId string True 唯一标识请求的ID。只有当您将消息发送到多个目标地址时,才会收到批量ID。 1.3 destinations array[object] True 消息收件人列表。 1.3.1 messageId string True 唯一标识已发送消息的ID 1.3.2 to object True 消息目的地地址 1.3.2.1 phoneNumber string True 目标电话号码。电话号码必须是国际格式(例如:41793026727) 1.4 whatsApp whatsApp True 封装的whatsapp对象 1.5 sendAt string False 要发送消息的日期和时间。用于计划的OMNI消息传递(OMNI流中的第一条消息不会立即发送,但会在计划的时间发送)。 表3 whatsApp参数结构 序号 名称 参数类型 是否必选 说明 1.1 text string False 将发送的消息的文本。 1.2 imageUrl string False WhatsApp消息中发送的图像的URL。最多2048个字符。支持的图像类型:jpg、jpeg、png。最大图像大小为2MB。 1.3 audioUrl string False WhatsApp消息中发送的音频文件的URL。最多2048个字符。支持的音频类型有AAC。最大音频大小为2MB。 1.4 videoUrl string False WhatsApp消息中发送的视频的URL。最多2048个字符。支持的视频类型为MP4。最大视频大小为10MB。 1.5 locationName string False 最大长度为1000。 将发送的消息的文本。 1.6 address string False 最大长度为1000。 地址位置,可选值。 1.7 longitude number False 坐标的经度。该值必须介于-180和180之间。 1.8 latitude number False 坐标的纬度。该值必须介于-90和90之间。 1.9 templateName string False 模板名称 1.10 templateData array[string] False 按模板中注册的顺序排序的模板参数值 1.11 language string False 要使用的语言或区域设置的代码。需要与注册模板时使用的代码完全相同。 1.12 mediaTemplateData mediaTemplateData False mediaTemplateData封装对象 表4 mediaTemplateData参数结构 序号 名称 参数类型 是否必选 说明 1.1 header HeaderObject False 媒体模板标题。对于包含标题的媒体模板是必需的。 1.2 body BodyObject False 媒体模板体 1.3 buttons array[object] False 媒体模板按钮 表5 HeaderObject参数结构 序号 名称 参数类型 是否必选 说明 1.1 textPlaceholder string False 文本占位符。对于包含文本标题的模板是必需的。 1.2 imageUrl string False 图像URL。对于包含图像标题的模板是必需的。支持的图像类型:jpg、jpeg、png。最大图像大小为2MB。 1.3 videoUrl string False 视频URL。对于包含视频标题的模板是必需的。支持的视频类型为MP4。最大视频大小为10MB。 1.4 latitude number False 位置纬度。该值必须介于-90和90之间。对于包含位置标题的模板是必需的。 1.5 longitude number False 位置经度。该值必须介于-180和180之间。对于包含位置标题的模板是必需的。 表6 BodyObject参数结构 序号 名称 参数类型 是否必选 说明 1.1 placeholders array[string] False 媒体模板正文占位符。该值不能为空,但可以是空数组。数组中的值不能为Null或空 表7 ButtonObject参数结构 序号 名称 参数类型 是否必选 说明 1.1 urlPlaceholder string False 要发送消息的日期和时间。用于计划的OMNI消息传递(OMNI流中的第一条消息不会立即发送,但会在计划的时间发送)。 1.2 quickReplyPayload string False 快速回复有效载荷。快速回复按钮需要 表8 destinations参数结构 序号 名称 参数类型 是否必选 说明 1.1 messageId string True 唯一标识已发送消息的ID 1.2 to toObject True 消息目的地地址 表9 MessageObject参数结构 序号 名称 参数类型 是否必选 说明 1.1 to toObject False 消息目的地地址 1.2 status StatusObject False 指示消息是否已成功发送、未发送、已传递、未传递、正在等待传递或任何其他可能的状态。 1.3 messageId string False 唯一标识已发送消息的ID 表10 toObject参数结构 序号 名称 参数类型 是否必选 说明 1.1 phoneNumber string True 目标电话号码。电话号码必须是国际格式(例如:41793026727)。 表11 StatusObject参数结构 序号 名称 参数类型 是否必选 说明 1.1 groupName string True 状态组名称 1.2 id integer True 状态ID 1.3 groupId integer True 状态组ID 1.4 name string True 状态名称 1.5 action string False 应采取的消除错误的操作 1.6 description string True 状态的可读描述
  • 报文样例 请求消息样例 { "tenantId": "202201072597", "authToken": "oqyo*******************fGMCu", "pageNo": 1, "pageSize": 10, "conditions": { "uid": "000145cdb75b3a514821872b9734f02ae76d", "queueUid": "00019cad3dd5c71d4696b209d7024fa04d3a" }} 响应消息样例 { "errorCode": 0, "errorMsg": null, "total": 1, "queueData": [ { "id": 44, "uid": "000145cdb75b3a514821872b9734f02ae76d", "queueName": "创建工单", "queueUid": "00019cad3dd5c71d4696b209d7024fa04d3a", "createTime": 1651027548328, "expectStartTime": null, "expectEndTime": null, "status": "success", "priority": "normal", "inactived": "active", "tag": null, "inputJsonData": "{\"caseId\":\"0607000000t1FY2F0Mb2\"}", "outputJsonData": null, "analysisJsonData": null, "failedReason": null, "failedReasonDetail": null, "description": "描述队列数据", "progress": null } ]}
  • 响应说明 表3 响应体参数 参数名称 数据类型 参数位置 必选/可选 描述 errorCode int body True 错误码 返回0:成功 其他值:失败 errorMsg String body False 错误信息 total int body False 队列数据条数,成功时必须返回。 queueData QueueData[] body False 队列数据,成功时必须返回。 表4 QueueData参数说明 参数名称 数据类型 参数位置 必选/可选 描述 id long body False 队列数据自增ID uid string body False 队列数据UUID queueName string(32) body False 队列名称 queueUid string body False 队列UUID createTime long body False 创建时间(0-7258089600000L)时间戳 expectStartTime long body False 计划开始时间(0-7258089600000L)时间戳 expectEndTime long body False 计划结束时间(0-7258089600000L)时间戳 status string body False 队列状态枚举类型为: init:等待处理 processing:处理中 success:成功 failed:失败 priority string body False 优先级枚举类型为: low:低 normal:中 high:高 inactived string body False 队列启用状态枚举类型为: active:已启用 inactive:已停用 tag string(32) body False 队列数据标签 inputJsonData string(65535) body False 输入的队列数据,json格式字符串 outputJsonData string(65535) body False 输出的结果数据,json格式字符串 analysisJsonData string(65535) body False 中间的队列数据,json格式字符串 failedReason string(512) body False 失败原因 failedReasonDetail string(65535) body False 失败原因细节 description string(100) body False 队列数据描述 progress int body False 进度(0-100)
  • 请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID 限制长度:64 authToken String body True 访问接口的有效Token值。 有效Token信息通过 获取Token 接口获取。 请参见C3 智能助手平台接口鉴权方式。 限制长度:32 pageNo Integer body False 查询页数,默认1页 pageSize Integer body False 每页多少条,默认50条 可选值:5,10,20,50 conditions RpaQueueDataConditions body True 查询条件。 队列数据uid或者队列queueUid必须传入一个值。 表2 RpaQueueDataConditions参数 参数名称 数据类型 参数位置 必选/可选 描述 uid string body False 根据队列数据UUID查询(至少传递uid、queueUid、queueName中一个参数) queueUid string body False 根据队列数据UUID查询(至少传递uid、queueUid、queueName中一个参数) queueName string(32) body False 根据队列名称查询(至少传递uid、queueUid、queueName中一个参数) tag string body False 根据队列数据标签查询 status string body False 根据队列状态查询,枚举类型为 init:等待处理 processing:处理中 success:成功 failed:失败 inactived string body False 根据队列启用状态查询,枚举类型为: active:已启用 inactive:已停用 不传该参数,默认查询已启用 priority string body False 根据队列优先级查询,枚举类型为: low:低 normal:中 high:高
  • 报文样例 请求消息样例 { "tenantId": "202201072597", "authToken": "hjbLfhU*******************Fv3nq", "uid": "0c9358552188478a8d5ff9203db8791f"} 响应消息样例 { "errorCode": 0, "errorMsg": null, "jobDetail": { "jobName": "AICC_RPA", "queueUid": "00019cad3dd5c71d4696b209d7024fa04d3a", "workstationName": "AICC_RPA", "runMode": "online", "timeout": 120, "mode": "queueTrigger", "uid": "0c9358552188478a8d5ff9203db8791f", "procedureVersion": "1.0.5", "queueName": "创建工单", "createTime": "2022-04-24 17:12:02", "procedureName": "AICC_RPA", "startTime": "2022-04-29 11:47:25", "jobType": "procedure", "recentTaskStatus": "failed", "status": "running" }}
  • 响应说明 表2 响应体参数 参数名称 数据类型 参数位置 必选/可选 描述 errorCode Int body True 错误码 返回0:成功 其他值:失败 errorMsg String body False 错误信息 jobDetail RpaDetailJobResult[] body False 队列详情 表3 RpaDetailJobResult参数说明 参数名称 数据类型 参数位置 必选/可选 描述 uid string body True 任务UUID jobName string body True 任务的名称 startTime string body False 作业开始时间, 格式:yyyy-mm-dd HH:mm:ss createTime string body True 作业创建时间, 格式:yyyy-mm-dd HH:mm:ss workstationName string body False 执行器名称 clusterName string body False 集群名称 runMode string body True 运行模式:在线online mode string body True 执行方式:once、repeat、queueTrigger jobType string body True 任务类型固定为procedure status string body True 任务状态条件搜索,如下: init:待执行 running:运行 suspend:暂停 success:完成 procedureName string body True 脚本包名称 procedureVersion string body True 脚本包版本 description string body True 任务描述 timeout int body False 任务超时时间 recentTaskStatus string body False 最近一次作业状态,没有生成作业的任务不会返回该字段 queueUid string body False 队列的UUID queueName string body False 队列名称
  • 请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID 限制长度:64 jobName String body False 任务名称(根据jobName来查询,uid可设置为null,jobName或者uid必须传入一个值。) uid String body False 任务UUID(jobName和uid都填,以uid为准,jobName或者uid必须传入一个值。) authToken String body True 访问接口的有效Token值。 有效Token信息通过获取Token接口获取。 请参见C3 智能助手平台接口鉴权方式。 限制长度:32
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段,用户标识 2 Authorization string True 鉴权字段,内容格式为:Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 callId string True 呼叫id 2 userId string True 用户id 3 tenantId string True 租户id
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 userNickname string True 姓名 2 userId string True 用户id 3 userAvatar string False 用户头像 4 channel string True 渠道名称,例如WEB,WECHAT,FACEBOOK 5 createTime string True 创建时间 6 channelConfigId string True 渠道配置id 7 userAgent string False 用户代理 8 clientIp string False 客户端IP 9 osName string False 操作系统名称 10 borderType string False 操作系统版本 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 场景描述:创建座席账号 URL:见文档 x-app-key: XXXXXXXXXXXXXXXXXXXXXXX Content-Type: application/json Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "userAccount":"test123456", "userName":"test111", "password":"Te******4", "email":"t**@******.com", "agentType":11, "ccRoleId":2, "skills":[{"skillId":3,"agentWeight":1, "skillWeight":1}, {"skillId":2,"agentWeight":1, "skillWeight":2}]} 响应参数: { "resultCode": "0", "resultMessage": "create agent account success", "workNo": 108}
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True 请求成功 1.1 resultCode string True 字符串,0成功,1失败 1.2 resultMessage string True 相关消息 1.3 workNo integer False 座席工号。 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True 请求成功 1.1 resultCode string True 0成功,1失败 1.2 resultMessage string True 返回消息 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 请求头: x-app-key: XXXXXXXXXXXXXXXXXXXXXXXContent-Type: application/jsonAuthorization: Bearer XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "userAccount":"test123456", "userName":"te****3", "email":"T***@*******.com","phone":"18433335555", "agentType":5, "ccRoleId":2, "skills":[{"skillId":1,"agentWeight":1, "skillWeight":1}], "oldPassWord":"xxxxx","newPassWord":"xxxxxxx"} 响应参数: { "resultCode": "0", "resultMessage": "edit 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 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 请求头: x-app-key: XXXXXXXXXXXXXXXXXXXXXXXContent-Type: application/jsonAuthorization: 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 返回消息 1.3 data array[object] False 返回结果对象 1.3.1 userAccount string False 座席业务账号 1.3.2 userName string False 座席业务账号用户名 1.3.3 phone string False 电话号码 1.3.4 email string False 邮箱 1.3.5 agentType integer False 座席类型: 4:音频座席; 11:视频座席 5:多媒体座席; 99:全能座席 255:闲置的座席 1.3.6 ccRoleId integer False 座席角色id: 2:话务员; 3:质检员; 4:外呼座席 255:闲置角色 1.3.7 sipAccount string False 座席默认软电话号码 1.3.8 skills array[object] False 技能参数数组 1.3.8.1 skillId integer False 技能队列Id 1.3.8.2 agentWeight integer False 座席权重 1.3.8.3 skillWeight integer False 技能队列权重 1.3.9 workNo integer False 座席工号 1.3.10 transparentDisplayFlag boolean False 座席透显特性标记 1.4 total integer False 总数 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 场景描述:查询座席业务账号——按业务账号查询 请求头: x-app-key: XXXXXXXXXXXXXXXXXXXXXXXContent-Type: application/jsonAuthorization: Bearer XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "userAccount":"test123456"} 响应参数: { "data": [ {"skills": [ { "skillId": 2,"agentWeight": 1, "skillWeight": 2}], "agentType": 11, "phone": "", "userAccount": "test123456", "ccRoleId": 2, "userName": "test111", "sipAccount": "88880551", "email": "tst@*****.com" } ], "resultCode": "0", "resultMessage": "get agent account info success"} 场景描述:查询座席——按分页查询 请求头: x-app-key: XXXXXXXXXXXXXXXXXXXXXXXContent-Type: application/jsonAuthorization: Bearer XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "pageNum":0,"pageSize":1} 响应参数: { "data": [ { "skills": [{"skillId": 3,"agentWeight": 1, "skillWeight": 1} ], "agentType": 4,"phone": "","userAccount": "chenchuang0513", "ccRoleId": 2, "sipAccount": "88880550","userName": "chenchuang0513", "email": "che@*****.com" },...], "resultCode": "0", "resultMessage": "get agent account info success"}
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 x-app-key string False appKey字段,用户标识,请联系运营人员获取appKey 2 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 requestParams object True 请求参数对象 1.1 userAccount string False 座席业务账号,不含分页参数pageNum,pageSize时必填,传userAccount时,其他入参无效 1.2 pageNum integer False 页号,不填userAccount时生效,从0开始 1.3 pageSize integer False 每页大小,不填userAccount时生效 1.4 agentType array False 座席类型: 4:音频座席; 11:视频座席 5:多媒体座席; 99:全能座席 1.5 transparentDisplayFlag boolean False 座席透显特性标记
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 x-app-key string False appKey字段,用户标识,请联系运营人员获取appKey 2 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 requestParam object True 请求参数 1.1 accountPwd string True 座席当前密码,修改软电话密码时需要校验座席当前密码,如果校验失败三次,会锁账号,当前会在30分钟后解锁,也可以登入租户管理员账号人工解锁。 1.2 newPhonePwd string True 新软电话密码,长度8-16位(默认密码规则组),默认需要提供以下三种的任意组合:大写字母、小写字母、数字和特殊字符。 特殊字符支持 ~@^*_+.? 1.3 userAccount string True 座席账号
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True 请求成功 1.1 resultCode string True 请求成功为0,请求失败为1 1.2 resultMessage string False 请求失败,resultCode为1时会携带具体原因 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
共100000条