API pengelolaan pengguna massal

Bulk User Management API memungkinkan Anda menggunakan konten file json untuk membuat atau mengubah beberapa pengguna dalam satu operasi.

Tidak ada batasan jumlah data yang dapat diupload, tetapi sebaiknya permintaan dilakukan dalam batch yang lebih kecil.

Proses ini juga dapat dilakukan di portal Platform CCAI dengan mengikuti petunjuk di Pengelolaan pengguna secara massal.

Aplikasi referensi Bulk User Sync Tool disediakan untuk melakukan sinkronisasi pengguna antara direktori seperti grup Google Workspace atau Microsoft Entra ID dengan CCaaS. Aplikasi referensi ini memanfaatkan Bulk User Management API.

Peran dan izin

  • Gunakan Apps API dengan membuat api_user.

  • api_user tidak memiliki peran dan izin, sehingga semua api_user dapat melakukan bulk_user management.

  • Anda tidak dapat menetapkan izin terperinci saat menggunakan api_user, sehingga api_user akan memiliki akses ke semua kolom pengguna.

Menambahkan kredensial API

  1. Di portal Platform CCAI, buka Settings > Developer Settings > API Credential management.

  2. Klik + Tambahkan Kredensial API. Pesan Tambahkan Kredensial API akan terbuka.

  3. Masukkan Nama untuk kredensial.

  4. Klik Create.

Menggunakan API pengelolaan pengguna massal

Penggunaan API pengelolaan pengguna massal memerlukan dua panggilan API. Satu orang mengupload file JSON dan membuat tugas, dan orang lain memprosesnya. Anda juga dapat menggunakan panggilan API opsional untuk membantu memastikan bahwa tugas Anda diproses dengan benar.

  1. Opsional: Ambil template json. Tindakan ini akan mengambil template terbaru, yang mencakup peran atau tim tambahan yang dibuat sejak Anda mengambil template sebelumnya. Google merekomendasikan langkah ini.

  2. Opsional: Dapatkan data konfigurasi pengguna. Tindakan ini akan mengambil daftar semua pengguna (atau satu pengguna, jika Anda menentukan alamat email) untuk dicerminkan.

  3. Upload file json. Anda dapat menambahkan atau memperbarui satu atau beberapa pengguna dalam file. Pastikan untuk mencatat ID tugas.

  4. Meminta pemrosesan file json. Tindakan ini akan memulai tugas massal.

  5. Opsional: Dapatkan pemeriksaan status. Berikan ID tugas untuk melihat status pemrosesan.

  6. Opsional: Ambil daftar tugas yang diperbarui. Tindakan ini akan mengambil daftar semua tugas pengelolaan pengguna massal.

  7. Opsional: Mengambil log error skema. Tentukan ID tugas untuk mendapatkan log error skema.

  8. Opsional: Ambil error. Mendapatkan error.

Upload file json

Penggunaan

Upload file json

URL

apps/api/v1/bulk/users/upload

Metode

POST / PUT

Permintaan

content-type: multipart/form-data

{
  "id" : {job_id} #optional. Required in case of PUT method.
  "file": {json file}
}

Respons

Header:

Link: http://ujet.co/apps/api/v1/bulk/users_jobs/12345

Isi

{
  "id": 12345, # job_id
  "status": "created"
  "link": "http://ujet.co/apps/api/v1/bulk/users_jobs/12345"
}

Mengambil template json

Penggunaan

Template

URL

apps/api/v1/bulk/users/template

Metode

DAPATKAN

Permintaan

(Kosong)

Respons

 
[
{
"email":"user1@yourcompany.co",
"new_email":user1@yourcompany.cx",
"agent_number":"A-001",
"first_name":"John",
"last_name":"aa",
"status":"Active",
"location":"Mexico",
"max_chat_limit":2,
"max_chat_limit_enabled":0,
"roles": [
{"name":"Admin","value": 0 },
{"name":"Manager","value": 1 },
{"name":"Agent","value": 0 },
{"name":Developer","value": 1 }
]
},
 ...
]

Menonaktifkan pengguna

Untuk menonaktifkan pengguna, ubah nilai status menjadi Inactive—misalnya, "status":"Inactive".

Meminta pemrosesan file json saat ini

Penggunaan

Meminta pemrosesan file json saat ini

URL

/v1/bulk/users/proceed

Metode

POST

Permintaan

 
{
   "id": 12345  # job_id
}

Respons

Header:

Link: http://ujet.co/apps/api/v1/bulk/users_jobs/12345

Isi

1{"id": 12345 # job_id3 "status": "valid_scheme",4 "link": "http://ujet.co/apps/api/v1/bulk/users_jobs/12345"5}

Mendapatkan pemeriksaan status

Penggunaan

Mendapatkan pemeriksaan status

URL

apps/api/v1/bulk/users/jobs/#{job_id}

Metode

DAPATKAN

Permintaan

Variabel jalur - job_id

Respons

 
{
    "id": 12345,
    "created_at": "2022-01-07T06:40:34.000Z",
    "process_requested_at": "2022-01-07T06:45:34.000Z",
    "filename": "100row.json",
    "total_rows": 100,
    "affected_rows": 52,
    "failed_rows": 0,
    "status": "in_progress",
    "uploaded_user_name": null,
    "proceed_user_name": null,
    "uploaded_api_user_name": "api_user_name_1",
    "proceed_api_user_name": "api_user_name_2",
    "scheme_errors": []
    "update_errors": []
}

Mengambil daftar tugas yang diperbarui

Penggunaan

Mendapatkan daftar tugas update

URL

apps/api/v1/bulk/users/jobs

Metode

DAPATKAN

Permintaan

 
{
  "page": 1,
  "per_page": 20
}

Respons

Header

Link: <next link>
Total: 12345
Per-Page: 201

Isi

[
    {
        "id": 12345,
        "created_at": "2022-01-07T06:21:10.000Z",
        "process_requested_at": "2022-01-07T06:22:25.000Z",
        "filename": "100row.json",
        "total_rows": 100,
        "affected_rows": 52,
        "failed_rows": 0,
        "status": "in_progress",
        "uploaded_user_name": null,
        "proceed_user_name": null,
        "uploaded_api_user_name": "api_user_name_1",
        "proceed_api_user_name": "api_user_name_2",
        "scheme_errors": [],
        "update_errors": []
    },
    ...
]

Catatan

Output diurutkan dalam urutan terbalik job_id sehingga data terbaru ditampilkan terlebih dahulu.

Mengambil log error skema

Penggunaan

Mendapatkan log error skema

URL

/v1/bulk/users/errors/scheme/#{job_id}

Metode

DAPATKAN

Permintaan

Variabel jalur - job_id

Respons

content-type: application/json

[
  {
    "message": "Must be a valid email",
    "column": 1,
    "row": null
  },
  {
    "message": "Non-empty string",
    "column": 10,
    "row": 10
  }
]

Mengambil error

Penggunaan

Mendapatkan log error update

URL

/v1/bulk/users/errors/update/#{job_id}

Metode

DAPATKAN

Permintaan

Variabel jalur - job_id

Respons

content-type: application/json

1[2 {3 "message": "Must be a valid email",4 "column": 1,5 "row": null,6 "error_type": "warning"7 },8 {9 "message": "Non-empty string",10 "column": 10,11 "row": 10,12 "error_type": "error"13 } 14]