وضع الاختبار

تحكّم في محاكي وضع الاختبار. لمفاتيح الاختبار فقط.

نقاط الواجهة

postمحاكاة رسالة من عميل/test/inbound_messages
postفرض حالة رسالة/test/messages/{id}/status

محاكاة رسالة من عميل

posthttps://api.saei.automize.sa/v1/test/inbound_messages

الصلاحية: messages:send
لمفاتيح الاختبار فقط

كأن عميلًا راسلك للتو. يُطلق message.received إلى نقاط الاختبار ويفتح نافذة الـ24 ساعة المحاكاة لهذا الرقم. لمفاتيح الاختبار فقط.

جسم الطلب

fromstringمطلوب
رقم العميل الذي تأتي منه الرسالة بصيغة E.164.
tostringاختياري
typestringاختياري
إحدى القيمtextbutton_reply
textobjectاختياري
الحقول الفرعية (1)
- bodystringاختياري
button_replyobjectاختياري
الحقول الفرعية (2)
- idstringاختياري
- titlestringاختياري
profile_namestringاختياري

حقول الاستجابة201· الرسالة الواردة المحاكاة.

idstringمطلوب
معرّف فريد. عامله كنص معتم وخزّنه كنص حتى 64 حرفًا.
object"message"مطلوب
livemodebooleanمطلوب
directionstringمطلوب
outbound للرسائل التي ترسلها، وinbound لرسائل العملاء.
إحدى القيمoutboundinbound
channelstringمطلوب
إحدى القيمwhatsappinstagrammessenger
fromstring | nullاختياري
المُرسِل، بصيغة E.164 في واتساب.
tostring | nullاختياري
المُستلِم، بصيغة E.164 في واتساب.
typestringمطلوب
نوع محتوى الرسالة.
textobjectاختياري
الحقول الفرعية (1)
- bodystringاختياري
templateobjectاختياري
الحقول الفرعية (4)
- namestringاختياري
- languagestringاختياري
- variablesobjectاختياري
- bodystringاختياري
imageobjectاختياري
رسائل الوسائط تحمل link (أو media_id) وcaption وfilename وmime_type عند توفرها.
videoobjectاختياري
audioobjectاختياري
documentobjectاختياري
stickerobjectاختياري
locationobjectاختياري
contactsarrayاختياري
interactiveobjectاختياري
ما أرسلته (type وbody وbuttons…)، أو عند ضغط العميل: reply: {id, title}.
reactionobjectاختياري
statusstringمطلوب
accepted ← sent ← delivered ← read، أو failed. رسائل العملاء حالتها received. تصلك تغيّرات الحالة كأحداث ويب هوك.
إحدى القيمacceptedsentdeliveredreadfailedreceived
errorobject | nullاختياري
سبب فشل التسليم، عندما تكون status هي failed.
الحقول الفرعية (3)
- codestring | nullاختياري
- titlestring | nullاختياري
- messagestring | nullاختياري
referencestring | nullاختياري
مرجعك الخاص، يُعاد كما أرسلته في طلب الإرسال وفي كل حدث.
conversation_idstring | nullاختياري
provider_message_idstring | nullاختياري
معرّف الرسالة لدى واتساب (wamid).
contactobject | nullاختياري
الحقول الفرعية (1)
- namestring | nullاختياري
contextobject | nullاختياري
في الرد، الرسالة التي يُرَد عليها.
الحقول الفرعية (1)
- provider_message_idstringاختياري
created_atstring | nullمطلوب
updated_atstring | nullاختياري

الأخطاء المحتملة2

422parameter_missingحقل مفقود
422parameter_invalidحقل غير صالح

جرّبها

curl -X POST https://api.saei.automize.sa/v1/test/inbound_messages \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "from": "+966500000004",
  "type": "text",
  "text": {
    "body": "مرحبا، أين طلبي؟"
  },
  "profile_name": "Sara"
}'

الاستجابة

الرسالة الواردة المحاكاة.

{
  "id": "msg_48213",
  "object": "message",
  "livemode": false,
  "direction": "outbound",
  "channel": "whatsapp",
  "from": "+966112345678",
  "to": "+966501234567",
  "type": "text",
  "text": {
    "body": "string"
  },
  "template": {
    "name": "string",
    "language": "string",
    "variables": {},
    "body": "string"
  },
  "image": {},
  "video": {},
  "audio": {},
  "document": {},
  "sticker": {},
  "location": {},
  "contacts": [],
  "interactive": {},
  "reaction": {},
  "status": "accepted",
  "error": {
    "code": "string",
    "title": "string",
    "message": "string"
  },
  "reference": "string",
  "conversation_id": "string",
  "provider_message_id": "string",
  "contact": {
    "name": "string"
  },
  "context": {
    "provider_message_id": "string"
  },
  "created_at": "2026-10-01T09:30:00Z",
  "updated_at": "2026-10-01T09:30:00Z"
}

فرض حالة رسالة

posthttps://api.saei.automize.sa/v1/test/messages/{id}/status

الصلاحية: messages:send
لمفاتيح الاختبار فقط

انقل رسالة اختبار إلى sent أو delivered أو read أو failed الآن وأطلق الحدث المطابق. الحالات تتقدم للأمام فقط. لمفاتيح الاختبار فقط.

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

idstringمطلوب
معرّف العنصر.

جسم الطلب

statusstringمطلوب
إحدى القيمsentdeliveredreadfailed
error_codestringاختياري
error_messagestringاختياري

حقول الاستجابة200· الرسالة بحالتها الجديدة.

idstringمطلوب
معرّف فريد. عامله كنص معتم وخزّنه كنص حتى 64 حرفًا.
object"message"مطلوب
livemodebooleanمطلوب
directionstringمطلوب
outbound للرسائل التي ترسلها، وinbound لرسائل العملاء.
إحدى القيمoutboundinbound
channelstringمطلوب
إحدى القيمwhatsappinstagrammessenger
fromstring | nullاختياري
المُرسِل، بصيغة E.164 في واتساب.
tostring | nullاختياري
المُستلِم، بصيغة E.164 في واتساب.
typestringمطلوب
نوع محتوى الرسالة.
textobjectاختياري
الحقول الفرعية (1)
- bodystringاختياري
templateobjectاختياري
الحقول الفرعية (4)
- namestringاختياري
- languagestringاختياري
- variablesobjectاختياري
- bodystringاختياري
imageobjectاختياري
رسائل الوسائط تحمل link (أو media_id) وcaption وfilename وmime_type عند توفرها.
videoobjectاختياري
audioobjectاختياري
documentobjectاختياري
stickerobjectاختياري
locationobjectاختياري
contactsarrayاختياري
interactiveobjectاختياري
ما أرسلته (type وbody وbuttons…)، أو عند ضغط العميل: reply: {id, title}.
reactionobjectاختياري
statusstringمطلوب
accepted ← sent ← delivered ← read، أو failed. رسائل العملاء حالتها received. تصلك تغيّرات الحالة كأحداث ويب هوك.
إحدى القيمacceptedsentdeliveredreadfailedreceived
errorobject | nullاختياري
سبب فشل التسليم، عندما تكون status هي failed.
الحقول الفرعية (3)
- codestring | nullاختياري
- titlestring | nullاختياري
- messagestring | nullاختياري
referencestring | nullاختياري
مرجعك الخاص، يُعاد كما أرسلته في طلب الإرسال وفي كل حدث.
conversation_idstring | nullاختياري
provider_message_idstring | nullاختياري
معرّف الرسالة لدى واتساب (wamid).
contactobject | nullاختياري
الحقول الفرعية (1)
- namestring | nullاختياري
contextobject | nullاختياري
في الرد، الرسالة التي يُرَد عليها.
الحقول الفرعية (1)
- provider_message_idstringاختياري
created_atstring | nullمطلوب
updated_atstring | nullاختياري

الأخطاء المحتملة2

422parameter_invalidحقل غير صالح
404resource_missingغير موجود

جرّبها

curl -X POST https://api.saei.automize.sa/v1/test/messages/msg_test_01j9x3k2m4n5p6q7r8s9t0v1w2/status \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "failed",
  "error_code": "131026"
}'

الاستجابة

الرسالة بحالتها الجديدة.

{
  "id": "msg_48213",
  "object": "message",
  "livemode": false,
  "direction": "outbound",
  "channel": "whatsapp",
  "from": "+966112345678",
  "to": "+966501234567",
  "type": "text",
  "text": {
    "body": "string"
  },
  "template": {
    "name": "string",
    "language": "string",
    "variables": {},
    "body": "string"
  },
  "image": {},
  "video": {},
  "audio": {},
  "document": {},
  "sticker": {},
  "location": {},
  "contacts": [],
  "interactive": {},
  "reaction": {},
  "status": "accepted",
  "error": {
    "code": "string",
    "title": "string",
    "message": "string"
  },
  "reference": "string",
  "conversation_id": "string",
  "provider_message_id": "string",
  "contact": {
    "name": "string"
  },
  "context": {
    "provider_message_id": "string"
  },
  "created_at": "2026-10-01T09:30:00Z",
  "updated_at": "2026-10-01T09:30:00Z"
}

نقاط الواجهة

محاكاة رسالة من عميل#

جسم الطلب

فرض حالة رسالة#

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

جسم الطلب

محاكاة رسالة من عميل

فرض حالة رسالة