الواجهة البرمجيّة للتطبيق (API)

الرسائل: مفاهيم أساسيّة

تُعتبر الرسائل (أو المحادثات) في تطبيق تينه من الركائز الأساسيّة للتطبيق، فبها يًمكن لأفراد الدوائر التواصل فيما بينهم لحظياً من خلال إرسال النصوص و مشاركة الوسائط، وقد خُصّصت هذه الصفحة لشرح وظائف الرسائل بالتفصيل المناسب.

إرسال نص كرسالة

يُمكن للمستخدم الحاليّ إرسال رسالة محتواها عبارةٌ عن نصّ إلى دائرة أو مجموعة من الدوائر التي يُعتبر فرداً فيها، و ذلك من خلال إرسال طلب إلى الرابط التالي مع تضمين متن (محتوى) الرسالة و كذلك الدوائر المُراد الإرسال إليها:

الطلب
POST 
{{teenah_api_url}}/messages/texts
  • {content} (مطلوب) محتوى الرسالة.
  • {circles} (مطلوب) الدوائر المُراد الإرسال إليها، توضع أرقام الدوائر داخل مصفوفة، مثلاً: [1,3,5].

و سيكون ردّ الخادم بعد استلام الطلب أحد الردود التالية: 204 أو 400 أو 403:

الردود
204
400 
{
    "message": "Bad request."
}
  • {message} رسالة الخطأ العائدة من الخادم.
403 
{
    "message": "Not authroized to use this resource."
}
  • {message} رسالة الخطأ العائدة من الخادم.

إرسال وسائط كرسالة

يُمكن للمستخدم أن يرسل صورة أو فيديو أو صوتاً إلى دائرةٍ أو مجموعةٍ من الدوائر من خلال إرسال طلب PUT إلى الرابط التالي مع تضمين نوع الوسائط التي سيتمّ إرسالها و كذلك محتوى هذه الوسائط و امتدادها:

الطلب
PUT 
{{teenah_api_url}}/messages/medias
  • {category} (مطلوب) تصنيف الوسائط المُراد إرسالها، صورة image أو فيديو video أو صوت sound.
  • {data} محتوى الملف المُراد رفعه إلى الخادم بصيغة base64.
  • {extension} (مطلوب) امتداد الملف المُراد، بفترض أن يكون من الصياغات: jpg,png,jpeg,gif,mp4,mp3.
  • {circles} (مطلوب) الدوائر المُراد الإرسال إليها، توضع أرقام الدوائر داخل مصفوفة، مثلاً: [1,3,5].

و سيكون ردّ الخادم أحد الردود التالية: 204 أو 400 أو 403:

الردود
204
400 
{
    "message": "Bad request."
}
  • {message} رسالة الخطأ العائدة من الخادم.
403 
{
    "message": "Not authroized to use this resource."
}
  • {message} رسالة الخطأ العائدة من الخادم.
الشروع في الاستخدام المستخدمون الأفراد الدوائر المناسبات الوسائط المتعدّدة الرسائل الشبكات الاجتماعيّة الوكلاء الإكمال التلقائي