وثائق واجهة برمجة تطبيقات إدارة المكالمات
تتيح لك نقاط النهاية هذه استرداد بياناتك المكالمات الفائتة, المكالمات الواردة التي تم الرد عليها، و المكالمات الصادرة تمت المزامنة من تطبيق SMSMobileAPI للهواتف المحمولة إلى لوحة التحكم الخاصة بك + واجهة برمجة التطبيقات (API).
هام: إذا كان تطبيق الهاتف يعمل في الخلفية، فقد يفرض نظام الهاتف تأخيرًا (يصل غالبًا إلى 10 دقائق تقريبًا) بين عمليات المزامنة. يمكنك دائمًا فتح التطبيق للمزامنة يدويًا عند الحاجة.
التشغيل السريع
عنوان URL الأساسي
أمثلة
المصادقة
تستخدم نقاط نهاية إدارة المكالمات المصادقة التالية: أبيكي معلمات الاستعلام.
المفاهيم المشتركة
ترقيم الصفحات
يستخدم حد و إزاحة لتقسيم النتائج إلى صفحات.
الطوابع الزمنية
- call_date_ms هو طابع زمني لنظام يونكس أجزاء من الثانية.
- call_datetime_utc يتم تخزينها كسلسلة نصية للتاريخ والوقت بتوقيت UTC (حقل قاعدة البيانات).
- بالنسبة للمكالمات الفائتة، تُرجع واجهة برمجة التطبيقات (API) رسالة منسقة. تاريخ سلسلة نصية (مشتقة من قيمة بالمللي ثانية).
يبحث
- المكالمات الفائتة: يبحث يطابق الرقم أو الاسم.
- الوارد/الصادر: q مباريات رقم التليفون أو الاسم المخزن مؤقتًا.
الفرز (للوارد/الصادر فقط)
يتم التحكم في عملية الفرز بواسطة sort_by + sort_dir (للحقول المسموح بها فقط). يتم ترتيب المكالمات الفائتة دائمًا حسب الأحدث أولًا.
أخطاء
| HTTP | مثال على الخطأ | معنى |
|---|---|---|
| 400 | {"success":false,"error":"missing_apikey"} | مفقود أو فارغ أبيكي. |
| 403 | {"success":false,"error":"invalid_apikey"} | لم يتم العثور على مفتاح API / لم يتم التعرف عليه. |
| 403 | {"success":false,"error":"api_expired"} | انتهت صلاحية اشتراكك (حد التاريخ (قبل اليوم). |
| 500 | {"success":false,"error":"server_error","detail":"..."} | خطأ في الخادم (قاعدة البيانات، SQL، استثناء). |
ملاحظة: يمكن لنقطة نهاية المكالمات الفائتة أيضًا إرجاع رسائل مثل مفتاح API مفقود أو أخطاء في إعداد SQL حسب الحالة.
قائمة المكالمات الفائتة
استرجاع المكالمات الفائتة التي تمت مزامنتها من الجهاز المحمول.
نقطة النهاية
معلمات الاستعلام
| المعلمة | يكتب | وصف |
|---|---|---|
| أبيكي | خيط | مطلوب مفتاح API الخاص بك مرتبط بالهاتف المحمول. |
| إزاحة | عدد صحيح | خياري إزاحة الترقيم (الافتراضي: 0). |
| حد | عدد صحيح | خياري الحد الأقصى للصفوف (الافتراضي: 100، الأعلى: 500). |
| يبحث | خيط | خياري البحث بالرقم أو الاسم (SQL LIKE). |
| تاريخ_البداية | YYYY-MM-DD | خياري تصفية من هذا اليوم (00:00:00). |
| تاريخ_نهاية | YYYY-MM-DD | خياري تم التصفية حتى هذا اليوم (23:59:59). |
قائمة المكالمات الواردة
استرجاع المكالمات الواردة التي تم الرد عليها والتي تمت مزامنتها من الجهاز المحمول.
نقطة النهاية
معلمات الاستعلام
| المعلمة | يكتب | وصف |
|---|---|---|
| أبيكي | خيط | مطلوب مفتاح API الخاص بك (تم التحقق منه مقابل الاشتراك). |
| حد | عدد صحيح | خياري عدد الصفوف في الصفحة (الافتراضي: 50، الأعلى: 200). |
| إزاحة | عدد صحيح | خياري إزاحة الترقيم (الافتراضي: 0). |
| sort_by | خيط | خياري مسموح: call_date_ms call_datetime_utc المدة_ثانية رقم التليفون تم إنشاؤه في الاسم المخزن مؤقتًا تحديد الموقع الجغرافي |
| sort_dir | صعود| هبوط | خياري تقصير: الوصف. |
| تاريخ_من_مللي_ثانية | عدد صحيح (مللي ثانية) | خياري تصفية حيث تاريخ_الاتصال_بالمللي_ثانية >= تاريخ_البداية_بالمللي_ثانية. |
| date_to_ms | عدد صحيح (مللي ثانية) | خياري تصفية حيث call_date_ms <= date_to_ms. |
| q | خيط | خياري ابحث عن رقم التليفون أو الاسم المخزن مؤقتًا (يحب). |
قائمة المكالمات الصادرة
استرجاع المكالمات الصادرة التي تمت مزامنتها من الجهاز المحمول.
نقطة النهاية
معلمات الاستعلام
نفس المعايير والسلوكيات الخاصة بالمكالمات الواردة.
| المعلمة | يكتب | وصف |
|---|---|---|
| أبيكي | خيط | مطلوب مفتاح API الخاص بك (تم التحقق منه مقابل الاشتراك). |
| حد | عدد صحيح | خياري عدد الصفوف في الصفحة (الافتراضي: 50، الأعلى: 200). |
| إزاحة | عدد صحيح | خياري إزاحة الترقيم (الافتراضي: 0). |
| sort_by | خيط | خياري مسموح: call_date_ms call_datetime_utc المدة_ثانية رقم التليفون تم إنشاؤه في الاسم المخزن مؤقتًا تحديد الموقع الجغرافي |
| sort_dir | صعود| هبوط | خياري تقصير: الوصف. |
| تاريخ_من_مللي_ثانية | عدد صحيح (مللي ثانية) | خياري تصفية حيث تاريخ_الاتصال_بالمللي_ثانية >= تاريخ_البداية_بالمللي_ثانية. |
| date_to_ms | عدد صحيح (مللي ثانية) | خياري تصفية حيث call_date_ms <= date_to_ms. |
| q | خيط | خياري ابحث عن رقم التليفون أو الاسم المخزن مؤقتًا (يحب). |
حقول المكالمات الفائتة
| مجال | يكتب | وصف |
|---|---|---|
| نجاح | منطقي | حالة الطلب. |
| إزاحة | عدد صحيح | تم إرجاع إزاحة الترقيم. |
| حد | عدد صحيح | تم إرجاع الحد الأقصى لعدد الصفحات. |
| عدد | عدد صحيح | عدد الصفوف المُعادة في بيانات. |
| بيانات | مصفوفة | قائمة المكالمات الفائتة. |
| data[].number | خيط | رقم هاتف المتصل. |
| اسم البيانات[]. | خيط | اسم جهة الاتصال المخزن مؤقتًا (قد يكون فارغًا). |
| تاريخ البيانات[]. | خيط | سلسلة التاريخ والوقت المنسقة والمستمدة من طابع زمني بالمللي ثانية. |
الحقول الواردة/الصادرة
| مجال | يكتب | وصف |
|---|---|---|
| نجاح | منطقي | حالة الطلب. |
| أبيكي | خيط | تم إعادة إرسالها بواسطة واجهة برمجة التطبيقات (مفتاحك). |
| حد | عدد صحيح | عدد الصفوف في الصفحة الواحدة. |
| إزاحة | عدد صحيح | تم إرجاع إزاحة الترقيم. |
| sort_by | خيط | تم تطبيق حقل الفرز. |
| sort_dir | خيط | تم تطبيق اتجاه الفرز. |
| الفلاتر | هدف | المرشحات المكررة (تاريخ_من_مللي_ثانية, date_to_ms, q). |
| عدد | عدد صحيح | عدد الصفوف المُعادة في صفوف. |
| صفوف | مصفوفة | قائمة المكالمات. |
| rows[].phone_number | خيط | رقم التليفون. |
| rows[].cached_name | سلسلة نصية|لا شيء | اسم جهة الاتصال المخزن مؤقتًا (يمكن أن يكون فارغًا). |
| rows[].call_date_ms | عدد صحيح | الطابع الزمني للمكالمة بالمللي ثانية. |
| rows[].call_datetime_utc | خيط | حقل التاريخ والوقت بتوقيت UTC (قاعدة البيانات). |
| rows[].duration_sec | عدد صحيح | المدة بالثواني. |
| rows[].geo_location | سلسلة نصية|لا شيء | تسمية الموقع الجغرافي (يمكن أن تكون فارغة). |
| rows[].created_at | خيط | الطابع الزمني لإدخال الخادم. |
