DescribeContacts - Application Real-Time Monitoring Service

Mengkueri daftar kontak peringatan.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Parameter permintaan

Parameter	Type	Required	Description	Example
ContactName	string	No	Nama kontak peringatan.	John Doe
Phone	string	No	Nomor ponsel kontak peringatan.	1381111*****
Email	string	No	Alamat email kontak peringatan.	someone@example.com
Page	integer	Yes	Nomor halaman yang akan dikembalikan.	1
Size	integer	Yes	Jumlah kontak yang akan dikembalikan pada setiap halaman.	20
ContactIds	string	No	ID kontak yang akan dikueri. Pisahkan beberapa ID kontak dengan spasi.	123,321
Verbose	string	No	Apakah akan mengembalikan informasi redundan.	true
RegionId	string	No	ID wilayah.	cn-hangzhou

Elemen respons

Element	Type	Description	Example
	object	Skema Respons.
RequestId	string	ID permintaan.	21E85B16-75A6-429A-9F65-8AAC9A54****
PageBean	object	Objek paginasi.
Total	integer	Jumlah total kontak yang dikembalikan.	1
Page	integer	Nomor halaman yang dikembalikan.	1
Size	integer	Jumlah kontak pada setiap halaman.	20
AlertContacts	array<object>	Daftar kontak peringatan.
	object
ContactId	number	The ID of the alert contact.	123
ContactName	string	The name of the alert contact.	John Doe
Phone	string	The mobile number of the alert contact.	1381111****
Email	string	The email address of the alert contact.	someone@example.com
IsVerify	boolean	Indicates whether the mobile number was verified. Valid values: `false`: no `true`: yes	false
ReissueSendNotice	integer	The operation that you want to perform if phone calls fail to be answered. Valid values: 0: No operation is performed. 1: A phone call is made again. 2: A text message is sent. 3 (default value): The global default value is used.	3
IsEmailVerify	boolean	Indicates whether the email address was verified.	true
ArmsContactId	integer	The ID of the alert contact.	100147

Contoh

Respons sukses

JSONformat

{
  "RequestId": "21E85B16-75A6-429A-9F65-8AAC9A54****",
  "PageBean": {
    "Total": 1,
    "Page": 1,
    "Size": 20,
    "AlertContacts": [
      {
        "ContactId": 123,
        "ContactName": "John Doe",
        "Phone": "1381111****",
        "Email": "someone@example.com",
        "IsVerify": false,
        "ReissueSendNotice": 3,
        "IsEmailVerify": true,
        "ArmsContactId": 100147
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.