请求分配客服

POST

https://qiyukf.com/openapi/event/applyStaff

分配客服的逻辑如下，按照优先级从高到低匹配：

如果指定了客服 ID（staffId），则忽略 staffType 和 groupId 两个参数，只会分配到该客服，如果这个客服不在线，则返回客服不在线，如果该客服已排满，则返回需要排队。如果当前用户已经有另外一个客服在服务，则会先关闭与前一个客服的会话。

如果指定了客服分组 ID（groupId), 则忽略 staffType 这个参数，只会分配到该分组内的客服，如果该分组内没有客服在线，则返回客服不在线，如果该分组内客服已排满，则返回需要排队。如果当前用户已经有另外一个分组内的客服在服务，则先回关闭与前一个客服的会话。

如果指定了客服类型（staffType），如果用户当前已经有客服在服务中，且 staffType 为 0 或者没有传 staffType，则直接返回该会话客服。否则，如果该参数为 0 或者没有传递，则会返回机器人会话，如果该参数为1，且robotShuntSwitch参数为1，则在申请人工客服之前先申请机器人客服，转人工后再申请人工客服，若robotShuntSwitch为0或不传则直接申请人工客服，在所有在线客服中分配一个空闲客服，如果没有客服在线，则返回客服不在线，如果所有客服都已经排满，则会返回需要排队。

如果指定了robotId，那么当需要生成机器人会话时，会进入到该robotId对应的机器人中。多机器人配置详见机器人 -> 机器人列表

如果返回客服不在线，服务将自动进入留言模式，用户发送的消息将会保存在留言中，留言过程中，如果客服上线了，将自动转人工客服。

如果用户处于机器人服务状态，想要切换为人工服务，将staffType置为1重新调用一遍该接口即可，也可以带上指定的客服或客服分组参数。

如果用户处于有客服服务状态，想切换为其他客服，带上想要切换的客服或者客服分组，重新调用一遍该接口即可。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://qiyukf.com/openapi/event/applyStaff?appKey=&time=&checksum=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "uid": "user1",
    "fromPage": "www.163.com",
    "fromTitle": "Netease",
    "fromIp": "220.220.2.1",
    "deviceType": "Android#xiaomi#5.0",
    "productId": "Android package name",
    "staffType": 1,
    "staffId": 0,
    "groupId": 0,
    "robotShuntSwitch":0,
    "level":0,
    "robotId":22
}'

响应示例

{
  "code": 200,
  "staffId": 1234,
  "message": "哈哈",
  "count": 0,
  "sessionId": 62927,
  "staffName": "lantian",
  "staffType": 0,
  "staffIcon": "https://ysf.nosdn.127.net/29C25737ABC2524667D223A90FEF156D",
  "evaluationModel": {
    "title": "模型一",
    "note": "二级评价模型",
    "type": 2,
    "list": [
      {
        "name": "满意",
        "value": 100
      },
      {
        "name": "不满意",
        "value": 1
      }
    ]
  }
}

请求参数

Query 参数

appKey

string

必需

企业的appKey，1064deea1c3624c9ee26d1de5ce8481f

默认值:

time

string

必需

当前 UTC 时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的秒数,1463217187

默认值:

checksum

string

必需

SHA1(appSecret + md5 + time), 三个参数拼接的字符串，进行SHA1哈希计算，转化成16进制字符(String，小写).示例2f13932c4b7c6888b12360a85261a11b8b543f64

默认值:

Body 参数application/json

uid

string

必需

开发者的应用里的用户 ID。

fromPage

string

可选

用户发起咨询客服操作的页面 url，比如商品链接，订单页面等。

fromTitle

string

可选

fromPage 页面的标题。

fromIp

string

可选

deviceType

string

用户设备类型信息。

可选

productId

string

可选

产品标识，可以是 Android 应用的包名，iOS 应用的 bundleid 等。

staffType

integer

可选

请求分配的客服类型，如果传0，表示机器人，传1表示人工。默认为机器人。

staffId

integer

可选

只请求该 ID 的客服，客服 ID 可在管理后台查看。

groupId

integer

可选

只请求该客服分组 ID 内的客服，分组 ID 可在管理后台查看。

robotShuntSwitch

integer

可选

申请人工客服之前是否先申请机器人开关，0代表关闭，1代表启用。

level

integer

可选

该访客这次会话的vip等级，从0到11

robotId

integer

可选

有多个机器人时，指定接入某一个机器人。

示例

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码。200表示分配到客服，14005：没有客服在线，14006：需要排队，14010：没有客服在线，且留言功能已关闭。

staffId

integer

客服 ID。

必需

message

string

必需

如果分配到客服，此字段是客服的欢迎语，如果没有分配到客服，则是错误提示信息。

count

integer

必需

仅返回需要排队时该参数有效，表明排队队列中排在你前面你的人数。如果为0，则表示你排在队列最前面。

sessionId

integer

必需

会话 ID，后续对会话评价时有用。仅返回分配到客服时该参数有效。

staffName

string

客服名字。

必需

staffType

integer

必需

客服类型，0 表示机器人，1 表示人工会话。

staffIcon

string

必需

客服头像的 url。

evaluationModel

object

必需

满意度评价模型，在申请到人工客服时有值，后面根据该模型 value 值进行客服评价。

title

string

必需

note

string

必需

type

integer

必需

list

array [object {2}]

必需

修改于 2022-01-28 04:24:28

上传文件-base64 方式

客服组排队情况查询