文档首页/ 云客服/ API参考/ 网页客户端接入/ 查询排队信息 (queryQueueInfo)
更新时间:2024-08-02 GMT+08:00

查询排队信息 (queryQueueInfo)

描述

查询排队信息,用于客户侧排队提醒。

排队信息必须在通过send接口建立连接(connect)成功之后,才可使用。

接口方法

POST

接口URI

https://域名/apiaccess/ccmessaging/queryQueueInfo,例如域名是service.besclouds.com

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

ccmessaging-token

string

False

  • applyToken接口返回的token值。
  • 会话过程中接口Response Header中返回的ccmessaging-token的值。

2

x-app-key

string

False

appKey字段,用户标识,在API Fabric上配置

3

Authorization

string

False

鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格)

表2 请求体参数

序号

名称

参数类型

是否必选

说明

1

reqBody

ReqBody

True

请求体

表3 ReqBody参数结构

序号

名称

参数类型

是否必选

说明

1.1

userId

string

True

客户的唯一标识。取值范围:1到24位字符串。

1.2

channelConfigId

string

True

渠道配置id

1.3

channel

string

True

渠道类型

响应说明

  • 响应状态码: 200
    表4 RspMsg200参数结构

    序号

    名称

    参数类型

    是否必选

    说明

    1.1

    position

    integer

    False

    本呼叫在队列中的位置

    1.2

    totalWaitTime

    integer

    False

    本呼叫累计排队时长(秒)

    1.3

    currentDeviceWaitTime

    integer

    False

    当前技能队列的实际等待时长(秒)

    1.4

    configMaxcWaitTime

    integer

    False

    配置的最大等待时长(秒)

    1.5

    longestWaitTime

    integer

    False

    队列中正在排队呼叫的最大排队时长(秒)

    1.6

    estimateWaitTime

    integer

    False

    对应队列的预估呼叫等待时长(秒)

    1.7

    resultCode

    string

    True

    查询排队信息返回码。具体错误码信息如下:

    0:正在排队,查询成功。

    1:参数错误。

    2:CCUCS请求失败。

    3:Token错误。

    4:未知错误。

    5:会话已结束。

    6:CCUCS会话已失效。

    160001:CCUCS通信失败。

    160004:会话不存在或已结束。

    160021:当前会话已经转到座席,不在排队状态。

    160022:当前会话已转移到IVR,不在排队状态。

    160023:当前会话已转移到私有队列,不在排队状态。

    160024:座席未应答。

  • 响应状态码: 400

    错误的请求:请检查请求路径及参数。

  • 响应状态码: 401

    未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。

  • 响应状态码: 404

    请求的内容未找到:请检查请求的路径。

  • 响应状态码: 500

    业务失败:请依次确认您请求中各参数的取值。

错误码

无。

报文样例

  • 场景描述:查询排队信息

    请求头:

    ccmessaging-token: xxxx
    x-app-key: xxxx
    Authorization: Bearer xxxx
    Content-Type: application/json

    请求参数:

    {
        "userId": "xxxx",
        "channelConfigId": "xxxxx",
        "channel": "WEB"
    }

    响应参数:

    {
        "totalWaitTime": 3,
        "resultCode": "0",
        "longestWaitTime": 3,
        "position": 1,
        "currentDeviceWaitTime": 3,
        "configMaxcWaitTime": 60,
        "estimateWaitTime": 60
    }