Periksa Status Verifikasi Nomor Telepon WhatsApp melalui API - Layanan Pesan Aplikasi Obrolan

Deskripsi operasi

Anda dapat memanggil API ini untuk mengambil status verifikasi nomor telepon. Status tersebut juga dapat dilihat pada halaman Channel Management > Manage > WABA Management > Phone Number Management.
Sebelum memanggil API ini, tambahkan nomor telepon ke WhatsApp Business Account (WABA) Anda dan kirimkan untuk verifikasi.
Jika nomor telepon belum ditambahkan ke WABA, panggil API GetChatappVerifyCode dan ChatappVerifyAndRegister untuk mendapatkan kode verifikasi dan mendaftarkan nomor tersebut.

API ini dibatasi hingga 10 permintaan per detik (QPS) per pengguna. Jika batas ini dilampaui, pemanggilan API akan dikenai pengendalian aliran (throttled), yang dapat memengaruhi bisnis Anda. Pastikan Anda memanggil API ini dalam batas yang ditentukan.

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

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

cams:GetPhoneNumberVerificationStatus

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
PhoneNumber	string	Yes	Nomor telepon. Anda dapat melihat nomor telepon tersebut pada halaman Channel Management > Manage > WABA Management > Phone Number Management.	86138009****
CustSpaceId	string	Yes	Space ID pelanggan sub-ISV (Independent Software Vendor) atau ID instans pelanggan langsung. Anda dapat melihat Space ID pada halaman Channel Management.	cams-kei****

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
RequestId	string	ID permintaan.	90E63D28-E31D-1EB2-8939-A94866411B2D
Code	string	Kode status permintaan. Nilai OK menunjukkan bahwa permintaan berhasil. Untuk kode kesalahan lainnya, lihat Error codes.	OK
Message	string	Pesan kesalahan.	None
Data	object	Data yang dikembalikan.
PhoneNumber	string	Nomor telepon.	861390000****
Id	string	ID nomor telepon.	222434****
CodeVerificationStatus	string	Status verifikasi. Valid values: REVOKED : Permintaan verifikasi telah dicabut. MORE_INFORMATION_REQUESTED : Diperlukan informasi tambahan. VERIFIED : Nomor telepon telah diverifikasi. REJECTED : Verifikasi ditolak.	VERIFIED

Contoh

Respons sukses

JSONformat

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2D",
  "Code": "OK",
  "Message": "None",
  "Data": {
    "PhoneNumber": "861390000****",
    "Id": "222434****",
    "CodeVerificationStatus": "VERIFIED"
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	Product.Unsubscript	You have not subscribed to the specified product.
400	Ram.PermissionDeny	You are not authorized to perform the operation.
400	System.LimitControl	The system is under flow control.
400	Unknown.ResourceOwnerId	The resource does not belong to the current user.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.