Endpoint logout paksa agen

Endpoint agen logout paksa memungkinkan Anda logout paksa agen online. Agen yang terlibat dalam panggilan atau chat aktif akan otomatis logout saat mereka menyelesaikan interaksi saat ini. Agen yang tidak aktif akan langsung logout. Endpoint ini mendukung logout paksa agen tertentu, seluruh tim, atau agen yang diidentifikasi berdasarkan alamat IP dengan notasi CIDR, daftar alamat IPv4/IPv6, atau rentang IP. Untuk sejumlah besar agen, tugas latar belakang dibuat untuk mengelola proses logout secara efisien.

Berikut adalah endpoint API logout paksa agen:

Memaksa agen keluar

Endpoint ini memberikan kemampuan untuk logout agen tertentu. Agen dapat diidentifikasi berdasarkan hal berikut:

  • ID agen.

  • ID tim.

  • alamat IP eksternal.

Endpoint:

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

Header:

Kunci Nilai Deskripsi
Content-Type application/json
Terima application/json

Isi:

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

Contoh permintaan dan respons

Bagian berikut memberikan contoh permintaan ke endpoint.

Berhasil mengeluarkan agen

Contoh ini menunjukkan cara logout agen tertentu berdasarkan ID agen dan ID tim. Dalam hal ini, ID agennya adalah 11 dan 12, serta ID timnya adalah 1.

Permintaan

Header:

Kunci Nilai Deskripsi
Content-Type application/json

Isi:

{
    "agent_ids": [
        11,
        12
    ],
    "team_ids": [
        1
    ]
}
Respons
[
    {
        "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"
    }
]

Kode Status: 200

Berhasil mengeluarkan agen menggunakan alamat IP

Contoh ini menunjukkan cara mengeluarkan agen dengan menentukan rentang alamat IP. Dalam hal ini, rentang alamat IP yang diberikan adalah 34.211.11.0/24.

Permintaan

Header:

Kunci Nilai Deskripsi
Content-Type application/json

Isi:

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

Kode Status: 200

Tugas agen logout dibuat

Contoh ini menunjukkan cara meminta logout agen dan tugas yang dihasilkan yang dibuat.

Permintaan

Header:

Kunci Nilai Deskripsi
Content-Type application/json

Isi:

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

Kode Status: 200

Agen dalam panggilan atau dalam chat akan logout nanti

Contoh ini menunjukkan cara agen yang sedang dalam panggilan atau dalam chat akan logout nanti, setelah chat atau panggilan berakhir.

Permintaan

Header:

Kunci Nilai Deskripsi
Content-Type application/json

Isi:

{
    "agent_ids": [
        11,
        12
    ],
    "team_ids": []
}
Respons
[
    {
        "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"
    }
]

Kode Status: 400

Error: tidak dapat menemukan agen

Contoh ini menunjukkan skenario kegagalan saat agen yang diberikan tidak dapat ditemukan.

Permintaan

Header:

Kunci Nilai Deskripsi
Content-Type application/json

Isi:

{
    "ip_addrs": [
        "34.211.11.0/24"
    ]
}
Respons: Error : tidak dapat menemukan agen dengan parameter input
{
    "message": "cannot find any agent by input params"
}

Kode Status: 400

Memaksa tugas logout agen

Endpoint ini memungkinkan Anda mendapatkan status permintaan logout paksa untuk agen.

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

Endpoint:

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

Header:

Kunci Nilai Deskripsi
id ID tugas permintaan logout paksa yang dikirimkan.

Contoh permintaan dan respons

Bagian berikut memberikan contoh permintaan ke endpoint.

Berhasil diselesaikan

Contoh ini menunjukkan cara mengambil tugas yang telah berhasil diselesaikan.

Permintaan

Header:

Kunci Nilai Deskripsi
Content-Type application/json

Kueri:

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

Kode Status: 200