Standarisasi respons kesalahan (pratinjau)

Penting

• Ini adalah fitur pratinjau siap produksi.
• Pratinjau siap produksi tunduk pada persyaratan penggunaan tambahan.

[Artikel ini adalah dokumentasi prarilis dan dapat berubah.]

Respons kesalahan harus distandarisasi untuk memastikan bahwa pesan kesalahan konsisten dan mudah dipahami. Tabel berikut mencantumkan skema untuk objek kesalahan yang diharapkan dalam isi respons.

Nama	Tipe data	Wajib	Deskripsi
Kode kesalahan	string	Ya	Kategori kesalahan yang singkat dan mudah diidentifikasi.
Pesan kesalahan	string	Tidak.	Pesan yang ramah pengembang untuk detail selengkapnya tentang error.
activityId	string	Tidak.	Pengidentifikasi unik untuk permintaan.
detail	Objek	Tidak.	Detail selengkapnya tentang kesalahan. Konten mungkin berbeda, tergantung pada jenis kesalahan. Contoh berikut menunjukkan kasus di mana pengguna tidak memiliki hak istimewa yang benar. { "resourceType": "amplop", "resourceId": "envelopeId<>" }

Tabel berikut mencantumkan beberapa skenario dan kode kesalahan yang diharapkan.

Skenario	Kode kesalahan	Kode Status HTTP
Sistem manajemen hubungan pelanggan (CRM) yang terhubung dengan pengguna berbeda dari yang ditentukan dalam input.	INVALID_CRM_CONNECTION	400
Sistem catatan CRM tidak ditemukan, atau dihapus.	RECORD_NOT_FOUND	404
Pengguna tidak diautentikasi. (Skenario ini biasanya terjadi ketika token kedaluwarsa.)	INVALID_TOKEN_SPECIFIED	401
Pengguna tidak berwenang untuk melakukan tindakan. (Dengan kata lain, pengguna tidak memiliki hak istimewa yang memadai).	IZIN_TIDAK_MEMADAI	403
Terlalu banyak permintaan yang dikirim ke konektor.	REQUEST_THROTTLED	429
Terjadi kesalahan layanan yang tidak tertangani.	INTERNAL_SERVER_ERROR	500

Informasi terkait

Perpanjang# Microsoft 365 Copilot untuk Penjualan dengan aplikasi mitra
Membuat ekstensi Copilot untuk Penjualan