强制客服人员退出端点

通过强制客服人员退出端点，您可以强制在线客服人员退出。当正在进行通话或聊天的客服人员完成当前互动后，系统会自动将其退出登录。系统会立即将处于空闲状态的客服人员退出登录。此端点支持强制退出特定客服人员、整个团队或通过 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