Whatsbotg API Kılavuzu

Bu doküman, WhatsApp API'sinin sunduğu endpoint'leri (servis noktalarını) ve işlevlerini basit bir dille açıklamaktadır.

Uygulama (App)

Uygulamanın WhatsApp sunucularıyla olan temel bağlantı ve kimlik doğrulama işlemlerini yönetir.

GET /app/login

• Açıklama: WhatsApp sunucusuna giriş yapmak için kullanılır. Bu endpoint, telefonunuzdaki WhatsApp uygulamasıyla taramanız gereken bir QR kodu oluşturur.
• Parametreler: Yok.
• Örnek İstek:

  curl -X GET http://localhost:3000/app/login
  

GET /app/login-with-code

• Açıklama: Belirtilen telefon numarası için bir eşleştirme kodu oluşturarak giriş yapmanızı sağlar. QR koduna bir alternatiftir.
• Parametreler:
  • phone (query): Ülke koduyla birlikte telefon numaranız (Örn: 905xxxxxxxxx).
• Örnek İstek:

  curl -X GET "http://localhost:3000/app/login-with-code?phone=905xxxxxxxxx"
  

GET /app/logout

• Açıklama: Mevcut WhatsApp oturumunu sonlandırır ve ilgili veritabanı dosyalarını siler.
• Parametreler: Yok.
• Örnek İstek:

  curl -X GET http://localhost:3000/app/logout
  

GET /app/reconnect

• Açıklama: WhatsApp sunucusuyla kopan bağlantıyı yeniden kurmaya çalışır.
• Parametreler: Yok.
• Örnek İstek:

  curl -X GET http://localhost:3000/app/reconnect
  

GET /app/devices

• Açıklama: Hesabınıza bağlı olan tüm cihazların bir listesini getirir.
• Parametreler: Yok.
• Örnek İstek:

  curl -X GET http://localhost:3000/app/devices
  

Kullanıcı (User)

Kullanıcı bilgileri, profil ayarları ve kişi listesi gibi işlemleri yönetir.

GET /user/info

• Açıklama: Belirtilen telefon numarasına sahip bir kullanıcının herkese açık profil bilgilerini (isim, durum, profil fotoğrafı ID'si vb.) getirir.
• Parametreler:
  • phone (query): Bilgisi alınacak kullanıcının WhatsApp ID'si (Örn: 905xxxxxxxxx@s.whatsapp.net).
• Örnek İstek:

  curl -X GET "http://localhost:3000/user/info?phone=905xxxxxxxxx@s.whatsapp.net"
  

GET /user/avatar

• Açıklama: Bir kullanıcının profil fotoğrafını (avatar) getirir.
• Parametreler:
  • phone (query): Avatarı alınacak kullanıcının WhatsApp ID'si.
  • is_preview (query, opsiyonel): true ise fotoğrafın küçük bir önizlemesini getirir.
  • is_community (query, opsiyonel): true ise topluluk avatarını getirir.
• Örnek İstek:

  curl -X GET "http://localhost:3000/user/avatar?phone=905xxxxxxxxx@s.whatsapp.net&is_preview=true"
  

POST /user/avatar

• Açıklama: Kendi profil fotoğrafınızı değiştirir.
• Request Body:
  • avatar (form-data): Yüklenecek yeni profil fotoğrafı dosyası.
• Örnek İstek:

  curl -X POST http://localhost:3000/user/avatar \
      -H "Content-Type: multipart/form-data" \
      -F "avatar=@/path/to/your/image.jpg"
  

POST /user/pushname

• Açıklama: WhatsApp'ta başkalarına görünen isminizi (push name) günceller.
• Request Body:
  • push_name (json): Ayarlamak istediğiniz yeni isim.
• Örnek İstek:

  curl -X POST http://localhost:3000/user/pushname \
      -H "Content-Type: application/json" \
      -d '{"push_name": "Yeni Isim"}'
  

GET /user/my/privacy

• Açıklama: Kendi gizlilik ayarlarınızı (son görülme, profil fotoğrafı, durum vb.) getirir.
• Parametreler: Yok.
• Örnek İstek:

  curl -X GET http://localhost:3000/user/my/privacy
  

GET /user/my/groups

• Açıklama: Üyesi olduğunuz tüm grupların listesini getirir.
• Parametreler: Yok.
• Örnek İstek:

  curl -X GET http://localhost:3000/user/my/groups
  

GET /user/my/newsletters

• Açıklama: Takip ettiğiniz tüm haber bültenlerinin listesini getirir.
• Parametreler: Yok.
• Örnek İstek:

  curl -X GET http://localhost:3000/user/my/newsletters
  

GET /user/my/contacts

• Açıklama: Kayıtlı kişi listenizi getirir.
• Parametreler: Yok.
• Örnek İstek:

  curl -X GET http://localhost:3000/user/my/contacts
  

GET /user/check

• Açıklama: Belirtilen telefon numarasının bir WhatsApp hesabına sahip olup olmadığını kontrol eder.
• Parametreler:
  • phone (query): Kontrol edilecek telefon numarası.
• Örnek İstek:

  curl -X GET "http://localhost:3000/user/check?phone=905xxxxxxxxx"
  

Mesaj Gönderme (Send)

Farklı türlerde (metin, resim, video, dosya vb.) mesaj gönderme işlemlerini gerçekleştirir.

POST /send/message

• Açıklama: Metin mesajı gönderir.
• Request Body:
  • phone (json): Mesajın gönderileceği alıcının WhatsApp ID'si.
  • message (json): Gönderilecek metin içeriği.
  • reply_message_id (json, opsiyonel): Yanıtlamak istediğiniz mesajın ID'si.
  • is_forwarded (json, opsiyonel): Mesajın iletilmiş olarak işaretlenip işaretlenmeyeceği.
• Örnek İstek:

  curl -X POST http://localhost:3000/send/message \
      -H "Content-Type: application/json" \
      -d '{"phone": "905xxxxxxxxx@s.whatsapp.net","message": "Merhaba, bu bir test mesajıdır."}'
  

POST /send/image

• Açıklama: Resim mesajı gönderir. Resim, dosya olarak veya bir URL üzerinden gönderilebilir.
• Request Body:
  • phone (form-data): Alıcının WhatsApp ID'si.
  • caption (form-data, opsiyonel): Resim altı yazısı.
  • view_once (form-data, opsiyonel): true ise resim tek seferlik görüntülenir.
  • image (form-data): Gönderilecek resim dosyası.
  • image_url (form-data): Gönderilecek resmin URL'si.
  • compress (form-data, opsiyonel): true ise resim sıkıştırılır.
• Örnek İstek:

  curl -X POST http://localhost:3000/send/image \
      -H "Content-Type: multipart/form-data" \
      -F "phone=905xxxxxxxxx@s.whatsapp.net" \
      -F "caption=Resim altı yazısı" \
      -F "image=@/path/to/your/image.jpg"
  

POST /send/audio

• Açıklama: Ses dosyası (örn: OGG) gönderir.
• Request Body:
  • phone (form-data): Alıcının WhatsApp ID'si.
  • audio (form-data): Gönderilecek ses dosyası.
  • audio_url (form-data): Gönderilecek ses dosyasının URL'si.
• Örnek İstek:

  curl -X POST http://localhost:3000/send/audio \
      -H "Content-Type: multipart/form-data" \
      -F "phone=905xxxxxxxxx@s.whatsapp.net" \
      -F "audio=@/path/to/your/audio.ogg"
  

POST /send/file

• Açıklama: Belge veya dosya (PDF, DOCX vb.) gönderir.
• Request Body:
  • phone (form-data): Alıcının WhatsApp ID'si.
  • caption (form-data, opsiyonel): Dosya altı yazısı.
  • file (form-data): Gönderilecek dosya.
• Örnek İstek:

  curl -X POST http://localhost:3000/send/file \
      -H "Content-Type: multipart/form-data" \
      -F "phone=905xxxxxxxxx@s.whatsapp.net" \
      -F "caption=Dosya açıklaması" \
      -F "file=@/path/to/your/document.pdf"
  

POST /send/video

• Açıklama: Video mesajı gönderir.
• Request Body:
  • phone (form-data): Alıcının WhatsApp ID'si.
  • caption (form-data, opsiyonel): Video altı yazısı.
  • view_once (form-data, opsiyonel): true ise video tek seferlik görüntülenir.
  • video (form-data): Gönderilecek video dosyası.
  • video_url (form-data): Gönderilecek videonun URL'si.
• Örnek İstek:

  curl -X POST http://localhost:3000/send/video \
      -H "Content-Type: multipart/form-data" \
      -F "phone=905xxxxxxxxx@s.whatsapp.net" \
      -F "caption=Video açıklaması" \
      -F "video=@/path/to/your/video.mp4"
  

POST /send/contact

• Açıklama: Kişi kartı gönderir.
• Request Body:
  • phone (json): Alıcının WhatsApp ID'si.
  • contact_name (json): Gönderilecek kişinin adı.
  • contact_phone (json): Gönderilecek kişinin telefon numarası.
• Örnek İstek:

  curl -X POST http://localhost:3000/send/contact \
      -H "Content-Type: application/json" \
      -d '{"phone": "905xxxxxxxxx@s.whatsapp.net","contact_name": "Ahmet Yılmaz","contact_phone": "905xxxxxxxxx"}'
  

POST /send/link

• Açıklama: Tıklanabilir bir bağlantı (link) gönderir.
• Request Body:
  • phone (json): Alıcının WhatsApp ID'si.
  • link (json): Gönderilecek URL.
  • caption (json, opsiyonel): Bağlantı açıklaması.
• Örnek İstek:

  curl -X POST http://localhost:3000/send/link \
      -H "Content-Type: application/json" \
      -d '{"phone": "905xxxxxxxxx@s.whatsapp.net","link": "https://www.google.com","caption": "Google\'a bir göz atın!"}'
  

POST /send/location

• Açıklama: Konum bilgisi gönderir.
• Request Body:
  • phone (json): Alıcının WhatsApp ID'si.
  • latitude (json): Enlem koordinatı.
  • longitude (json): Boylam koordinatı.
• Örnek İstek:

  curl -X POST http://localhost:3000/send/location \
      -H "Content-Type: application/json" \
      -d '{"phone": "905xxxxxxxxx@s.whatsapp.net","latitude": "41.0082","longitude": "28.9784"}'
  

POST /send/poll

• Açıklama: Anket (oylama) gönderir.
• Request Body:
  • phone (json): Alıcının WhatsApp ID'si.
  • question (json): Anket sorusu.
  • options (json): Anket seçeneklerini içeren bir dizi (array).
  • max_answer (json): Verilebilecek maksimum cevap sayısı.
• Örnek İstek:

  curl -X POST http://localhost:3000/send/poll \
      -H "Content-Type: application/json" \
      -d '{"phone": "905xxxxxxxxx@s.whatsapp.net","question": "En sevdiğiniz renk hangisi?","options": ["Mavi", "Yeşil", "Kırmızı"],"max_answer": 1}'
  

POST /send/presence

• Açıklama: Varlık durumunuzu (çevrimiçi/çevrimdışı) ayarlar.
• Request Body:
  • type (json): Durum tipi (available veya unavailable).
• Örnek İstek:

  curl -X POST http://localhost:3000/send/presence \
      -H "Content-Type: application/json" \
      -d '{"type": "available"}'
  

Mesaj Yönetimi (Message)

Gönderilmiş mesajlar üzerinde işlem yapmayı sağlar (silme, düzenleme, tepki verme vb.).

POST /message/{message_id}/revoke

• Açıklama: Gönderdiğiniz bir mesajı herkesten siler (geri alır).
• Parametreler:
  • message_id (path): Silinecek mesajın ID'si.
• Request Body:
  • phone (json): Mesajın gönderildiği sohbetin ID'si.
• Örnek İstek:

  curl -X POST http://localhost:3000/message/MESSAGE_ID/revoke \
      -H "Content-Type: application/json" \
      -d '{"phone": "905xxxxxxxxx@s.whatsapp.net"}'
  

POST /message/{message_id}/delete

• Açıklama: Gönderdiğiniz bir mesajı sadece kendinizden siler.
• Parametreler:
  • message_id (path): Silinecek mesajın ID'si.
• Request Body:
  • phone (json): Mesajın gönderildiği sohbetin ID'si.
• Örnek İstek:

  curl -X POST http://localhost:3000/message/MESSAGE_ID/delete \
      -H "Content-Type: application/json" \
      -d '{"phone": "905xxxxxxxxx@s.whatsapp.net"}'
  

POST /message/{message_id}/reaction

• Açıklama: Bir mesaja emoji ile tepki verir.
• Parametreler:
  • message_id (path): Tepki verilecek mesajın ID'si.
• Request Body:
  • phone (json): Mesajın gönderildiği sohbetin ID'si.
  • emoji (json): Gönderilecek emoji.
• Örnek İstek:

  curl -X POST http://localhost:3000/message/MESSAGE_id/reaction \
      -H "Content-Type: application/json" \
      -d '{"phone": "905xxxxxxxxx@s.whatsapp.net","emoji": "👍"}'
  

POST /message/{message_id}/update

• Açıklama: Gönderildikten sonraki 15 dakika içinde bir metin mesajını düzenler.
• Parametreler:
  • message_id (path): Düzenlenecek mesajın ID'si.
• Request Body:
  • phone (json): Mesajın gönderildiği sohbetin ID'si.
  • message (json): Mesajın yeni metni.
• Örnek İstek:

  curl -X POST http://localhost:3000/message/MESSAGE_ID/update \
      -H "Content-Type: application/json" \
      -d '{"phone": "905xxxxxxxxx@s.whatsapp.net","message": "Düzenlenmiş mesaj içeriği."}'
  

POST /message/{message_id}/read

• Açıklama: Bir mesajı okundu olarak işaretler.
• Parametreler:
  • message_id (path): Okundu olarak işaretlenecek mesajın ID'si.
• Request Body:
  • phone (json): Mesajın gönderildiği sohbetin ID'si.
• Örnek İstek:

  curl -X POST http://localhost:3000/message/MESSAGE_ID/read \
      -H "Content-Type: application/json" \
      -d '{"phone": "905xxxxxxxxx@s.whatsapp.net"}'
  

POST /message/{message_id}/star

• Açıklama: Bir mesajı yıldızlar.
• Parametreler:
  • message_id (path): Yıldızlanacak mesajın ID'si.
• Request Body:
  • phone (json): Mesajın gönderildiği sohbetin ID'si.
• Örnek İstek:

  curl -X POST http://localhost:3000/message/MESSAGE_ID/star \
      -H "Content-Type: application/json" \
      -d '{"phone": "905xxxxxxxxx@s.whatsapp.net"}'
  

POST /message/{message_id}/unstar

• Açıklama: Bir mesajın yıldızını kaldırır.
• Parametreler:
  • message_id (path): Yıldızı kaldırılacak mesajın ID'si.
• Request Body:
  • phone (json): Mesajın gönderildiği sohbetin ID'si.
• Örnek İstek:

  curl -X POST http://localhost:3000/message/MESSAGE_ID/unstar \
      -H "Content-Type: application/json" \
      -d '{"phone": "905xxxxxxxxx@s.whatsapp.net"}'
  

Grup (Group)

WhatsApp gruplarını yönetmek için kullanılır (grup oluşturma, üye ekleme/çıkarma vb.).

POST /group

• Açıklama: Yeni bir grup oluşturur ve başlangıç üyelerini ekler.
• Request Body:
  • title (json): Grubun başlığı.
  • participants (json): Gruba eklenecek üyelerin telefon numaralarını içeren dizi.
• Örnek İstek:

  curl -X POST http://localhost:3000/group \
      -H "Content-Type: application/json" \
      -d '{"title": "Yeni Grup","participants": ["905xxxxxxxxx", "905yyyyyyyyy"]}'
  

POST /group/participants

• Açıklama: Mevcut bir gruba yeni üyeler ekler.
• Request Body:
  • group_id (json): İşlem yapılacak grubun ID'si.
  • participants (json): Eklenecek üyelerin telefon numaraları.
• Örnek İstek:

  curl -X POST http://localhost:3000/group/participants \
      -H "Content-Type: application/json" \
      -d '{"group_id": "GROUP_ID@g.us","participants": ["905zzzzzzzzz"]}'
  

POST /group/participants/remove

• Açıklama: Bir gruptan üyeleri çıkarır.
• Request Body:
  • group_id (json): İşlem yapılacak grubun ID'si.
  • participants (json): Çıkarılacak üyelerin telefon numaraları.
• Örnek İstek:

  curl -X POST http://localhost:3000/group/participants/remove \
      -H "Content-Type: application/json" \
      -d '{"group_id": "GROUP_ID@g.us","participants": ["905zzzzzzzzz"]}'
  

POST /group/participants/promote

• Açıklama: Bir grup üyesini yönetici yapar.
• Parametreler:
  • group_id (json): İşlem yapılacak grubun ID'si.
  • participants (json): Yönetici yapılacak üyelerin telefon numaraları.
• Örnek İstek:

  curl -X POST http://localhost:3000/group/participants/promote \
      -H "Content-Type: application/json" \
      -d '{"group_id": "GROUP_ID@g.us","participants": ["905yyyyyyyyy"]}'
  

POST /group/participants/demote

• Açıklama: Bir grup yöneticisini normal üyeye düşürür.
• Request Body:
  • group_id (json): İşlem yapılacak grubun ID'si.
  • participants (json): Yetkisi alınacak yöneticilerin telefon numaraları.
• Örnek İstek:

  curl -X POST http://localhost:3000/group/participants/demote \
      -H "Content-Type: application/json" \
      -d '{"group_id": "GROUP_ID@g.us","participants": ["905yyyyyyyyy"]}'
  

POST /group/join-with-link

• Açıklama: Bir davet bağlantısı kullanarak gruba katılır.
• Request Body:
  • link (json): Katılınacak grubun davet bağlantısı.
• Örnek İstek:

  curl -X POST http://localhost:3000/group/join-with-link \
      -H "Content-Type: application/json" \
      -d '{"link": "https://chat.whatsapp.com/INVITE_LINK"}'
  

GET /group/participant-requests

• Açıklama: Bir gruba katılma isteği gönderenlerin listesini getirir.
• Parametreler:
  • group_id (query): İstekleri listelenecek grubun ID'si.
• Örnek İstek:

  curl -X GET "http://localhost:3000/group/participant-requests?group_id=GROUP_ID@g.us"
  

POST /group/participant-requests/approve

• Açıklama: Gruba katılma isteklerini onaylar.
• Request Body:
  • group_id (json): İşlem yapılacak grubun ID'si.
  • participants (json): Katılma isteği onaylanacak kişilerin ID'leri.
• Örnek İstek:

  curl -X POST http://localhost:3000/group/participant-requests/approve \
      -H "Content-Type: application/json" \
      -d '{"group_id": "GROUP_ID@g.us","participants": ["905zzzzzzzzz"]}'
  

POST /group/participant-requests/reject

• Açıklama: Gruba katılma isteklerini reddeder.
• Request Body:
  • group_id (json): İşlem yapılacak grubun ID'si.
  • participants (json): Katılma isteği reddedilecek kişilerin ID'leri.
• Örnek İstek:

  curl -X POST http://localhost:3000/group/participant-requests/reject \
      -H "Content-Type: application/json" \
      -d '{"group_id": "GROUP_ID@g.us","participants": ["905zzzzzzzzz"]}'
  

POST /group/leave

• Açıklama: Belirtilen gruptan ayrılır.
• Request Body:
  • group_id (json): Ayrılınacak grubun ID'si.
• Örnek İstek:

  curl -X POST http://localhost:3000/group/leave \
      -H "Content-Type: application/json" \
      -d '{"group_id": "GROUP_ID@g.us"}'
  

Haber Bülteni (Newsletter)

Haber bültenlerini yönetmek için kullanılır.

POST /newsletter/unfollow

• Açıklama: Belirtilen haber bültenini takipten çıkar.
• Request Body:
  • newsletter_id (json): Takipten çıkılacak haber bülteninin ID'si.
• Örnek İstek:

  curl -X POST http://localhost:3000/newsletter/unfollow \
      -H "Content-Type: application/json" \
      -d '{"newsletter_id": "NEWSLETTER_ID@newsletter"}'