Endpoint status agen

Endpoint API status agen memberikan akses ke objek status agen. Objek agen dibuat untuk setiap pengguna yang dikonfigurasi di Contact Center AI Platform (CCAI Platform) yang memiliki peran termasuk izin agen.

Berikut adalah endpoint API status agen:

Endpoint status agen memungkinkan Anda mengubah status agen. Status ini memungkinkan perubahan dari Tersedia ke status kustom apa pun. Transisi ke dan dari status yang ditentukan sistem seperti Dalam Panggilan akan memicu error. Selain itu, endpoint ini mendukung update massal, sehingga memungkinkan modifikasi status secara bersamaan untuk seluruh tim atau grup agen yang dipilih.

Memperbarui status agen

Endpoint ini memungkinkan Anda memperbarui status agen. Tabel berikut menampilkan properti dalam isi JSON:

Properti Wajib Jenis Data Definisi
status TRUE String Status yang akan ditetapkan untuk agen, misalnya tersedia.
agent_ids TRUE Arry Integer ARRAY ID agen.
team_ids TRUE Array Bilangan Bulat ARRAY ID tim.

Endpoint:

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

Header:

Kunci Nilai Deskripsi
Content-Type application/json

Isi:

{
    "status": "Available",
    "agent_ids": [
        11,
        12
    ],
    "team_ids": []
}

Contoh permintaan dan respons

Bagian berikut memberikan contoh permintaan ke endpoint.

Berhasil mengubah status agen

Contoh berikut menunjukkan permintaan dan respons terkait untuk mengubah status beberapa agen saat tindakan berhasil.

Permintaan

Header:

Kunci Nilai Deskripsi
Content-Type application/json

Isi:

{
    "status": "Available",
    "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": "Available"
    },
    {
        "agent_id": 12,
        "name": "Craig T",
        "email": "craigT@nelson.com",
        "agent_number": "Agent No.112",
        "previous_status": "In-call",
        "current_status": "In-call",
        "message": "Agent can't be changed from system status 'In-call'"
    },
    {
        "agent_id": 13,
        "name": "Raymond D",
        "email": "rayd@nelson.com",
        "agent_number": "Agent No.113",
        "previous_status": "Offline",
        "current_status": "Offline",
        "message": "Agent's status can't be changed if they are offline or logged out"
    }
]

Kode Status: 200

Status tidak ada

Contoh ini menunjukkan permintaan dan respons terkait saat status yang diberikan tidak ada dan oleh karena itu dianggap tidak valid.

Permintaan

Header:

Kunci Nilai Deskripsi
Content-Type application/json

Isi:

Body
{
    "status": "Napping",
    "agent_ids": [
        11,
        12
    ],
    "team_ids": []
}
Respons: Error: status 'Napping' tidak ada
{
    "message": "status 'Napping' does not exist"
}

Kode Status: 400

Status ditetapkan ke status sistem

Contoh ini menunjukkan permintaan dan respons saat status ditetapkan ke status sistem, dalam hal ini "in-call". Anda tidak dapat menetapkan status agen ke status yang dikelola oleh sistem.

Permintaan

Header:

Kunci Nilai Deskripsi
Content-Type application/json

Isi:

Body
{
    "status": "In-call",
    "agent_ids": [
        11,
        12
    ]
}
Respons: Error: Agen tidak dapat diubah ke status sistem 'Dalam panggilan
{
    "message": "Agent can't be changed to system status 'In-call'"
}

Kode Status: 400

Mendapatkan status agen

Endpoint ini memungkinkan Anda mengambil status agen. Tabel berikut menampilkan properti dalam isi JSON:

Properti Wajib Jenis Data Definisi
status TRUE String Status yang akan ditetapkan untuk agen, misalnya tersedia.
agent_ids FALSE Arry Integer ARRAY ID agen.
team_ids FALSE Array Bilangan Bulat ARRAY ID tim.

Endpoint:

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

Header:

Kunci Nilai Deskripsi
Content-Type application/json

Isi:

{
    "agent_ids": [
        11,
        12
    ],
    "team_ids": [
        1
    ]
}

Contoh permintaan dan respons

Bagian berikut memberikan contoh permintaan ke endpoint.

Mendapatkan status agen dan tim tertentu

Contoh ini menunjukkan cara mendapatkan status agen dengan ID 11 dan 12 serta agen mana pun dalam tim dengan ID 1.

Permintaan

Header:

Kunci Nilai Deskripsi
Content-Type application/json

Isi:

{
    "agent_ids": [
        11,
        12
    ],
    "team_ids": [
        1
    ]
}
Respons: Status agen yang diminta
[
    {
        "agent_id": 11,
        "name": "Darth Vader",
        "email": "notanakinskywalker@empire.com",
        "agent_number": "Agent No.111",
        "status": "lunch",
        "ip_addrs": [
            "34.211.11.101"
        ]
    },
    {
        "agent_id": 12,
        "name": "Craig T",
        "email": "craigT@nelson.com",
        "agent_number": "Agent No.112",
        "status": "In-call",
        "ip_addrs": [
            "34.211.11.102"
        ]
    },
    {
        "agent_id": 13,
        "name": "Raymond D",
        "email": "rayd@nelson.com",
        "agent_number": "Agent No.113",
        "status": "Offline",
        "ip_addrs": [
            "34.211.11.103"
        ]
    }
]

Kode Status: 200