API ve webhook'lar
Teknik ekipler için WADOG API anahtarları, mesaj gönderme ve WhatsApp kontrolü uç noktaları, numara webhook'ları ve olay türleri.
4 dk okuma
WADOG, kendi yazılımınızdan veya Zapier/Make gibi araçlardan WhatsApp mesajı göndermeniz için basit bir API ve numaralarınızdaki olayları dış sistemlere bildiren webhook'lar sunar. Bu makale web sitesi, randevu yazılımı veya veri ekibi gibi teknik ekipler içindir. API anahtarlarını yalnızca alt hesap yöneticileri oluşturabilir.
API anahtarı oluşturma
- WADOG sol menüsünde Ayarlar & API'yi açın.
- API anahtarları kartında Anahtar oluştur'a tıklayın ve Anahtar adı girin (ör. "Web sitesi formu"; anahtarı nerede kullandığınızı hatırlamanız için).
- Kartın altındaki API adresi'ni kopyalayın; tüm istekler bu adrese yapılır.
Anahtar oluşturulunca bir pencerede gösterilir:
- Pencere üstündeki uyarıyı okuyun: anahtar yalnızca bir kez gösterilir.
- Anahtarı (
wdg_ile başlar) kopyalayıp güvenli bir yerde (parola yöneticisi) saklayın. - Kopyaladım, kapat'a tıklayın.
Listede her anahtarın ilk karakterleri, Son kullanım zamanı ve oluşturulma tarihi görünür. Bir anahtarı silmek için satırdaki çöp kutusu simgesine tıklayın; o anahtarı kullanan tüm entegrasyonlar anında durur ve işlem geri alınamaz.
Dikkat
API anahtarı, numaralarınızdan mesaj gönderme yetkisi verir. Anahtarı web sayfasının kaynak koduna, tarayıcıda çalışan JavaScript'e veya paylaşılan belgelere koymayın; yalnızca sunucu tarafında kullanın. Sızdığından şüphelenirseniz anahtarı silip yenisini oluşturun.
Kimlik doğrulama
Her isteğe şu başlığı ekleyin:
Authorization: Bearer wdg_...
Anahtar eksik veya geçersizse API 401 döner.
Mesaj gönderme
POST /v1/messages
curl -X POST https://API_ADRESINIZ/v1/messages \
-H "Authorization: Bearer wdg_..." \
-H "Content-Type: application/json" \
-d '{ "to": "+447700900123", "text": "{Hi|Hello}, your consultation is confirmed." }'
| Alan | Zorunlu | Açıklama |
|---|---|---|
to | Evet | Alıcı telefon, ülke koduyla (ör. +447700900123). |
text | text, mediaUrl veya template'ten biri | Mesaj metni. Spintax ({A|B}) ve kişi alanları ({{contact.first_name}}) desteklenir. |
mediaUrl | Görsel, video veya doküman bağlantısı; .mp3/.ogg ise sesli not olarak gider. | |
template | Mesaj oluşturucu'da kaydettiğiniz şablonun adı. | |
from | Hangi numaradan gideceği: numaranın panel adı veya telefonu. Boşsa yönlendirme kurallarına göre seçilir (önce hastayla konuşulan numara, sonra varsayılan numara). | |
record | false gönderirseniz mesaj Conversations'a yazılmaz. Varsayılan: kişi kayıtlıysa sohbetine yazılır. |
Yanıt: { "id": "…", "status": "queued" }. Mesaj hemen değil, numaranın toplu şeridine alınarak gönderilir (metin için 3–6, medya için 7–10 saniye bekleme). Sonucu WADOG'daki Mesaj Geçmişi'nden veya numara webhook'undan izleyin.
WhatsApp kontrolü ve numara listesi
POST /v1/check— gövde:{ "numbers": ["+905551112233", "..."], "from": "..." }. Numaraların WhatsApp kullanıp kullanmadığını döner. Tek istekte en fazla 50 numara.GET /v1/numbers— hesaptaki numaraları ad, telefon ve durumla listeler. Gövde gerekmez.
Önemli
/v1/check ile büyük listeleri taramak da WhatsApp'ın dikkatini çeken bir davranıştır. Yalnızca gerçekten mesaj göndereceğiniz kişileri ve makul aralıklarla kontrol edin. Bkz. Toplu gönderim ve numara güvenliği.
Numara webhook'ları
Bir numaradaki olayların (gelen mesaj, okundu, bağlantı kopması…) kendi sisteminize bildirilmesini istiyorsanız:
- Numaralar sayfasında numaranın kartındaki Ayarlar simgesine tıklayın.
- Webhook adresi (isteğe bağlı) alanına
https://ile başlayan adresinizi yazın. - Kaydet'e tıklayın.
O numaranın tüm olayları bu adrese JSON olarak POST edilir. Her istekte event, instance (numaranın iç adı) ve at (zaman) alanları bulunur; diğer alanlar olaya göre değişir:
event | Ne zaman? | Başlıca alanlar |
|---|---|---|
message_received | Numaraya mesaj geldi | contactId, phone, message, attachments, isNewContact, assignedTo |
message_sent | Mesaj WhatsApp'a gönderildi | contactId, phone, message |
message_delivered | Mesaj iletildi | contactId, phone |
message_read | Mesaj okundu | contactId, phone |
message_failed | Gönderim başarısız | contactId, phone, error |
button_reply | Hasta bir butona/liste satırına dokundu | selectedId, selectedText |
group_message | Aktarımı açık bir gruba mesaj yazıldı | groupName, sender, message |
call_received | WhatsApp araması geldi | phone, video |
number_connected | Numara bağlandı veya bağlantı geri geldi | — |
number_disconnected | Bağlantı koptu ve kısa sürede geri gelmedi | disconnectedAt |
Webhook'lar "en iyi çaba" ile gönderilir: adresiniz 10 saniye içinde başarılı (2xx) yanıt vermezse istek yeniden denenmez. Önemli olayları kaçırmamak için alıcı tarafınızı hızlı yanıt verecek şekilde kurun ve kritik kontrolleri ayrıca Mesaj Geçmişi'nden yapın.
Örnek: number_disconnected olayını kliniğin iç bildirim kanalına bağlarsanız, bir koordinatörün hattı koptuğunda ekip dakikalar içinde haberdar olur ve QR'ı yeniden okutur.
Otomasyon tetikleyicileri ve aksiyonları
WADOG olayları (mesaj geldi, butona yanıt verildi, numara koptu…) ve aksiyonları (WhatsApp mesajı gönder, şablon gönder, WhatsApp var mı kontrolü, gruba gönder) MedicalGrow otomasyonlarına da bağlanabilir. Otomasyon oluşturucu paketinize dahil değildir; ihtiyacınız olan akışı kurulumda ekibimiz yapılandırabilir. Destek ekibimize WhatsApp'tan yazın.
İlgili makaleler
Bu makale sorununuzu çözmedi mi?
Asistana sorun ya da destek ekibimize yazın.