坐席管理 – 签入或签出队列

为指定的动态坐席签入或签出单个或多个队列。

请求 URL

GET {base_url}/{api_path}/agent/login?access_token={access_token}

请求参数

参数 是否必填 类型 说明
ext_id 是 Integer 动态坐席的分机 ID。
注： 可使用 搜索特定分机 接口查询坐席的分机 ID。
queue_ids 否 String
重要： 若未填写此参数，则默认签入或签出指定坐席的全部队列。
坐席要签入或签出的队列的唯一 ID。
注：
  • 使用半角逗号 , 分隔多个队列 ID。
operation 是 String 将坐席签入或签出指定队列。
取值范围：
  • login：将动态坐席签入队列。
  • logout：将动态坐席签出队列。
is_paused 否 Integer 在将动态坐席签入队列后，是否暂停其坐席服务。
取值范围：
  • 0：签入队列后不暂停其坐席服务。
  • 1：签入队列后暂停其坐席服务。
注： 如果你没有设置该参数，则默认赋值 0。
reason 否 String 暂停原因特征码。
取值范围：PBX 中已有暂停原因的特征码。
注：
  • 如果 PBX 未订阅 呼叫中心 服务，请勿传入此参数，否则会导致请求失败。
  • 可使用 查询暂停原因列表 接口查询暂停原因的特征码。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。

示例

请求示例

将动态坐席 (分机 ID：85) 签入其所在的全部队列，并且在签入后暂停其坐席服务。

GET /openapi/v1.0/agent/login?access_token=u6UfsayUeBpUrwwpaBs6hkDeCzEE6D6t&ext_id=85&operation=login&is_pause=1 HTTP/1.1
Host: 192.168.5.150:8088
响应示例
HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS"
}