Kueri metrik template pemasaran menggunakan GetChatappTemplateMetric-Chat App Message Service-Alibaba Cloud - Chat App Message Service

Mengkueri data deret waktu untuk templat pemasaran.

Deskripsi operasi

This API queries metrics only for marketing templates of WhatsApp channels.
Before you call this operation, call EnableWhatsAppROIMetric to enable metric statistics for WhatsApp Return on Investment (ROI). It takes at least one day for the data to become available after you enable this feature. Metrics are not collected for marketing templates that were used before this feature was enabled.
After you enable metric statistics for WhatsApp ROI, ensure that messages have been sent using the marketing templates of your channels. 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 limits

This API is limited to 50 queries per second (QPS) for each user. If you exceed this limit, API calls are throttled, which can affect your business. Call this API 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:GetChatappTemplateMetric

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
TemplateCode	string	Yes	Kode templat. Lihat kode templat di halaman Manajemen Saluran > Kelola > Desain Templat.	1100***************
Language	string	No	Bahasa templat. Untuk informasi selengkapnya, lihat Kode bahasa.	en
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 pelanggan bawahan ISV. Ini adalah ID saluran. Lihat ID saluran di halaman Manajemen Saluran.	cams-************
TemplateType	string	No	Jenis templat. Nilai valid: WHATSAPP Catatan Jika Anda tidak menentukan parameter ini, nilai default WHATSAPP akan digunakan.	WHATSAPP
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 waktu yang akan dikueri. Ini adalah stempel waktu UNIX. Unit: milidetik.	1693107714687
End	integer	Yes	Akhir rentang waktu yang akan dikueri. Ini adalah stempel waktu UNIX. Unit: milidetik.	1693407714687

Elemen respons

Element	Type	Description	Example
	object	The returned data.
AccessDeniedDetail	string	The 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 list of returned data.
	array<object>	The returned data.
TemplateCode	string	The template code.	1100***************
DeliveredCount	integer	The number of delivered messages.	6
Language	string	The language of the template.	en
Cliented	array<object>	The statistics about button clicks.
	object	The statistics about button clicks.
Type	string	The button type. Valid values: phone_number_button: The call button. url_button: The URL button. quick_reply_button: The auto-reply button.	quick_reply_button
ButtonContent	string	The button text.	reply
Count	integer	The number of clicks.	20
Start	integer	The start time for metric collection. This is a UNIX timestamp. Unit: milliseconds.	1673919240001
End	integer	The end time for metric collection. This is a UNIX timestamp. Unit: milliseconds.	1668138331485
SentCount	integer	The number of sent messages.	10
ReadCount	integer	The number of read messages.	3
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": [
    {
      "TemplateCode": "1100***************",
      "Language": "en",
      "SentCount": 10,
      "ReadCount": 3,
      "DeliveredCount": 6,
      "Cliented": [
        {
          "Type": "quick_reply_button",
          "ButtonContent": "reply",
          "Count": 20
        }
      ],
      "Start": 1673919240001,
      "End": 1668138331485
    }
  ],
  "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.