Kontak: pencarian
Hitung kontak
Hitung kontak yang cocok dengan where, tanpa mengambilnya. Gunakan untuk menampilkan "1.834 orang akan menerima ini" sebelum pengiriman.
https://g.sendcorex.com/v1/contactscommand: count_contactsMembutuhkan scope contact:read pada API key Anda.
Argumen
whereobjectopsionalwhereyang sama dengan Query Contacts. Kosongkan untuk menghitung semua kontak.maxnumberopsionalBerhenti menghitung di angka ini, dari 1 sampai 1.000.000. Default 100.000.
Mulai cepat
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1/contacts',
{
commands: [
{
command: "count_contacts",
args: {
where: {
list: "customers",
sendable: true
}
}
}
]
},
{ headers: { Authorization: process.env.SENDCOREX_API_KEY } },
);
const [result] = response.data.results;
if (result.type !== 'SUCCESS') throw new Error(`${result.code}: ${result.message}`);
console.log(result.data);Respons
{
"type": "SUCCESS",
"results": [
{
"command": "count_contacts",
"id": "0",
"type": "SUCCESS",
"took_ms": 14,
"data": {
"count": 1790,
"exact": true
}
}
]
}Field respons
countJumlah kontak yang cocok.
exactfalsejika penghitungan berhenti lebih awal, dimaxatau di batas waktu request. Jumlah sebenarnya minimalcount.
Total tanpa menghitung
Untuk total per status, list, atau tag, Get Stats lebih murah: membaca penghitung yang diperbarui setiap ada perubahan, bukan menelusuri kontak.
Error
Error di level HTTP mengembalikan type, code, dan message. Error yang ditandai CMD dikembalikan di dalam hasil perintah, dengan HTTP 200.
- 401
INVALID_API_KEYAPI key tidak ada, sudah dicabut, atau dinonaktifkan di dashboard.
- 429
RATE_LIMITEDLebih dari 15 request/detik atau 15 bersamaan untuk IP + API key yang sama. Tunggu sesuai jumlah detik di Retry-After.
- CMD
MISSING_SCOPEAPI key tidak memiliki scope yang dibutuhkan perintah ini. Perintah lain dalam request tetap berjalan.
- CMD
INVALID_ARGSArgumen wajib tidak ada atau tidak valid: email, nilai field, opsi enum, key where, id list…
- CMD
INTERNALError server. Detailnya hanya ditulis ke log server.