强制客服人员退出端点

借助强制客服人员退出端点，您可以强制在线客服人员退出。正在通话或聊天的客服人员会在完成当前互动后自动退出。处于空闲状态的客服人员会立即退出。此端点支持强制特定客服人员、整个团队或通过 CIDR 表示法、IPv4/IPv6 地址列表或 IP 范围标识的客服人员退出。对于大量客服人员，系统会创建一个后台作业来高效管理退出流程。

以下是强制客服人员退出 API 端点：

强制客服人员退出

借助此端点，您可以让特定客服人员退出。您可以通过以下方式标识客服人员：

  • 客服人员 ID。

  • 团队 ID。

  • IP 地址。

端点：

Method: POST
Type: RAW
URL: https://{subdomain}.{domain}/apps/api/v1/agent_statuses/force_logout

标头：

键 值 说明
Content-Type application/json
接受 application/json

正文：

{
    "agent_ids": [
        11,
        12
    ],
    "team_ids": [
        1
    ],
    "ip_addrs": [
        "34.211.11.0/24"
    ]
}

请求和响应示例

以下部分提供了针对该端点的请求示例。

成功让客服人员退出

此示例演示了如何根据客服人员 ID 和团队 ID 让特定客服人员退出。在本例中，客服人员 ID 为 11 和 12，团队 ID 为 1。

请求

标头：

键 值 说明
Content-Type application/json

正文：

{
    "agent_ids": [
        11,
        12
    ],
    "team_ids": [
        1
    ]
}
响应
[
    {
        "agent_id": 11,
        "name": "Darth Vader",
        "email": "notanakinskywalker@empire.com",
        "agent_number": "Agent No.111",
        "previous_status": "lunch",
        "current_status": "Offline"
    },
    {
        "agent_id": 12,
        "name": "Craig T",
        "email": "craigT@nelson.com",
        "agent_number": "Agent No.112",
        "previous_status": "Unavailable",
        "current_status": "Offline"
    },
    {
        "agent_id": 13,
        "name": "Raymond D",
        "email": "rayd@nelson.com",
        "agent_number": "Agent No.113",
        "previous_status": "Break",
        "current_status": "Offline"
    }
]

状态代码： 200

使用 IP 地址成功让客服人员退出

此示例演示了如何通过指定 IP 地址范围让客服人员退出。 在本例中，提供的 IP 地址范围为 34.211.11.0/24。

请求

标头：

键 值 说明
Content-Type application/json

正文：

{
    "agent_ids": [
        11,
        12
    ],
    "team_ids": [
        1
    ],
    "ip_addrs": [
        "34.211.11.0/24"
    ]
}

状态代码： 200

已创建客服人员退出作业

此示例演示了如何请求客服人员退出以及创建的相应作业。

请求

标头：

键 值 说明
Content-Type application/json

正文：

{
    "agent_ids": [
        11,
        12
    ],
    "team_ids": [
        1
    ],
    "ip_addrs": [
        "34.211.11.0/24"
    ]
}
响应
{
    "ip_addrs": [
        "34.211.11.0/16"
    ]
}

状态代码： 200

正在通话或聊天的客服人员稍后会退出

此示例演示了正在通话或聊天的客服人员会在聊天或通话结束后稍后退出。

请求

标头：

键 值 说明
Content-Type application/json

正文：

{
    "agent_ids": [
        11,
        12
    ],
    "team_ids": []
}
响应
[
    {
        "agent_id": 11,
        "name": "Darth Vader",
        "email": "notanakinskywalker@empire.com",
        "agent_number": "Agent No.111",
        "previous_status": "In-call",
        "current_status": "In-call",
        "message": "will force logout as soon as the ongoing call/chat is completed"
    },
    {
        "agent_id": 12,
        "name": "Craig T",
        "email": "craigT@nelson.com",
        "agent_number": "Agent No.112",
        "previous_status": "In-chat",
        "current_status": "In-chat",
        "message": "will force logout as soon as the ongoing call/chat is completed"
    }
]

状态代码： 400

错误：找不到客服人员

此示例演示了找不到提供的客服人员时的失败场景。

请求

标头：

键 值 说明
Content-Type application/json

正文：

{
    "ip_addrs": [
        "34.211.11.0/24"
    ]
}
响应：错误：找不到任何与输入参数匹配的客服人员
{
    "message": "cannot find any agent by input params"
}

状态代码： 400

强制客服人员退出作业

借助此端点，您可以获取客服人员的强制退出请求的状态。

{
    "identifier": "string",
    "email": "string",
    "name": "string",
    "phone": "string"
}

端点：

Method: GET
Type: 
URL: https://{subdomain}.{domain}/apps/api/v1/agent_statuses/force_logout/jobs/:id

标头：

键 值 说明
id 已提交的强制退出请求的作业 ID。

请求和响应示例

以下部分提供了针对该端点的请求示例。

已成功完成

此示例演示了如何检索已成功完成的作业。

请求

标头：

键 值 说明
Content-Type application/json

查询：

Method: GET
Type: 
URL: https://{subdomain}.{domain}/apps/api/v1/agent_statuses/force_logout/jobs/105
响应
{
    "id": 105,
    "status": "completed"
}

状态代码： 200