این بخش شامل مستندات و توضیحات مربوط به نسخه بتای وب‌هوک ریل‌تایم (بلادرنگ) است. لطفاً پیش از استفاده، نکات و محدودیت‌ها را به دقت مطالعه کنید. این نسخه دارای ساختاری متفاوت از سرویس اصلی است و به‌صورت محدود تنها به کاربرانی ارائه میشود که از طریق تیکت درخواست داده‌اند. توجه داشته باشید که این نسخه بدون لاگ در پنل ارائه میشود و با فعال‌سازی آن، چت‌بات غیرفعال خواهد شد.
وب‌هوک ارسال/ دریافت پیام (Webhook Type)
توضیحات فیلدها:
این پارامتر ها ثابت هستند و در همه رکوردهای وب هوک ارسال میشوند.
- senderNumber
- نوع داده : string
- توضیح: شماره فرستنده پیام / شناسه گروه
مثال: “989309981814“ - مقدار ممکن:
- شماره فرستنده پیام: پیام از شخص ارسال شده باشد شماره فرد درج میشود.
- شناسه گروه : پیام در یک گروه باشد، شناسه منحصربه‌فرد گروه درج میشود.
- deviceNumber
- نوع داده : string
- توضیح: شماره دستگاهی که با آن به واتس اپ متصل شده اید.
- uniqueId
- نوع داده : string
- توضیح: شناسه منحصربه‌فرد پیام برای ردیابی و جلوگیری از پردازش مجدد.
- webhookType
- نوع داده : string
- توضیح: نوع رویداد وب‌هوک.
- مقدار ممکن:
- Sent: پیام ارسال شده.
- Received : پیام دریافت شده.
- isGroup
- نوع داده : boolean
- توضیح: مشخص می‌کند که پیام در یک گروه ارسال شده است یا خیر.
- مقدار ممکن:
- true : پیام در گروه ارسال شده.
- false : پیام در یک کاربر ارسال شده.
- timestamp
- نوع داده : number
- توضیح: زمان ارسال پیام به‌صورت Unix Timestamp
- مثال: 1735075818
فیلد data:
این فیلد شامل اطلاعات مربوط به محتوای پیام است. و پارامترهای آن ثابت نیستند و بسته به نوع فایل ممکن است ارسال نشوند.
پیام متنی:
- message
- نوع داده : string
- توضیح: متن پیام دریافتی.
- مثال “Hello world”
- message
پیام حاوی فایل:
- mimeType
- نوع داده : string
- توضیح: نوع فایل ارسال‌شده (MIME Type).
- مثال “image/png”
- messageType
- نوع داده : string
- توضیح: نوع پیام ارسال‌شده. در اینجا “documentWithCaptionMessage” نشان‌دهنده ارسال فایل با کپشن است.
- caption
- نوع داده : string
- توضیح: متن همراه با فایل ارسال‌شده.
- fileLength
- نوع داده : number
- توضیح: اندازه فایل به بایت.
- مثال: 4491
- base64Data
- نوع داده : string
- توضیح: داده فایل به‌صورت Base64 کدگذاری شده.
- نکته: این فیلد شامل محتوای اصلی فایل است و می‌توان آن را برای ذخیره یا نمایش، به فرمت اصلی تبدیل کرد.
- mimeType
نکات مهم:
- برای دریافت و پردازش داده‌های base64Data می‌توانید آن را از حالت Base64 خارج کرده و به فایل واقعی تبدیل کنید.
- زمان در فیلد timestamp باید بر اساس Timezone مربوطه تفسیر شود.
وب‌هوک وضعیت پیام (Message Status)
توضیحات فیلدها:
این وب‌هوک زمانی فعال میشود که وضعیت پیام تغییر کند، مانند زمانی که پیام توسط گیرنده خوانده شود.
- senderNumber
- نوع داده : string
- توضیح: شماره فرستنده پیام (فرمت E.164).
- مثال: “989125027728”
- deviceNumber
- نوع داده : string
- توضیح: شماره دستگاهی که پیام را دریافت کرده است.
- uniqueId
- نوع داده : string
- توضیح: برای شناسایی و پیگیری اون پیام هست.
به این حالت که شما از Api پیامی ارسال میکنید و uniqueId اون رو دریافت میکنید.
بعد میتونید در وب هوک اون پیام رو به وسیله uniqueId جستجو کنید و وضعیت پیام رو (ارسال شده، دریافت شده، خوانده شده) بررسی کنید.
- isGroup
- نوع داده : boolean
- توضیح: مشخص می‌کند که پیام از یک گروه دریافت شده است یا خیر.
- مقدار ممکن:
- true : پیام در گروه ارسال شده.
- false : پیام در یک کاربر ارسال شده.
- status
- نوع داده : string
- توضیح: وضعیت پیام.
- مقدار ممکن:
- “ERROR” : پیام به دلیل یک خطا ارسال نشده است.
- “PENDING” : پیام در صف ارسال است و هنوز به سرور واتساپ ارسال نشده است.
- “SERVER_ACK”: پیام با موفقیت به سرور واتساپ ارسال شده است و توسط سرور تأیید دریافت شده است.
- “DELIVERY_ACK” : پیام به گیرنده تحویل داده شده است (به دستگاه گیرنده رسیده است).
- “READ” : پیام توسط گیرنده خوانده شده است.
