에이전트 로그아웃 엔드포인트 강제 적용

상담사 강제 로그아웃 엔드포인트를 사용하면 온라인 상담사를 강제로 로그아웃할 수 있습니다. 활성 통화 또는 채팅에 참여하는 상담사는 현재 상호작용을 완료하면 자동으로 로그아웃됩니다. 유휴 상담사는 즉시 로그아웃됩니다. 이 엔드포인트는 특정 상담사, 전체 팀 또는 CIDR 표기법이 있는 IP 주소, 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