التكاملات
تكامل مع ما لديك بالفعل.
قدرات موثقة للمنصة للرسائل والبيانات والمالية والحسابات. تُقدَّم المواصفات ومسارات الاستدعاء مع وثائق التثبيت.
إرسال SMS عبر HTTP
واجهة JSON، إلى جانب SMPP.
يرسل العملاء عبر SMPP أو HTTP(S): تشترك القناتان في التوجيه والتسعير والإيصالات والفوترة. يبقى إنهاء الرسائل لدى المورّدين عبر SMPP أو SS7.
SMPPSMPP 3.4 وSMPP عبر TLS
HTTP(S)POST /v1/sms باستخدام JSON
دورة واحدةالتوجيه والإيصال واحتساب الرسوم والفاتورة
الموردونSMPP أو SS7 عبر SIGTRAN
تخص الاستدعاءات الموضحة هنا واجهات API لتثبيت Auvia لدى العميل، وليس هذا الموقع. يعتمد العنوان الأساسي على التثبيت.
الإرسال: POST /v1/sms
- المصادقةترويسة Authorization: Bearer مع مفتاح API للحساب مخوّل بإذن sms.send. يمكن تعيين قائمة اختيارية لعناوين IP المسموح بها لكل مفتاح.
- منع تكرار التنفيذمع ترويسة Idempotency-Key الاختيارية، يعيد الطلب نفسه الوارد مرتين خلال 24 ساعة الاستجابة نفسها دون إعادة الإرسال.
- استجابة 202تم قبول الرسالة، وليس تسليمها. يُعرف التسليم من الإيصالات واستعلامات الحالة.
- الدفعاتحتى 1,000 مستلم لكل طلب. لكل مستلم نتيجة مستقلة: لا يؤدي رقم غير صالح إلى فشل الآخرين.
- رفض كاملإذا رُفض جميع المستلمين، تكون الاستجابة 400 أو 402 مع الأسباب.
حقول الطلب
- fromمرسل الرسالة
- toمصفوفة المستلمين، حتى 1,000 لكل طلب
- textنص الرسالة
- priorityالأولوية؛ يستخدم المثال الموثق otp
- validity_minutesصلاحية الرسالة بالدقائق
- client_refمرجع العميل، يُعاد في إشعارات webhook
- dlrطلب إيصال التسليم
- encodingاختياري: auto (افتراضي)، gsm7 أو ucs2
- scheduled_atاختياري: إرسال مجدول
POST /v1/sms
Authorization: Bearer <CHIAVE_API>
Idempotency-Key: <VALORE_UNIVOCO>
Content-Type: application/json
{
"from": "MITTENTE",
"to": ["<MSISDN_DESTINATARIO>"],
"text": "Il tuo codice è 482913",
"priority": "otp",
"validity_minutes": 60,
"client_ref": "ordine-8812",
"dlr": true
}HTTP 202
{
"accepted": 1,
"rejected": 0,
"messages": [
{
"to": "<MSISDN_DESTINATARIO>",
"message_id": "<ID_MESSAGGIO>",
"status": "accepted",
"parts": 1,
"encoding": "gsm7",
"price": 0.045,
"currency": "EUR"
}
]
}مفتاح API والرقم والمعرّف عناصر نائبة. السعر قيمة توضيحية وليس تعرفة.
رموز الأخطاء
| الرمز | HTTP | المعنى |
|---|---|---|
| invalid_number | 400، لكل مستلم | رقم غير صالح أو شبكة غير معروفة |
| missing_text | 400 | نص فارغ |
| text_too_long | 400 | نص يزيد عن 10 أجزاء |
| sender_not_allowed | 403، لكل مستلم | مرسل غير معتمد |
| blocked | 403، لكل مستلم | جدار حماية أو قاعدة توجيه |
| insufficient_balance | 402 | نفاد الرصيد |
| rate_limited | 429 | حد TPS للحساب، مع ترويسة Retry-After |
| unauthorized / forbidden | 401 / 403 | مفتاح مفقود أو ملغى، أو عنوان IP غير مسموح |
رموز ثابتة وموثقة ومطابقة لرموز SMPP حيثما أمكن. ينطبق حد 10 أجزاء على واجهة HTTP هذه؛ ولا يحل محل قدرات المنصة الأخرى.
الاستعلامات
- GET /v1/sms/{message_id}حالة الرسالة الحالية مع تفاصيل كل جزء
- GET /v1/balanceالرصيد وحد الائتمان
إشعارات webhook لـ DLR وMO
- الوجهاتتصل إيصالات التسليم (type dlr) والرسائل الواردة (type mo، مع from وto وtext وreceived_at وincomplete) عبر POST إلى عنوان URL المضبوط للحساب.
- التوقيعترويسة X-Signature: t=<timestamp>,v1=<HMAC-SHA256(secret, t + "." + body)>. يرفض العميل التواقيع الأقدم من 5 دقائق للحد من إعادة استخدام الإشعارات المعترضة.
- تأكيد الاستلامتؤكد أي استجابة 2xx استلام إشعار webhook، وليس تسليم الرسالة النصية.
- إعادة المحاولةإذا أعاد العميل خطأً أو لم يستجب خلال 10 ثوانٍ، تتكرر المحاولة بفترات انتظار متزايدة حتى 8 مرات خلال 6 ساعات. بعد نفاد المحاولات يتوقف إرسال الإشعار ويُسجل فشل التسليم.
{
"type": "dlr",
"message_id": "<ID_MESSAGGIO>",
"client_ref": "ordine-8812",
"to": "<MSISDN_DESTINATARIO>",
"status": "delivered",
"parts": 2,
"parts_delivered": 2,
"error_code": null,
"done_at": "2026-10-05T02:27:11Z"
}واجهات برمجة الرسائل
- HTTP(S) SMS APIإرسال الرسائل واستقبال تقارير التسليم عبر HTTP/HTTPS
- HTTP MNP APIمعلومات قابلية النقل لأي MSISDN
- Inbound SMS APIإعادة توجيه رسائل MO فورًا إلى أنظمة الأطراف الثالثة
واجهات البيانات والمالية
- CDR Export APIتصدير سجلات تفاصيل المكالمات
- Finance Document APIالوصول إلى الفواتير والمستندات المالية
- Traffic Report APIتقارير الحركة لأي فترة
واجهة REST API للأنظمة الخارجية
- الرصيدالرصيد الحالي وحد الائتمان والمبلغ المتاح والعملة
- الاستهلاكالرسائل والمُسلَّمة والفاشلة والأجزاء والمبالغ لكل فترة
- CDRسجلات تفاصيل المكالمات لكل رسالة
- الفواتيرالرقم والتواريخ والإجمالي والمبلغ المدفوع والحالة
- الأرقام الافتراضيةعرض الأرقام والنطاقات وإضافتها وإزالتها
- المصادقةرمز مميز بمفاتيح API
البروتوكولات
- العملاءSMPP 3.4 وSMPP عبر TLS وواجهة HTTP(S) وبوابة ويب
- الموردونSMPP 3.4 e 5.0
- SS7SIGTRAN (M3UA) عبر بوابة SMPP-to-SIGTRAN المدمجة
- MNP/HLRDNS ENUM/NAPTR وواجهة HTTP(S) MNP API
SMPP 3.4SMPP su TLSSMPP 5.0 (fornitori)SIGTRAN M3UADNS ENUM/NAPTRHTTP(S)SFTP (سجلات SS7 وPCAP)
من البروتوكول إلى المسار.
يصف الكتالوج كيف تُوجَّه الحركة الواردة وتُسعَّر وتُراقَب.