توثيق واجهة API · نيترو بوت

مقدمة

تتيح لك واجهة REST API إدارة جهات اتصال واتساب والقوائم والقوالب والحملات والردود التلقائية والرسائل برمجيًا.

الرابط الأساسي: https://bot.netrogrp.com/api/v1
نوع المحتوى: application/json

المصادقة

يجب أن يتضمن كل طلب رمز Bearer يُنشأ من الإعدادات ← رموز API داخل لوحة العميل. تقتصر رموز أعضاء الفريق على الوحدات المصرح لهم بها.

Authorization: Bearer YOUR_API_TOKEN

تقسيم الصفحات

تقبل نقاط نهاية القوائم معامل per_page (القيمة الافتراضية 25)، وتعيد كائنات data وlinks وmeta.

الأخطاء

الحالة	المعنى
401	رمز المصادقة مفقود أو غير صالح.
402	اشتراك الحساب غير موجود أو انتهت صلاحيته.
403	مستخدم الرمز لا يملك صلاحية الوصول إلى هذه الوحدة.
404	السجل غير موجود أو يتبع حسابًا آخر.
422	فشل التحقق؛ تحتوي الاستجابة على كائن errors مرتب حسب أسماء الحقول.

اتفاقية Webhook (reply_mode=webhook)

هنا ينعكس اتجاه الاتصال: بدلًا من أن يستدعي نظامك واجهتنا، نستدعي نظامك عند تطابق رسالة واتساب واردة مع رد تلقائي مضبوط على وضع Webhook. استخدمه للقرارات الديناميكية مثل التحقق من رمز أو سجل أو حالة مباشرة.

لإنشاء محادثة متعددة الخطوات استخدم منشئ التدفقات وعقدتي جمع المدخلات واستدعاء Webhook. يتضمن الطلب معرّف التدفق والعقدة والمتغيرات المجموعة، وتحدد قيمة success مسار النجاح أو الفشل.

1 تصل رسالة واتساب وتطابق مشغّل الرد التلقائي.
2 نرسل طلب POST موقّعًا إلى webhook_url الخاص بالقاعدة بشكل غير متزامن.
3 يعيد نظامك النص المطلوب إرساله، أو لا يعيد شيئًا إذا لم يرغب بالرد.
4 نرسل النص إلى جهة الاتصال نفسها ونسجله في صندوق الوارد.

ما نرسله · POST إلى webhook_url

{
    "auto_reply_id": 7,
    "auto_reply_name": "Certificate Check",
    "from": "+966501234567",
    "contact_name": "Ahmed Al-Otaibi",
    "message": "is certificate 123 valid?",
    "triggered_at": "2026-07-22T14:00:00+00:00"
}

ترويسة التوقيع

X-Webhook-Signature: sha256=<hmac>

قيمة hmac هي توقيع HMAC-SHA256 لمحتوى JSON الخام باستخدام webhook_secret. أعد حساب التوقيع وقارنه بطريقة ثابتة الزمن قبل الوثوق بالبيانات.

استجابة نظامك · إرسال رد

{
    "reply": "Certificate #123 is valid, issued 2026-01-10."
}

استجابة نظامك · دون إرسال رد

{
    "reply": null
}

يجب أن تستجيب نقطة النهاية خلال بضع ثوانٍ. لا توجد إعادة محاولة تلقائية عند الفشل أو انتهاء المهلة؛ وفي هذه الحالة لن يُرسل رد لهذه الرسالة فقط.

الجلسة

التحقق من صلاحية الرمز ومعرفة الحساب التابع له.

نقطة نهاية واحدة

عرض بيانات المستخدم الحالي للرمز

مثال على الطلب · curl

curl --request GET 'https://bot.netrogrp.com/api/v1/user' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

200

{
    "id": 1,
    "name": "Ahmed Al-Otaibi",
    "email": "[email protected]",
    "created_at": "...",
    "updated_at": "..."
}

جهات الاتصال

إدارة جهات اتصال واتساب المحفوظة وتنظيمها داخل قوائم الاتصال.

5 نقاط نهاية

عرض جهات الاتصال

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

الاسم	النوع	مطلوب	الوصف
per_page	integer	لا	Results per page (default 25).

مثال على الطلب · curl

curl --request GET 'https://bot.netrogrp.com/api/v1/contacts' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

200

{
    "data": [
        {
            "id": 1,
            "name": "Ahmed Al-Otaibi",
            "phone": "+966501234567",
            "country": "SA",
            "photo_url": null,
            "contact_lists": [],
            "created_at": "2026-07-20T09:12:00.000000Z",
            "updated_at": "2026-07-20T09:12:00.000000Z"
        }
    ],
    "links": {
        "first": "...",
        "last": "...",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "last_page": 1,
        "per_page": 25,
        "total": 1
    }
}

إنشاء جهة اتصال

معاملات محتوى الطلب

الاسم	النوع	مطلوب	الوصف
name	string	نعم	Contact display name.
phone	string	نعم	Phone number, digits with or without a leading +.
country	string	لا	2-letter ISO country code.
contact_list_ids	integer[]	لا	IDs of your own contact lists to attach this contact to.

مثال على الطلب · curl

curl --request POST 'https://bot.netrogrp.com/api/v1/contacts' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Ahmed Al-Otaibi","phone":"+966501234567","country":"SA","contact_list_ids":[3]}'

مثال على الاستجابة

201

{
    "data": {
        "id": 1,
        "name": "Ahmed Al-Otaibi",
        "phone": "+966501234567",
        "country": "SA",
        "photo_url": null,
        "contact_lists": [
            {
                "id": 3,
                "name": "VIP Customers",
                "contacts_count": null,
                "created_at": "...",
                "updated_at": "..."
            }
        ],
        "created_at": "2026-07-22T10:00:00.000000Z",
        "updated_at": "2026-07-22T10:00:00.000000Z"
    }
}

عرض جهة اتصال واحدة

مثال على الطلب · curl

curl --request GET 'https://bot.netrogrp.com/api/v1/contacts/{id}' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

200

{
    "data": {
        "id": 1,
        "name": "Ahmed Al-Otaibi",
        "phone": "+966501234567",
        "country": "SA",
        "photo_url": null,
        "contact_lists": [],
        "created_at": "...",
        "updated_at": "..."
    }
}

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

معاملات محتوى الطلب

الاسم	النوع	مطلوب	الوصف
name	string	لا	Contact display name.
phone	string	لا	Phone number.
country	string	لا	2-letter ISO country code.
contact_list_ids	integer[]	لا	Replaces the full set of attached contact lists.

مثال على الطلب · curl

curl --request PUT 'https://bot.netrogrp.com/api/v1/contacts/{id}' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Ahmed Al-Otaibi (Updated)"}'

مثال على الاستجابة

200

{
    "data": {
        "id": 1,
        "name": "Ahmed Al-Otaibi (Updated)",
        "phone": "+966501234567",
        "country": "SA",
        "photo_url": null,
        "contact_lists": [],
        "created_at": "...",
        "updated_at": "..."
    }
}

حذف جهة اتصال

مثال على الطلب · curl

curl --request DELETE 'https://bot.netrogrp.com/api/v1/contacts/{id}' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

204

(محتوى فارغ)

قوائم الاتصال

مجموعات جهات الاتصال المستخدمة لاستهداف حملات واتساب.

5 نقاط نهاية

عرض قوائم الاتصال

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

الاسم	النوع	مطلوب	الوصف
per_page	integer	لا	Results per page (default 25).

مثال على الطلب · curl

curl --request GET 'https://bot.netrogrp.com/api/v1/contact-lists' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

200

{
    "data": [
        {
            "id": 3,
            "name": "VIP Customers",
            "contacts_count": 42,
            "created_at": "...",
            "updated_at": "..."
        }
    ],
    "links": [
        "..."
    ],
    "meta": [
        "..."
    ]
}

إنشاء قائمة اتصال

معاملات محتوى الطلب

الاسم	النوع	مطلوب	الوصف
name	string	نعم	List name.

مثال على الطلب · curl

curl --request POST 'https://bot.netrogrp.com/api/v1/contact-lists' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"name":"VIP Customers"}'

مثال على الاستجابة

201

{
    "data": {
        "id": 3,
        "name": "VIP Customers",
        "contacts_count": 0,
        "created_at": "...",
        "updated_at": "..."
    }
}

عرض قائمة اتصال واحدة

مثال على الطلب · curl

curl --request GET 'https://bot.netrogrp.com/api/v1/contact-lists/{id}' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

200

{
    "data": {
        "id": 3,
        "name": "VIP Customers",
        "contacts_count": 42,
        "created_at": "...",
        "updated_at": "..."
    }
}

إعادة تسمية قائمة اتصال

معاملات محتوى الطلب

الاسم	النوع	مطلوب	الوصف
name	string	نعم	List name.

مثال على الطلب · curl

curl --request PUT 'https://bot.netrogrp.com/api/v1/contact-lists/{id}' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"name":"VIP Customers 2026"}'

مثال على الاستجابة

200

{
    "data": {
        "id": 3,
        "name": "VIP Customers 2026",
        "contacts_count": 42,
        "created_at": "...",
        "updated_at": "..."
    }
}

حذف قائمة اتصال

مثال على الطلب · curl

curl --request DELETE 'https://bot.netrogrp.com/api/v1/contact-lists/{id}' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

204

(محتوى فارغ)

الردود التلقائية

ردود آلية تُشغّلها الكلمات المفتاحية في رسائل واتساب الواردة.

6 نقاط نهاية

عرض الردود التلقائية

Ordered by priority, highest first.

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

الاسم	النوع	مطلوب	الوصف
per_page	integer	لا	Results per page (default 25).

مثال على الطلب · curl

curl --request GET 'https://bot.netrogrp.com/api/v1/auto-replies' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

200

{
    "data": [
        {
            "id": 5,
            "name": "Working Hours",
            "match_type": "any",
            "trigger": null,
            "reply_mode": "static",
            "reply_message": "We're open 9am-6pm Sat-Thu.",
            "webhook_url": null,
            "webhook_secret": null,
            "is_active": true,
            "priority": 10,
            "created_at": "...",
            "updated_at": "..."
        },
        {
            "id": 7,
            "name": "Certificate Check",
            "match_type": "any",
            "trigger": null,
            "reply_mode": "webhook",
            "reply_message": null,
            "webhook_url": "https://partner.example.com/webhooks/whatsapp",
            "webhook_secret": "a1b2c3...",
            "is_active": true,
            "priority": 20,
            "created_at": "...",
            "updated_at": "..."
        }
    ],
    "links": [
        "..."
    ],
    "meta": [
        "..."
    ]
}

إنشاء رد تلقائي ثابت

معاملات محتوى الطلب

الاسم	النوع	مطلوب	الوصف
name	string	نعم	Internal label for this rule.
match_type	string	نعم	One of any, exact, starts_with, contains.
trigger	string	unless match_type is any	The text to match against the inbound message.
reply_mode	string	لا	static (default) or webhook.
reply_message	string	if reply_mode=static	The freeform text sent back automatically.
webhook_url	string	if reply_mode=webhook	URL we POST the inbound message to.
is_active	boolean	لا	Defaults to true.
priority	integer	لا	Higher priority rules are checked first.

مثال على الطلب · curl

curl --request POST 'https://bot.netrogrp.com/api/v1/auto-replies' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Pricing Question","match_type":"contains","trigger":"price","reply_message":"Our pricing starts at 99 SAR/month, ask us for a quote!","priority":5}'

مثال على الاستجابة

201

{
    "data": {
        "id": 6,
        "name": "Pricing Question",
        "match_type": "contains",
        "trigger": "price",
        "reply_mode": "static",
        "reply_message": "Our pricing starts at 99 SAR/month, ask us for a quote!",
        "webhook_url": null,
        "webhook_secret": null,
        "is_active": true,
        "priority": 5,
        "created_at": "...",
        "updated_at": "..."
    }
}

إنشاء رد تلقائي عبر Webhook

webhook_secret is generated automatically on creation (never sent by you) — read it back from this same response, or from a later GET, to configure signature verification on your side.

مثال على الطلب · curl

curl --request POST 'https://bot.netrogrp.com/api/v1/auto-replies' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Certificate Check","match_type":"any","reply_mode":"webhook","webhook_url":"https://partner.example.com/webhooks/whatsapp"}'

مثال على الاستجابة

201

{
    "data": {
        "id": 7,
        "name": "Certificate Check",
        "match_type": "any",
        "trigger": null,
        "reply_mode": "webhook",
        "reply_message": null,
        "webhook_url": "https://partner.example.com/webhooks/whatsapp",
        "webhook_secret": "a1b2c3d4e5f6...",
        "is_active": true,
        "priority": 0,
        "created_at": "...",
        "updated_at": "..."
    }
}

عرض رد تلقائي واحد

مثال على الطلب · curl

curl --request GET 'https://bot.netrogrp.com/api/v1/auto-replies/{id}' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

200

{
    "data": {
        "id": 6,
        "name": "Pricing Question",
        "match_type": "contains",
        "trigger": "price",
        "reply_mode": "static",
        "reply_message": "...",
        "webhook_url": null,
        "webhook_secret": null,
        "is_active": true,
        "priority": 5,
        "created_at": "...",
        "updated_at": "..."
    }
}

تحديث رد تلقائي

معاملات محتوى الطلب

الاسم	النوع	مطلوب	الوصف
name	string	لا	Internal label.
match_type	string	لا	One of any, exact, starts_with, contains.
trigger	string	لا	Match text.
reply_mode	string	لا	static or webhook.
reply_message	string	لا	Reply text (static mode).
webhook_url	string	لا	Webhook URL (webhook mode).
is_active	boolean	لا	Enable/disable without deleting.
priority	integer	لا	Match order.

مثال على الطلب · curl

curl --request PUT 'https://bot.netrogrp.com/api/v1/auto-replies/{id}' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"is_active":false}'

مثال على الاستجابة

200

{
    "data": {
        "id": 6,
        "name": "Pricing Question",
        "match_type": "contains",
        "trigger": "price",
        "reply_mode": "static",
        "reply_message": "...",
        "webhook_url": null,
        "webhook_secret": null,
        "is_active": false,
        "priority": 5,
        "created_at": "...",
        "updated_at": "..."
    }
}

حذف رد تلقائي

مثال على الطلب · curl

curl --request DELETE 'https://bot.netrogrp.com/api/v1/auto-replies/{id}' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

204

(محتوى فارغ)

الردود السريعة

مكتبة ردود قابلة لإعادة الاستخدام بواسطة الموظفين.

5 نقاط نهاية

عرض الردود السريعة

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

الاسم	النوع	مطلوب	الوصف
per_page	integer	لا	Results per page (default 25).

مثال على الطلب · curl

curl --request GET 'https://bot.netrogrp.com/api/v1/quick-replies' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

200

{
    "data": [
        {
            "id": 2,
            "title": "Greeting",
            "shortcut": "/hello",
            "message": "Hi! Thanks for reaching out, how can we help?",
            "created_at": "...",
            "updated_at": "..."
        }
    ],
    "links": [
        "..."
    ],
    "meta": [
        "..."
    ]
}

إنشاء رد سريع

معاملات محتوى الطلب

الاسم	النوع	مطلوب	الوصف
title	string	نعم	Internal label.
shortcut	string	نعم	Shortcut text agents type to insert it.
message	string	نعم	The message text.

مثال على الطلب · curl

curl --request POST 'https://bot.netrogrp.com/api/v1/quick-replies' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"title":"Greeting","shortcut":"/hello","message":"Hi! Thanks for reaching out, how can we help?"}'

مثال على الاستجابة

201

{
    "data": {
        "id": 2,
        "title": "Greeting",
        "shortcut": "/hello",
        "message": "Hi! Thanks for reaching out, how can we help?",
        "created_at": "...",
        "updated_at": "..."
    }
}

عرض رد سريع واحد

مثال على الطلب · curl

curl --request GET 'https://bot.netrogrp.com/api/v1/quick-replies/{id}' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

200

{
    "data": {
        "id": 2,
        "title": "Greeting",
        "shortcut": "/hello",
        "message": "...",
        "created_at": "...",
        "updated_at": "..."
    }
}

تحديث رد سريع

معاملات محتوى الطلب

الاسم	النوع	مطلوب	الوصف
title	string	لا	Internal label.
shortcut	string	لا	Shortcut text.
message	string	لا	Message text.

مثال على الطلب · curl

curl --request PUT 'https://bot.netrogrp.com/api/v1/quick-replies/{id}' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"message":"Hi! Thanks for messaging us \u2014 how can we help today?"}'

مثال على الاستجابة

200

{
    "data": {
        "id": 2,
        "title": "Greeting",
        "shortcut": "/hello",
        "message": "Hi! Thanks for messaging us — how can we help today?",
        "created_at": "...",
        "updated_at": "..."
    }
}

حذف رد سريع

مثال على الطلب · curl

curl --request DELETE 'https://bot.netrogrp.com/api/v1/quick-replies/{id}' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

204

(محتوى فارغ)

الوسوم

تصنيفات تُلحق بجهات الاتصال لتجميعها وتصفيتها.

5 نقاط نهاية

عرض الوسوم

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

الاسم	النوع	مطلوب	الوصف
per_page	integer	لا	Results per page (default 25).

مثال على الطلب · curl

curl --request GET 'https://bot.netrogrp.com/api/v1/tags' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

200

{
    "data": [
        {
            "id": 5,
            "name": "VIP",
            "color": "#10b981",
            "created_at": "...",
            "updated_at": "..."
        }
    ],
    "links": [
        "..."
    ],
    "meta": [
        "..."
    ]
}

إنشاء وسم

معاملات محتوى الطلب

الاسم	النوع	مطلوب	الوصف
name	string	نعم	Tag label.
color	string	لا	Hex color, e.g. #10b981. Assigned randomly if omitted.

مثال على الطلب · curl

curl --request POST 'https://bot.netrogrp.com/api/v1/tags' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"name":"VIP","color":"#10b981"}'

مثال على الاستجابة

201

{
    "data": {
        "id": 5,
        "name": "VIP",
        "color": "#10b981",
        "created_at": "...",
        "updated_at": "..."
    }
}

عرض وسم واحد

مثال على الطلب · curl

curl --request GET 'https://bot.netrogrp.com/api/v1/tags/{id}' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

200

{
    "data": {
        "id": 5,
        "name": "VIP",
        "color": "#10b981",
        "created_at": "...",
        "updated_at": "..."
    }
}

تحديث وسم

معاملات محتوى الطلب

الاسم	النوع	مطلوب	الوصف
name	string	لا	Tag label.
color	string	لا	Hex color.

مثال على الطلب · curl

curl --request PUT 'https://bot.netrogrp.com/api/v1/tags/{id}' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"color":"#3b82f6"}'

مثال على الاستجابة

200

{
    "data": {
        "id": 5,
        "name": "VIP",
        "color": "#3b82f6",
        "created_at": "...",
        "updated_at": "..."
    }
}

حذف وسم

مثال على الطلب · curl

curl --request DELETE 'https://bot.netrogrp.com/api/v1/tags/{id}' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

204

(محتوى فارغ)

مقالات معرفة الذكاء الاصطناعي

أزواج سؤال/جواب يعتمد عليها مساعد الذكاء الاصطناعي عند الرد التلقائي.

5 نقاط نهاية

عرض مقالات المعرفة

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

الاسم	النوع	مطلوب	الوصف
per_page	integer	لا	Results per page (default 25).

مثال على الطلب · curl

curl --request GET 'https://bot.netrogrp.com/api/v1/ai-knowledge-articles' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

200

{
    "data": [
        {
            "id": 3,
            "question": "What are your business hours?",
            "answer": "We are open Sunday to Thursday, 9am to 5pm.",
            "is_active": true,
            "created_at": "...",
            "updated_at": "..."
        }
    ],
    "links": [
        "..."
    ],
    "meta": [
        "..."
    ]
}

إنشاء مقالة معرفة

معاملات محتوى الطلب

الاسم	النوع	مطلوب	الوصف
question	string	نعم	The customer question this article answers.
answer	string	نعم	The answer the AI will use.
is_active	boolean	لا	Defaults to true.

مثال على الطلب · curl

curl --request POST 'https://bot.netrogrp.com/api/v1/ai-knowledge-articles' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"question":"What are your business hours?","answer":"We are open Sunday to Thursday, 9am to 5pm."}'

مثال على الاستجابة

201

{
    "data": {
        "id": 3,
        "question": "What are your business hours?",
        "answer": "We are open Sunday to Thursday, 9am to 5pm.",
        "is_active": true,
        "created_at": "...",
        "updated_at": "..."
    }
}

عرض مقالة معرفة واحدة

مثال على الطلب · curl

curl --request GET 'https://bot.netrogrp.com/api/v1/ai-knowledge-articles/{id}' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

200

{
    "data": {
        "id": 3,
        "question": "What are your business hours?",
        "answer": "We are open Sunday to Thursday, 9am to 5pm.",
        "is_active": true,
        "created_at": "...",
        "updated_at": "..."
    }
}

تحديث مقالة معرفة

معاملات محتوى الطلب

الاسم	النوع	مطلوب	الوصف
question	string	لا	The customer question.
answer	string	لا	The answer.
is_active	boolean	لا	Inactive articles are excluded from AI matching.

مثال على الطلب · curl

curl --request PUT 'https://bot.netrogrp.com/api/v1/ai-knowledge-articles/{id}' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"answer":"We are open Sunday to Thursday, 9am to 6pm."}'

مثال على الاستجابة

200

{
    "data": {
        "id": 3,
        "question": "What are your business hours?",
        "answer": "We are open Sunday to Thursday, 9am to 6pm.",
        "is_active": true,
        "created_at": "...",
        "updated_at": "..."
    }
}

حذف مقالة معرفة

مثال على الطلب · curl

curl --request DELETE 'https://bot.netrogrp.com/api/v1/ai-knowledge-articles/{id}' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

204

(محتوى فارغ)

القوالب

قوالب رسائل واتساب المعتمدة من Meta.

3 نقاط نهاية

عرض القوالب

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

الاسم	النوع	مطلوب	الوصف
per_page	integer	لا	Results per page (default 25).

مثال على الطلب · curl

curl --request GET 'https://bot.netrogrp.com/api/v1/templates' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

200

{
    "data": [
        {
            "id": 4,
            "name": "order_confirmation",
            "category": "UTILITY",
            "language": "en_US",
            "status": "APPROVED",
            "rejected_reason": null,
            "components": [
                {
                    "type": "BODY",
                    "text": "Your order {{1}} has shipped!"
                }
            ],
            "last_synced_at": "...",
            "created_at": "...",
            "updated_at": "..."
        }
    ],
    "links": [
        "..."
    ],
    "meta": [
        "..."
    ]
}

عرض قالب واحد

مثال على الطلب · curl

curl --request GET 'https://bot.netrogrp.com/api/v1/templates/{id}' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

200

{
    "data": {
        "id": 4,
        "name": "order_confirmation",
        "category": "UTILITY",
        "language": "en_US",
        "status": "APPROVED",
        "rejected_reason": null,
        "components": [
            {
                "type": "BODY",
                "text": "Your order {{1}} has shipped!"
            }
        ],
        "last_synced_at": "...",
        "created_at": "...",
        "updated_at": "..."
    }
}

حذف قالب

Deletes on Meta first (by name, all languages) — only removed locally once Meta confirms the deletion (or confirms it was never submitted there). A failed Meta deletion never touches the local row.

مثال على الطلب · curl

curl --request DELETE 'https://bot.netrogrp.com/api/v1/templates/{id}' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

204

(محتوى فارغ)

عند الفشل

422

{
    "message": "Meta rejected the delete request: ..."
}

الحملات

إرسال رسائل القوالب جماعيًا إلى قائمة اتصال مع تتبع التسليم.

7 نقاط نهاية

عرض الحملات

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

الاسم	النوع	مطلوب	الوصف
per_page	integer	لا	Results per page (default 25).

مثال على الطلب · curl

curl --request GET 'https://bot.netrogrp.com/api/v1/campaigns' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

200

{
    "data": [
        {
            "id": 9,
            "name": "July Promo",
            "status": "draft",
            "template": {
                "id": 4,
                "name": "order_confirmation"
            },
            "contact_list": {
                "id": 3,
                "name": "VIP Customers"
            },
            "scheduled_at": null,
            "started_at": null,
            "completed_at": null,
            "total_recipients": 0,
            "sent_count": 0,
            "failed_count": 0,
            "created_at": "...",
            "updated_at": "..."
        }
    ],
    "links": [
        "..."
    ],
    "meta": [
        "..."
    ]
}

إنشاء حملة

status is set automatically: 'scheduled' if scheduled_at is given, otherwise 'draft'. Use POST /campaigns/{id}/send to actually queue it for sending.

معاملات محتوى الطلب

الاسم	النوع	مطلوب	الوصف
name	string	نعم	Campaign name.
whats_app_template_id	integer	نعم	ID of one of your own templates.
whats_app_contact_list_id	integer	نعم	ID of one of your own contact lists.
scheduled_at	datetime	لا	ISO 8601 datetime to schedule for later.

مثال على الطلب · curl

curl --request POST 'https://bot.netrogrp.com/api/v1/campaigns' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"name":"July Promo","whats_app_template_id":4,"whats_app_contact_list_id":3}'

مثال على الاستجابة

201

{
    "data": {
        "id": 9,
        "name": "July Promo",
        "status": "draft",
        "template": {
            "id": 4,
            "name": "order_confirmation"
        },
        "contact_list": {
            "id": 3,
            "name": "VIP Customers"
        },
        "scheduled_at": null,
        "started_at": null,
        "completed_at": null,
        "total_recipients": 0,
        "sent_count": 0,
        "failed_count": 0,
        "created_at": "...",
        "updated_at": "..."
    }
}

عرض حملة واحدة

مثال على الطلب · curl

curl --request GET 'https://bot.netrogrp.com/api/v1/campaigns/{id}' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

200

{
    "data": {
        "id": 9,
        "name": "July Promo",
        "status": "sending",
        "template": {
            "id": 4,
            "name": "order_confirmation"
        },
        "contact_list": {
            "id": 3,
            "name": "VIP Customers"
        },
        "scheduled_at": null,
        "started_at": "...",
        "completed_at": null,
        "total_recipients": 42,
        "sent_count": 30,
        "failed_count": 1,
        "created_at": "...",
        "updated_at": "..."
    }
}

تحديث حملة

The name can be changed regardless of status. template/contact_list/scheduled_at are only mutable while the campaign is still status=draft — sending those fields for a non-draft campaign is silently ignored rather than rejected, mirroring the client panel's edit page.

معاملات محتوى الطلب

الاسم	النوع	مطلوب	الوصف
name	string	لا	Campaign name.
whats_app_template_id	integer	لا	Draft campaigns only.
whats_app_contact_list_id	integer	لا	Draft campaigns only.
scheduled_at	datetime	لا	Draft campaigns only.

مثال على الطلب · curl

curl --request PUT 'https://bot.netrogrp.com/api/v1/campaigns/{id}' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"name":"July Promo (updated)"}'

مثال على الاستجابة

200

{
    "data": {
        "id": 9,
        "name": "July Promo (updated)",
        "status": "draft",
        "template": {
            "id": 4,
            "name": "order_confirmation"
        },
        "contact_list": {
            "id": 3,
            "name": "VIP Customers"
        },
        "scheduled_at": null,
        "started_at": null,
        "completed_at": null,
        "total_recipients": 0,
        "sent_count": 0,
        "failed_count": 0,
        "created_at": "...",
        "updated_at": "..."
    }
}

حذف حملة

Only allowed while status is one of draft, cancelled, failed, or completed — a scheduled/queued/sending campaign must be cancelled first (POST /campaigns/{id}/cancel).

مثال على الطلب · curl

curl --request DELETE 'https://bot.netrogrp.com/api/v1/campaigns/{id}' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

204

(محتوى فارغ)

عند الفشل

422

{
    "message": "This campaign cannot be deleted in its current status. Cancel it first."
}

إرسال حملة الآن

Sets status to queued and dispatches the same background job the client panel uses — delivery happens asynchronously, poll GET /campaigns/{id} for progress.

مثال على الطلب · curl

curl --request POST 'https://bot.netrogrp.com/api/v1/campaigns/{id}/send' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

200

{
    "data": {
        "id": 9,
        "name": "July Promo",
        "status": "queued",
        "template": {
            "id": 4,
            "name": "order_confirmation"
        },
        "contact_list": {
            "id": 3,
            "name": "VIP Customers"
        },
        "scheduled_at": null,
        "started_at": null,
        "completed_at": null,
        "total_recipients": 0,
        "sent_count": 0,
        "failed_count": 0,
        "created_at": "...",
        "updated_at": "..."
    }
}

إلغاء حملة

مثال على الطلب · curl

curl --request POST 'https://bot.netrogrp.com/api/v1/campaigns/{id}/cancel' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

200

{
    "data": {
        "id": 9,
        "name": "July Promo",
        "status": "cancelled",
        "template": {
            "id": 4,
            "name": "order_confirmation"
        },
        "contact_list": {
            "id": 3,
            "name": "VIP Customers"
        },
        "scheduled_at": null,
        "started_at": null,
        "completed_at": null,
        "total_recipients": 0,
        "sent_count": 0,
        "failed_count": 0,
        "created_at": "...",
        "updated_at": "..."
    }
}

الرسائل

قراءة المحادثات وإرسال رسائل واتساب الصادرة.

نقطتا نهاية

عرض الرسائل

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

الاسم	النوع	مطلوب	الوصف
contact_phone	string	لا	Filter to a single conversation by phone number.
per_page	integer	لا	Results per page (default 25).

مثال على الطلب · curl

curl --request GET 'https://bot.netrogrp.com/api/v1/messages' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

200

{
    "data": [
        {
            "id": 88,
            "contact_phone": "+966501234567",
            "contact_name": "Ahmed Al-Otaibi",
            "direction": "outbound",
            "type": "text",
            "body": "Thanks for your order!",
            "status": null,
            "wa_message_id": "wamid.XXXX",
            "media_url": null,
            "media_mime_type": null,
            "media_filename": null,
            "latitude": null,
            "longitude": null,
            "read_at": null,
            "created_at": "..."
        }
    ],
    "links": [
        "..."
    ],
    "meta": [
        "..."
    ]
}

إرسال رسالة

type=template is deliverable any time to any recipient (requires an APPROVED template). type=text/image/video/audio/document are only deliverable within the 24-hour window after the recipient's last inbound message — Meta silently drops them outside that window.

معاملات محتوى الطلب

الاسم	النوع	مطلوب	الوصف
to	string	نعم	Recipient phone number.
type	string	نعم	One of template, text, image, video, audio, document.
template_name	string	if type=template	Approved template name.
language_code	string	if type=template	e.g. en_US.
components	array	لا	WhatsApp Cloud API template components. Required when the approved template contains BODY, HEADER, or BUTTON variables. Each component contains type and parameters and is forwarded to template.components.
body	string	if type=text	Freeform message text.
url	string	if type=image/video/audio/document	Publicly reachable URL of the media file.
caption	string	لا	Caption (image/video/document only).
filename	string	لا	Filename (document only).

مثال على الطلب · curl

curl --request POST 'https://bot.netrogrp.com/api/v1/messages/send' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"to":"966501234567","type":"template","template_name":"event_ticket_ar","language_code":"en_US","components":[{"type":"body","parameters":[{"type":"text","text":"Attendee name"},{"type":"text","text":"Event name"},{"type":"text","text":"Date"},{"type":"text","text":"Time"},{"type":"text","text":"Location"},{"type":"text","text":"Ticket code"},{"type":"text","text":"https://example.com/tickets/123"}]}]}'

مثال على الاستجابة

200

{
    "data": {
        "id": 89,
        "contact_phone": "+966501234567",
        "contact_name": "Ahmed Al-Otaibi",
        "direction": "outbound",
        "type": "text",
        "body": null,
        "status": null,
        "wa_message_id": "wamid.YYYY",
        "media_url": null,
        "media_mime_type": null,
        "media_filename": null,
        "latitude": null,
        "longitude": null,
        "read_at": null,
        "created_at": "..."
    }
}

عند الفشل

422

{
    "message": "Meta rejected the message: ..."
}

تذاكر الدعم الفني

فتح ومتابعة تذاكر الدعم الفني مع فريقنا.

6 نقاط نهاية

عرض تذاكر الدعم

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

الاسم	النوع	مطلوب	الوصف
per_page	integer	لا	Results per page (default 25).

مثال على الطلب · curl

curl --request GET 'https://bot.netrogrp.com/api/v1/support-tickets' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

200

{
    "data": [
        {
            "id": 2,
            "ticket_number": "TKT-260803-LOQSW",
            "subject": "Cannot send messages",
            "status": "open",
            "priority": "high",
            "category": "Technical Issue",
            "replies": [],
            "last_reply_at": "...",
            "resolved_at": null,
            "closed_at": null,
            "created_at": "...",
            "updated_at": "..."
        }
    ],
    "links": [
        "..."
    ],
    "meta": [
        "..."
    ]
}

فتح تذكرة دعم

multipart/form-data request if attachments are included. message becomes the ticket's first reply, not a column on the ticket itself.

معاملات محتوى الطلب

الاسم	النوع	مطلوب	الوصف
subject	string	نعم	Short summary of the issue.
priority	string	نعم	One of low, medium, high.
category_id	integer	لا	ID of one of the fixed support ticket categories.
message	string	نعم	The initial message describing the issue.
attachments	file[]	لا	Up to 5 files, 5MB each.

مثال على الطلب · curl

curl --request POST 'https://bot.netrogrp.com/api/v1/support-tickets' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"subject":"Cannot send messages","priority":"high","message":"My WhatsApp account stopped sending messages since this morning."}'

مثال على الاستجابة

201

{
    "data": {
        "id": 2,
        "ticket_number": "TKT-260803-LOQSW",
        "subject": "Cannot send messages",
        "status": "open",
        "priority": "high",
        "category": null,
        "replies": [
            {
                "id": 2,
                "message": "My WhatsApp account stopped sending messages since this morning.",
                "is_staff_reply": false,
                "author": "Ahmed Al-Otaibi",
                "attachments": [],
                "created_at": "..."
            }
        ],
        "last_reply_at": "...",
        "resolved_at": null,
        "closed_at": null,
        "created_at": "...",
        "updated_at": "..."
    }
}

عرض تذكرة واحدة (مع ردودها)

مثال على الطلب · curl

curl --request GET 'https://bot.netrogrp.com/api/v1/support-tickets/{id}' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

200

{
    "data": {
        "id": 2,
        "ticket_number": "TKT-260803-LOQSW",
        "subject": "Cannot send messages",
        "status": "open",
        "priority": "high",
        "category": null,
        "replies": [
            {
                "id": 2,
                "message": "My WhatsApp account stopped sending messages since this morning.",
                "is_staff_reply": false,
                "author": "Ahmed Al-Otaibi",
                "attachments": [],
                "created_at": "..."
            }
        ],
        "last_reply_at": "...",
        "resolved_at": null,
        "closed_at": null,
        "created_at": "...",
        "updated_at": "..."
    }
}

إضافة رد

Rejected with a 422 if the ticket is currently closed — reopen it first.

معاملات محتوى الطلب

الاسم	النوع	مطلوب	الوصف
message	string	نعم	Reply text, max 5000 characters.
attachments	file[]	لا	Up to 5 files, 5MB each.

مثال على الطلب · curl

curl --request POST 'https://bot.netrogrp.com/api/v1/support-tickets/{id}/replies' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"message":"Any update on this?"}'

مثال على الاستجابة

200

{
    "data": {
        "id": 2,
        "ticket_number": "TKT-260803-LOQSW",
        "status": "open",
        "replies": [
            "..."
        ]
    }
}

عند الفشل

422

{
    "message": "This ticket is closed. Reopen it before replying."
}

إغلاق تذكرة

مثال على الطلب · curl

curl --request POST 'https://bot.netrogrp.com/api/v1/support-tickets/{id}/close' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

200

{
    "data": {
        "id": 2,
        "status": "closed"
    }
}

إعادة فتح تذكرة

مثال على الطلب · curl

curl --request POST 'https://bot.netrogrp.com/api/v1/support-tickets/{id}/reopen' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

مثال على الاستجابة

200

{
    "data": {
        "id": 2,
        "status": "open"
    }
}