API referansı
Raporlar
Seçilen dönem için gönderim, teslim, okunma ve başarısızlık özetini numara kırılımıyla alın.
#ReportSummary nesnesi
periodstringDönem.Değerler:7d,30d,90dphone_number_idstring · boş olabilirSüzülen numara;nulltüm numaraların toplamıdır.sentintegerGönderilen mesaj (test hariç).deliveredintegerSon durumu teslim olan mesaj.readintegerOkunan mesaj.effective_deliveredintegerdelivered + read(okunan her mesaj teslim edilmiştir).failedintegerBaşarısız mesaj.delivery_ratenumbereffective_delivered / sentyüzdesi.read_ratenumberread / sentyüzdesi.failure_ratenumberfailed / sentyüzdesi.balanceintegerGüncel kredi bakiyesi.by_numberarraySüzgeç verilmediğinde numara başına aynı alanlar.
ReportSummary nesnesi
{
"ok": true,
"period": "30d",
"phone_number_id": null,
"sent": 8742,
"delivered": 2267,
"read": 6234,
"effective_delivered": 8501,
"failed": 241,
"delivery_rate": 97.2,
"read_rate": 71.3,
"failure_rate": 2.8,
"balance": 1258,
"by_number": [
{
"phone_number_id": "1234567890",
"display_phone_number": "+90 555 000 00 00",
"sent": 5120,
"delivered": 1170,
"read": 3810,
"effective_delivered": 4980,
"failed": 140,
"delivery_rate": 97.3,
"read_rate": 74.4,
"failure_rate": 2.7
}
]
}#Rapor özetini getir
GET
/reports/summaryGiden mesajların dönemsel özetini döndürür. Test anahtarıyla gönderilen mesajlar dahil edilmez. Kapsam:
reports:readSorgu parametreleri
periodstringisteğe bağlıDönem.Değerler:7d,30d,90dVarsayılan:30dphone_number_idstringisteğe bağlıYalnız bu numaranın özeti (by_numberboş döner).
Hatalar
| Durum | Kod | Ne zaman |
|---|---|---|
| 403 | insufficient_scope | Anahtarda reports:read kapsamı yok. |
| 404 | number_not_found | Numara size ait değil. |
| 422 | invalid_period | period yalnız 7d, 30d, 90d olabilir. |
curl -X GET "https://api.verimerkezi.app/wa/reports/summary?period=30d" \
-H "Authorization: Bearer $VM_API_KEY"const res = await fetch("https://api.verimerkezi.app/wa/reports/summary?period=30d", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.VM_API_KEY}`,
},
});
const data = await res.json();import os, requests
res = requests.get(
"https://api.verimerkezi.app/wa/reports/summary?period=30d",
headers={"Authorization": f"Bearer {os.environ['VM_API_KEY']}"},
)
data = res.json()<?php
$ch = curl_init("https://api.verimerkezi.app/wa/reports/summary?period=30d");
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("VM_API_KEY"),
],
]);
$data = json_decode(curl_exec($ch), true);Yanıt 200
{
"ok": true,
"period": "30d",
"phone_number_id": null,
"sent": 8742,
"delivered": 2267,
"read": 6234,
"effective_delivered": 8501,
"failed": 241,
"delivery_rate": 97.2,
"read_rate": 71.3,
"failure_rate": 2.8,
"balance": 1258,
"by_number": [
{
"phone_number_id": "1234567890",
"display_phone_number": "+90 555 000 00 00",
"sent": 5120,
"delivered": 1170,
"read": 3810,
"effective_delivered": 4980,
"failed": 140,
"delivery_rate": 97.3,
"read_rate": 74.4,
"failure_rate": 2.7
}
]
}