وثائق API - نظام إدارة واتساب

واجهة برمجة التطبيقات (API) لنظام إدارة رسائل واتساب تتيح لك التكامل مع أنظمة خارجية وإرسال الرسائل وإدارة جهات الاتصال برمجياً.

المصادقة والأمان

جميع طلبات API تتطلب مفتاح API صالح. يمكنك تمرير المفتاح بإحدى الطرق التالية:

Header

X-API-Key: your-api-key

Query Parameter

?api_key=your-api-key

Body Parameter

{
  "api_key": "your-api-key"
}
                            

تحديد المعدل: الحد الأقصى 100 طلب كل 15 دقيقة لكل مفتاح API.

نقاط النهاية المتاحة

POST /api/send-message

إرسال رسالة واحدة لرقم محدد

المعاملات المطلوبة:

{
  "number": "966501234567",
  "message": "مرحباً من API",
  "session_id": "default" // اختياري
}
                                

مثال cURL:

curl -X POST http://localhost:5000/api/send-message \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your-api-key" \
  -d '{
    "number": "966501234567",
    "message": "مرحباً من API"
  }'
                                

POST /api/send-bulk

إرسال رسائل متعددة لقائمة من الأرقام

المعاملات المطلوبة:

{
  "numbers": ["966501234567", "966509876543"],
  "message": "رسالة جماعية",
  "delay": 1000,
  "session_id": "default"
}
                                

GET /api/messages

جلب سجل الرسائل المرسلة

معاملات الاستعلام:

session_id - معرف الجلسة
number - رقم الهاتف
date_from - من تاريخ
date_to - إلى تاريخ
limit - عدد النتائج

GET /api/sessions

جلب قائمة جميع الجلسات النشطة

POST /api/sessions

إنشاء جلسة واتساب جديدة

المعاملات:

{
  "session_id": "my-session"
}
                                

GET /api/sessions/:sessionId/status

جلب حالة جلسة محددة

DELETE /api/sessions/:sessionId

حذف جلسة محددة

GET /api/contacts

جلب قائمة جهات الاتصال

معاملات الاستعلام:

group - تصفية حسب المجموعة
search - البحث في الأسماء والأرقام
limit - عدد النتائج

POST /api/contacts

إضافة جهة اتصال جديدة

المعاملات المطلوبة:

{
  "name": "أحمد محمد",
  "number": "966501234567",
  "group": "العملاء",
  "notes": "ملاحظات",
  "email": "ahmed@example.com",
  "company": "الشركة"
}
                                

PUT /api/contacts/:id

تحديث جهة اتصال موجودة

DELETE /api/contacts/:id

حذف جهة اتصال

GET /api/templates

جلب قائمة القوالب المحفوظة

POST /api/templates

إنشاء قالب رسالة جديد

المعاملات المطلوبة:

{
  "name": "رسالة ترحيب",
  "content": "مرحباً {NAME}، شكراً لك على التواصل معنا!",
  "category": "ترحيب"
}
                                

PUT /api/templates/:id

تحديث قالب موجود

DELETE /api/templates/:id

حذف قالب

GET /api/stats

جلب إحصائيات شاملة للنظام

البيانات المُرجعة:

إجمالي جهات الاتصال
إجمالي المجموعات
إجمالي الرسائل المرسلة
إحصائيات المجموعات
إحصائيات الرسائل اليومية

GET /api/info

معلومات عامة عن API

أمثلة برمجية

JavaScript (Node.js)

const axios = require('axios');

const sendMessage = async () => {
  try {
    const response = await axios.post(
      'http://localhost:5000/api/send-message',
      {
        number: '966501234567',
        message: 'مرحباً من Node.js!'
      },
      {
        headers: {
          'X-API-Key': 'your-api-key',
          'Content-Type': 'application/json'
        }
      }
    );
    
    console.log('تم الإرسال:', response.data);
  } catch (error) {
    console.error('خطأ:', error.response.data);
  }
};
                            

Python

import requests

def send_message():
    url = 'http://localhost:5000/api/send-message'
    headers = {
        'X-API-Key': 'your-api-key',
        'Content-Type': 'application/json'
    }
    data = {
        'number': '966501234567',
        'message': 'مرحباً من Python!'
    }
    
    response = requests.post(url, json=data, headers=headers)
    
    if response.status_code == 200:
        print('تم الإرسال:', response.json())
    else:
        print('خطأ:', response.json())

send_message()
                            

PHP

<?php
$url = 'http://localhost:5000/api/send-message';
$data = [
    'number' => '966501234567',
    'message' => 'مرحباً من PHP!'
];

$options = [
    'http' => [
        'header' => [
            'Content-Type: application/json',
            'X-API-Key: your-api-key'
        ],
        'method' => 'POST',
        'content' => json_encode($data)
    ]
];

$context = stream_context_create($options);
$result = file_get_contents($url, false, $context);

echo $result;
?>
                            

cURL

# إرسال رسالة واحدة
curl -X POST http://localhost:5000/api/send-message \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your-api-key" \
  -d '{
    "number": "966501234567",
    "message": "مرحباً من cURL!"
  }'

# جلب الجلسات
curl -X GET http://localhost:5000/api/sessions \
  -H "X-API-Key: your-api-key"

# جلب جهات الاتصال
curl -X GET "http://localhost:5000/api/contacts?limit=10" \
  -H "X-API-Key: your-api-key"
                            

رموز الاستجابة

رموز النجاح

200 - نجح الطلب نجاح
201 - تم الإنشاء بنجاح إنشاء

رموز الخطأ

400 - خطأ في الطلب خطأ
401 - غير مصرح أمان
404 - غير موجود عدم وجود
429 - تجاوز الحد حد المعدل
500 - خطأ خادم خادم

اختبار API

نصيحة: يمكنك اختبار API مباشرة باستخدام أدوات مثل Postman أو Insomnia أو حتى متصفح الويب لطلبات GET.

الحصول على معلومات API

اختبر الآن

الحصول على الجلسات

اختبر الآن

الدعم والمساعدة

وثائق إضافية

راجع وثائق النظام الكاملة للحصول على معلومات تفصيلية.

الإبلاغ عن الأخطاء

إذا واجهت أي مشاكل، يرجى التواصل مع فريق الدعم.

أمثلة إضافية

تفقد مستودع GitHub للحصول على أمثلة برمجية إضافية.