API referansı
Contacts
Kişi listeleme, detay, güncelleme, silme, WhatsApp numara kontrolü ve toplu senkron.
/contactsKişileri listele
Sayfalanmış kişi listesi döndürür. Arama, etiket ve WhatsApp kullanıcı durumuna göre filtrelenebilir.
Gerekli yetki: chats:read
Sorgu parametreleri
page | integer | Varsayılan: 1 |
limit | integer | Varsayılan: 50 |
search | string | İsim veya telefonda arama. |
tags | string | Virgülle ayrılmış etiket adları. |
is_whatsapp_user | boolean | |
sort_by | string | Varsayılan: last_message_at |
sort_order | string | Değerler: asc, descVarsayılan: desc |
İstek örneği
curl -X GET "https://api.zenwapp.com/api/v1/whatsapp/external/contacts" \
-H "Authorization: Bearer $ZENWAPP_API_KEY"Yanıt 200
{
"success": true,
"data": [
{
"phone": "905551234567",
"name": "Ahmet Yılmaz",
"tags": [
"bayi"
],
"is_whatsapp_user": true
}
],
"pagination": {
"page": 1,
"limit": 50,
"total": 128
}
}Yanıt kodları
200Kişi listesi
/contacts/{phone}Kişi detayı
Telefon numarasına göre kişi kaydını döndürür.
Gerekli yetki: chats:read
Yol parametreleri
phonezorunlu | string | Ülke kodlu telefon numarası. |
İstek örneği
curl -X GET "https://api.zenwapp.com/api/v1/whatsapp/external/contacts/905551234567" \
-H "Authorization: Bearer $ZENWAPP_API_KEY"Yanıt 404
{
"error": "contact_not_found"
}Yanıt kodları
200Kişi detayı404Kişi bulunamadı
/contacts/{phone}Kişiyi güncelle
Kişinin adı, etiketleri, notu, özel alanları ve engel durumu güncellenir. Yalnızca gönderilen alanlar değişir.
Gerekli yetki: chats:read
Yol parametreleri
phonezorunlu | string | Ülke kodlu telefon numarası. |
Gövde alanları
name | string | |
tags | string[] | |
notes | string | |
custom_fields | object | |
is_blocked | boolean |
İstek örneği
curl -X PUT "https://api.zenwapp.com/api/v1/whatsapp/external/contacts/905551234567" \
-H "Authorization: Bearer $ZENWAPP_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"Ahmet Yılmaz","tags":["bayi","istanbul"]}'Yanıt kodları
200Güncellendi404Kişi bulunamadı
/contacts/{phone}Kişiyi sil
Kişi kaydını siler. Sohbet geçmişi silinmez.
Gerekli yetki: chats:read
Yol parametreleri
phonezorunlu | string | Ülke kodlu telefon numarası. |
İstek örneği
curl -X DELETE "https://api.zenwapp.com/api/v1/whatsapp/external/contacts/905551234567" \
-H "Authorization: Bearer $ZENWAPP_API_KEY"Yanıt kodları
200Silindi404Kişi bulunamadı
/contacts/{phone}/checkNumara WhatsApp'ta mı?
Numaranın WhatsApp'ta kayıtlı olup olmadığını canlı olarak sorgular. Hesabın bağlı (connected) olması gerekir.
Gerekli yetki: chats:read
Yol parametreleri
phonezorunlu | string | Ülke kodlu telefon numarası. |
İstek örneği
curl -X GET "https://api.zenwapp.com/api/v1/whatsapp/external/contacts/905551234567/check" \
-H "Authorization: Bearer $ZENWAPP_API_KEY"Yanıt 200
{
"success": true,
"phone": "905551234567",
"is_whatsapp_user": true
}Yanıt kodları
200Kontrol sonucu400Hesap bağlı değil
/contacts/syncToplu kişi senkronu
Numara listesini toplu olarak kontrol eder ve kişi kayıtlarını oluşturur/günceller. Tek çağrıda gönderilebilecek numara sayısı sınırlıdır; aşımda `too_many_phones` döner.
Gerekli yetki: chats:read
Gövde alanları
phoneszorunlu | string[] | |
update_existing | boolean | Varsayılan: true |
İstek örneği
curl -X POST "https://api.zenwapp.com/api/v1/whatsapp/external/contacts/sync" \
-H "Authorization: Bearer $ZENWAPP_API_KEY" \
-H "Content-Type: application/json" \
-d '{"phones":["905551234567","905339876543"],"update_existing":true}'Yanıt kodları
200Senkron sonucu400Geçersiz istek veya numara limiti aşıldı