七鱼开发文档中心
总览服务端 APIWebiOSAndroid鸿蒙Uniapp微信小程序插件三方接入
在线系统接待事件

切换客服状态

按客服名称将在线客服切换到挂起状态,可携带挂起扩展状态。

请求参数

名称类型必填描述示例值
appKeystring是企业 AppKey。
timeint64是当前 UTC 时间戳,从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的秒数。
checksumstring是请求签名,签名规则参考通用说明的数据校验。
checksumAlgorithmint32否签名算法版本,默认 0。

请求体

名称类型必填描述示例值
staffNamestring是客服账号。staff_001
statusExtint32否挂起扩展状态。1、2 为有效值,具体含义以企业配置为准。1

返回参数

名称类型描述示例值
codeint32业务状态码,200 表示成功。200
messagestring响应信息。成功时该字段通常为空或不返回。success

错误码

状态码描述
400请求参数格式错误、缺少必要字段或请求体不是合法 JSON。
401鉴权失败、签名错误、AppKey 不存在或 time 超出允许范围。
500服务端处理异常。
8002业务错误码,HTTP 状态码仍为 200:参数错误,常见于请求体 JSON 不合法、缺少必填字段或字段格式不合法。
8003业务错误码,HTTP 状态码仍为 200:业务状态错误,例如质检任务状态错误或任务类型不匹配。
8108业务错误码,HTTP 状态码仍为 200:客服账号已停用。
14001业务错误码,HTTP 状态码仍为 200:AppKey 不存在或无效。
14002业务错误码,HTTP 状态码仍为 200:checksum 签名校验失败。
14003业务错误码,HTTP 状态码仍为 200:time 与服务器时间相差超过允许范围,或时间参数为空。
14004业务错误码,HTTP 状态码仍为 200:请求内容错误,例如请求体格式错误、缺少必填字段或字段值不合法。
14005业务错误码,HTTP 状态码仍为 200:无客服在线。
14006业务错误码,HTTP 状态码仍为 200:访客正在排队。
14008业务错误码,HTTP 状态码仍为 200:IP 白名单限制或 IP 被拦截。
14009业务错误码,HTTP 状态码仍为 200:请求过于频繁。
14010业务错误码,HTTP 状态码仍为 200:留言功能关闭。
14011业务错误码,HTTP 状态码仍为 200:接口未开放或被停用。
14014业务错误码,HTTP 状态码仍为 200:访客处于挂起状态。
14015业务错误码,HTTP 状态码仍为 200:访客正在分流中。
14500业务错误码,HTTP 状态码仍为 200:系统内部错误。
postEndpoint
/openapi/event/switchStaffStatus
POST
/openapi/event/switchStaffStatus
curl -X POST "https://qiyukf.com/openapi/event/switchStaffStatus?appKey=string&time=0&checksum=string" \  -H "Content-Type: application/json" \  -d '{    "staffName": "staff_001"  }'
{
  "code": 200,
  "message": "success"
}
空
空
空
{
  "code": 8002,
  "message": "参数错误,常见于请求体 JSON 不合法、缺少必填字段或字段格式不合法。"
}
{
  "code": 8003,
  "message": "业务状态错误,例如质检任务状态错误或任务类型不匹配。"
}
{
  "code": 8108,
  "message": "客服账号已停用。"
}
{
  "code": 14001,
  "message": "AppKey 不存在或无效。"
}
{
  "code": 14002,
  "message": "checksum 签名校验失败。"
}
{
  "code": 14003,
  "message": "time 与服务器时间相差超过允许范围,或时间参数为空。"
}
{
  "code": 14004,
  "message": "请求内容错误,例如请求体格式错误、缺少必填字段或字段值不合法。"
}
{
  "code": 14005,
  "message": "无客服在线。"
}
{
  "code": 14006,
  "message": "访客正在排队。"
}
{
  "code": 14008,
  "message": "IP 白名单限制或 IP 被拦截。"
}
{
  "code": 14009,
  "message": "请求过于频繁。"
}
{
  "code": 14010,
  "message": "留言功能关闭。"
}
{
  "code": 14011,
  "message": "接口未开放或被停用。"
}
{
  "code": 14014,
  "message": "访客处于挂起状态。"
}
{
  "code": 14015,
  "message": "访客正在分流中。"
}
{
  "code": 14500,
  "message": "系统内部错误。"
}

这篇文档有帮助吗?