Endpoint agen

Endpoint agen menyediakan cara untuk mendapatkan objek agen. Setiap objek agen mewakili satu agen di dalam Contact Center AI Platform (CCAI Platform). Tinjau model berikut untuk melihat kolom mana yang mungkin berisi informasi identitas pribadi (PII).

[
  {
    "id": 0,
    "email": "string",
    "created_at": "2018-05-30T20:46:31.333Z",
    "last_login_time": "2018-05-30T20:46:31.333Z",
    "first_name": "string",
    "middle_name": "string",
    "last_name": "string",
    "avatar_url": "string",
    "agent_number": "string",
    "status": {
      "id": 0,
      "name": "string",
      "color": "string"
    },
    "status_updated_at": "2018-05-30T20:46:31.333Z",
    "crm_authenticated": true,
    "online": true,
    "wrap_up": true,
    "call_count": 0,
    "chat_count": 0,
    "location": "string",
    "roles": [
      "agent"
    ],
    "teams": [
      {
        "id": 0,
        "name": "string",
        "parent_id": 0,
        "position": 0,
        "deleted": true,
        "agents_count": 0
      }
    ],
    "channels": [
      {
        "channel_type": "chat",
        "menu": {
          "id": 0,
          "name": "string",
          "parent_id": 0,
          "position": 0,
          "deleted": true,
          "hidden": "string",
          "menu_type": "ivr_menu",
          "output_msg": "string"
        }
      }
    ]
  }
]

Agen

Parameter	Wajib	Jenis Data	Definisi
halaman	FALSE	String	Berpasangan dengan per untuk mencatat halaman catatan. Misalnya, jika per ditetapkan menjadi 200 dan halaman adalah 2, respons akan berisi catatan 201-400, karena halaman 1 akan berisi 1-200.
per	FALSE	String	Berpasangan dengan halaman untuk mencatat jumlah catatan yang akan disertakan dalam halaman catatan. Misalnya, jika per ditetapkan menjadi 200 dan halaman adalah 2, respons akan berisi catatan 201-400, karena halaman 1 akan berisi 1-200.
id[]	FALSE	Array[String]	Array[String]. ID catatan yang akan ditelusuri dan ditampilkan
agent_number[]	FALSE	Array[String]	Nomor agen seperti yang ditetapkan oleh administrator pada saat membuat agen
status_id[]	FALSE	Array[String]	Memfilter menurut status agen
online[]	FALSE	Boolean	Memfilter menurut apakah agen online atau tidak
wrap_up[]	FALSE	Boolean	Memfilter menurut apakah agen dalam status penyelesaian
location[]	FALSE	Array[String]	Memfilter menurut lokasi agen
last_login_time[from]	FALSE	Waktu dalam UTC	Membuat batas bawah kolom waktu login terakhir. Semua catatan yang ditampilkan akan berada setelah nilai yang dimasukkan.
last_login_time[to]	FALSE	Waktu dalam UTC	Membuat batas atas kolom waktu login terakhir. Semua catatan yang ditampilkan akan berada sebelum nilai yang dimasukkan.
status_updated_at[from]	FALSE	Waktu dalam UTC	Membuat batas bawah kolom status yang diperbarui pada. Semua catatan yang ditampilkan akan berada setelah nilai yang dimasukkan.
status_updated_at[to]	FALSE	Waktu dalam UTC	Membuat batas atas kolom status yang diperbarui pada. Semua catatan yang ditampilkan akan berada sebelum nilai yang dimasukkan.

Endpoint:

Method: GET
Type: 
URL: https://{​{subdomain}​}.{​{domain}​}/manager/api/v1/agents

Contoh Permintaan/Respons lainnya:

Contoh permintaan: Contoh agen

Isi: Tidak ada

Contoh respons: Contoh agen

[
  {
    "id": 45,
    "email": "[e-mail]",
    "roles": [
      "agent"
    ],
    "first_name": "Craig T",
    "middle_name": null,
    "last_name": "Nelson",
    "avatar_url": "https://subdomain.somedomain.com/default-profile.png",
    "agent_number": null,
    "crm_authenticated": false,
    "status": {
      "id": -6,
      "name": "Wrap-up",
      "color": "purple",
    },
    "online": false,
    "wrap_up": false,
    "call_count": 0,
    "chat_count": 0,
    "location": null,
    "created_at": "2016-11-10T00:15:04.000Z",
    "last_login_time": "2016-11-10T00:17:57.000Z",
    "status_updated_at": null,
    "teams": [
      {
        "id": 163,
        "name": "team CTN",
        "parent_id": null,
        "position": 11,
        "agents_count": 12,
        "deleted": false
      }
    ],
    "channels": [
      {
        "channel_type": "voice_call",
        "menu": {
          "id": 2029,
          "name": "Mobile Queue",
          "parent_id": null,
          "position": 0,
          "deleted": false,
          "menu_type": "mobile_menu",
          "output_msg": null,
          "hidden": false
        }
      }
    ]
  },
  {
    "id": 60,
    "email": "[e-mail]",
    "roles": [
      "agent"
    ],
    "first_name": "Darth",
    "middle_name": null,
    "last_name": "Vader",
    "avatar_url": "https://subdomain.somedomain.com/default-profile.png",
    "agent_number": null,
    "crm_authenticated": false,
    "status": {
      "id": -7,
      "name": "In-call",
      "color": "light_blue",
    },
    "online": false,
    "wrap_up": false,
    "call_count": 0,
    "chat_count": 0,
    "location": null,
    "created_at": "2017-02-03T19:44:14.000Z",
    "last_login_time": "2017-02-03T20:05:31.000Z",
    "status_updated_at": "2017-02-04T12:36:11.000Z",
    "teams": [],
    "channels": [
      {
        "channel_type": "voice_call",
        "menu": {
          "id": 1693,
          "name": "Premium Support",
          "parent_id": null,
          "position": 0,
          "deleted": false,
          "menu_type": "ivr_menu",
          "output_msg": "You selected premium support",
          "hidden": false
        }
      }
    ]
  },
  {
    "id": 81,
    "email": "[e-mail]",
    "roles": [
      "agent"
    ],
    "first_name": "Barry",
    "middle_name": null,
    "last_name": "Allen",
    "avatar_url": "https://subdomain.somedomain.com/default-profile.png",
    "agent_number": null,
    "crm_authenticated": false,
    "status": {
      "id": -10,
      "name": "Offline",
      "color": "grey",
    },
    "online": false,
    "wrap_up": false,
    "call_count": 0,
    "chat_count": 0,
    "location": null,
    "created_at": "2017-03-13T23:47:39.000Z",
    "last_login_time": "2017-03-13T23:48:17.000Z",
    "status_updated_at": "2017-03-13T23:56:04.000Z",
    "teams": [],
    "channels": [
      {
        "channel_type": "voice_call",
        "menu": {
          "id": 2028,
          "name": "Speed Issues",
          "parent_id": 2027,
          "position": 0,
          "deleted": false,
          "menu_type": "mobile_menu",
          "output_msg": null,
          "hidden": false
        }
      }
    ]
  }
]

Kode Status: 200

Status agen saat ini

Status Agen Saat Ini menampilkan semua agen yang login dan status mereka saat ini, berapa lama mereka berada dalam status tersebut, dan informasi tambahan untuk menunjukkan apakah agen sedang dalam status tunggu dan berapa lama.

Endpoint:

Method: GET
Type: 
URL: https://{​{subdomain}​}.{​{domain}​}/manager/api/v1/agents/current_status

Contoh Permintaan/Respons lainnya:

Contoh Permintaan: Status Agen Saat Ini

Isi: Tidak ada

Contoh Respons: Status Agen Saat Ini

[
  {
    "id": 1,
    "status": "Available",
    "status_id": 0,
    "status_updated_at": "2021-05-10T17:45:01.000Z",
    "on_hold": false,
    "on_hold_duration": 0
  }
]

Kode Status: 0

Mengharapkan kunci JSON yang tidak dikenal dalam respons API

Semua update API kompatibel dengan versi sebelumnya. Kami berhak memperkenalkan kunci JSON baru dalam respons API yang ada kapan saja. Sebaiknya tangani respons secara defensif dengan mengabaikan kunci yang tidak dikenal untuk mempertahankan fungsi yang berkelanjutan.