Gunakan GetChatappPhoneNumberMetric untuk kueri metrik pengiriman pesan untuk nomor telepon-Chat App Message Service-Alibaba Cloud - Chat App Message Service

Mengkueri data deret waktu pengiriman Paket untuk nomor telepon di saluran WhatsApp.

Deskripsi operasi

You can call this operation to query message sending metrics. Alternatively, you can query the metrics in the ChatApp console by choosing Channel Management > Manage > Daily Statistics Reports for Customers.
Before you call this operation, call the EnableWhatsAppROIMetric operation to enable return on investment (ROI) metric collection for WhatsApp. Statistics are available at least one day after you enable this feature. Message sending metrics generated before you enable the feature are not collected.
After you enable ROI metric collection for WhatsApp, make sure that messages are successfully sent from your channel. To send messages, go to the Channel Management page, select a WhatsApp channel, and choose Message Sending. You can also call SendChatappMessage or SendChatappMassMessage.

QPS limit

This operation allows a maximum of 50 requests per second per account. Excess requests are throttled, which may affect your business. Stay within the specified limit.

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:GetChatappPhoneNumberMetric

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
IsvCode	string	No	Kode verifikasi independent software vendor (ISV) yang digunakan untuk memverifikasi apakah pengguna diotorisasi oleh ISV.	skdi3kksloslikd****
CustSpaceId	string	No	ID Space atau ID instans sub-pelanggan ISV. Ini adalah ID saluran. Lihat ID saluran di Konsol Channel Management.	cams-************
Granularity	string	No	Granularitas data deret waktu. Nilai valid: DAILY: Data deret waktu dikumpulkan per hari. HALF_HOUR: Data deret waktu dikumpulkan setiap setengah jam.	DAILY
Start	integer	Yes	Awal rentang pengatur waktu untuk kueri. Ini adalah stempel waktu UNIX dalam milidetik.	1756742399000
End	integer	Yes	Akhir rentang pengatur waktu untuk kueri. Ini adalah stempel waktu UNIX dalam milidetik.	1758902399000
PhoneNumber	string	No	Nomor telepon bisnis. Ini adalah nomor telepon yang digunakan untuk mengirim Paket. Anda dapat melihat Tampilan nomor telepon di Konsol ChatApp dengan memilih Channel Management > Manage > WABA Management > Phone Number Management.	861380000****

Elemen respons

Element	Type	Description	Example
	object	The returned data.
AccessDeniedDetail	string	Details about the access denial.	None
RequestId	string	The request ID.	608F9CCA-B5EB-3D72-8047-B25D6D75BDEC
Message	string	The error message.	None
Data	array<object>	The returned data.
	object	The returned data.
DeliveredCount	integer	The number of delivered messages.	5
Start	integer	The start time of metric collection. This is a UNIX timestamp in milliseconds.	1669619491000
PhoneNumber	string	The business phone number.	861380000****
End	integer	The end time of metric collection. This is a UNIX timestamp in milliseconds.	1667196043904
Granularity	string	The granularity of the metrics.	DAILY
SentCount	integer	The number of sent messages.	10
Code	string	The status code of the request. Valid values: OK: The request was successful. For other error codes, see Error codes.	OK

Contoh

Respons sukses

JSONformat

{
  "RequestId": "608F9CCA-B5EB-3D72-8047-B25D6D75BDEC\n",
  "Code": "OK",
  "Message": "None",
  "Data": [
    {
      "SentCount": 10,
      "DeliveredCount": 5,
      "Start": 1669619491000,
      "End": 1667196043904,
      "PhoneNumber": "861380000****",
      "Granularity": "DAILY"
    }
  ],
  "AccessDeniedDetail": "None"
}

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.