استرجاع معلومات الجلسة
معرفة حالة الاتصال، الرقم المتصل، ونسبة البطارية.
تسجيل الدخول مطلوب
سجل الدخول لاستبدال المعرفات (Instance ID) ورمز الوصول (Access Token) بمعلومات حسابك الحقيقي لاختبار ال API مباشرة.
تسجيل الدخوللا توجد معاملات استعلام مطلوبة
هذه النهاية الطرفية لا تتوقع بيانات في الرابط.
توصيات
Poll this endpoint every 3-5 seconds while waiting for the user to scan the QR code.
Stop polling once the status becomes 'WORKING'.
Use this endpoint to build a 'System Status' page in your application dashboard.
The Pulse of the Engine: Decoding the Session Info Endpoint
The /v2/session/info endpoint is the most critical monitoring tool in your Wawp toolkit. It serves as the "Heartbeat" of your instance, providing real-time data on connection health, authentication state, and identity metadata. Mastering this endpoint is the key to building responsive, self-healing applications.
🔍 The Anatomy of a Status Response
The status field in the response is the primary director for your front-end logic. Understanding each state is essential:
1. WORKING (Active)
✅ The engine is fully connected to WhatsApp's servers and authenticated.
- Developer Action: You are clear to send messages, fetch contacts, or update profile settings. No restrictions apply.
2. SCAN_QR_CODE (Authentication Pending)
⚠️ The engine is running but lacks valid credentials.
- Developer Action: This is the only time the
qrfield in the response will contain a Base64 string. Display this QR code to the user immediately. - Pro Tip: QR codes expire rapidly (approx. 20-40 seconds). You must refresh your UI whenever a new QR string is returned by this endpoint.
3. STARTING (Warming Up)
⏳ The dedicated engine is booting and preparing the secure bridge.
- Developer Action: Show a "Connecting..." spinner. Prevent the user from attempting to send messages until the state transitions.
4. STOPPED (Hibernating)
🛑 The instance is dormant. No system resources are being consumed.
- Developer Action: Call the
/v2/session/startendpoint to wake the engine.
🏗️ Monitoring Architecture: Best Practices
The "Intelligent Polling" Strategy
Polling is efficient if done correctly. We recommend the following orchestration for user-facing dashboards:
- Initial Check: When the user opens their dashboard, call
/session/info. - The QR Loop: If the status is
SCAN_QR_CODE, poll every 3-5 seconds. This ensures the QR code on the screen is always "fresh" and detects the successful scan the moment it happens. - The Stop Condition: Once the status transitions to
WORKING, stop polling immediately to save network overhead and battery life on mobile clients.
Leveraging the "Me" Object
When a session is WORKING, the me object provides essential identity metadata:
- pushName: Use this to welcome the user (e.g., "Welcome back, Sarah!").
- platform: Understand if the user is connected via a specific OS, which can help in tailoring support if they report sync issues.
🛡️ Reliability and Health Monitoring
Building a "Health Check" Cron
For mission-critical bots, run a background task every 15 minutes that calls /session/info.
- Auto-Recovery: If a session that should be active returns
STOPPEDorFAILED, your system should automatically trigger astartorrestartcall. - Alerting: If a session transitions to
SCAN_QR_CODEunexpectedly, it means the user has logged out from their phone. Send them a push notification or email to re-link their account.
Troubleshooting Guide
Why is the QR field empty?
The qr field is context-aware. It will only contain data when the status is explicitly SCAN_QR_CODE. In any other state (like STARTING or WORKING), the field will be null or omitted because a handshake is either not ready or no longer needed.
Latency in Status Updates
While our engine is near real-time, there can be a 1-3 second delay as the WhatsApp handshake completes. If a session is stuck in STARTING for more than 60 seconds, it indicates a transient network failure. We recommend calling the /v2/session/restart endpoint to clear the state.
Summary of Capabilities:
- Verify message-sending readiness.
- Retrieve the latest QR or Pairing Code.
- Identify the phone number and name of the connected account.
- Monitor server-side resource allocation and engine health.
البارامترات
قم بتهيئة المعاملات المطلوبة للتفاعل مع نقطة النهاية هذه. جميع وسائط الاستعلام والبيانات مدرجة أدناه مع تفاصيلها.
محتوى الطلب
يرسل كـ JSONstring | The 12-character ID of the instance to check مثال: | ||
string | Your API Access Token مثال: |
برمج بالذكاء الاصطناعي باستخدام Wawp MCP
MCP READYقم بربط الـ API مباشرة مع Cursor أو Windsurf أو Claude Desktop، ودع الذكاء الاصطناعي يكتب لك كود الربط وينفذه تلقائياً!
أمثلة الكود
استخدم أمثلة الكود الجاهزة لدمج واجهة برمجة التطبيقات (API) في مشروعك بسرعة وكفاءة. اختر لغة البرمجة والمكتبة التي تفضلها.
الردود المتوقعة
استكشف كافة الردود والنتائج المحتملة من الخادم. قمنا بتوثيق كل كود حالة (Status Code) مع أمثلة للبيانات لتسهيل معالجة الأخطاء والنجاح.
Example
{
"name": "wawp-84729105",
"status": "WORKING",
"config": {
"webhooks": {
},
"proxy": null
},
"me": {
"id": "201012345678@c.us",
"pushName": "John Doe"
}
}Command Palette
Search for a command to run...