المستندات

أرسل رسالتك الأولى في فترة ما بعد الظهر

واجهة برمجة تطبيقات REST بسيطة لإرسال الرسائل القصيرة وتتبعها واستلامها - مصادقة الرمز المميز وخطافات الويب في الوقت الفعلي ومجموعات SDK، دون أي شيء غريب لتتعلمه.

بداية سريعة

ثلاث حركات، ابدأ بالتسليم

كل عملية تكامل هي نفس القوس القصير - المصادقة، الإرسال، ثم التتبع.

01 · مصادقةالرمز المميز: sk_live_9f2a7c10نوع المحتوى: application/json ✓

أرسل مفتاح الوصول الخاص بك كرأس رمز مميز، مع نوع المحتوى: application/json، عند كل طلب.

02 · يرسلبوست /خارجي/sms{ msgstr: "9f2a7c10"، رمز الخطأ: 0 }

نشر من، إلى، والمحتوى. تعود الاستجابة برسالة msgid ورمز خطأ على الفور.

03 · مساراحصل على /report?status=Delivrd200 موافق

نقوم بنشر تقرير حالة أو الحصول عليه على عنوان URL لرد الاتصال الخاص بك في اللحظة التي تصل فيها الرسالة إلى حالتها النهائية.

يرسل

طلب واحد باللغة التي تستخدمها بالفعل

قم بنشر المرسل والمستلم والمحتوى الخاص بك باستخدام رأس الرمز المميز. ويعود الرد في اللحظة التي نقبله فيها.

01curl -X POST https://secure.smslocal.com/api/service/enterprise-service/external/sms \02  -H "Token: $SMSLOCAL_TOKEN" \03  -H "Content-Type: application/json" \04  -d '{05    "from": "SMSLOCAL",06    "to": "14155550123",07    "content": "Your code is 481920."08  }'
201 · مقبول

msgstr "9f2a7c10-4b2e-..."

اتجاه "جبل"

com.errorcode 0

احفظ msgstr - هذه هي الطريقة التي تتبع بها هذه الرسالة من هنا.

كائن الرسالة

اقرأ الرسالة من أعلى إلى أسفل

تُرجع جميع أحداث الإرسال والحالة والأحداث الواردة نفس الشكل - تعرف عليها مرة واحدة.

01معرف الرسالة

معرف الرسالة

msgid - يتم سكه لحظة إنشاء الرسالة. هذا هو المقبض الذي تستخدمه للتحقق من حالته لاحقًا.

02مرسل

مرسل

من - رقم هاتف، أو معرف أبجدي رقمي يصل إلى 11 حرفًا، أيًا كانت الهوية التي يراها المستلمون.

03متلقي

متلقي

إلى - الرقم الذي ستتوجه إليه الرسالة، بما في ذلك رمز البلد.

04الترميز

الترميز

ترميز البيانات — GSM7 يناسب 160 حرفًا لكل جزء؛ قم بالتبديل إلى Unicode وينخفض ​​ذلك إلى 70. انتقل إلى الأعلى، وسيتسلسل إلى أجزاء إضافية مفوترة.

05اتجاه

اتجاه

الاتجاه - كل رسالة هي mt (أنت أرسلتها) أو mo (لقد استلمتها)، بنفس الشكل في كلتا الحالتين.

06رمز الخطأ

رمز الخطأ

رمز الخطأ - يتم إرجاعه عند استجابة الإرسال وكل تقرير حالة. 0 تعني مقبولة؛ أي شيء آخر يخبرك بالضبط بالخطأ الذي حدث.

مرجع

نقطة نهاية واحدة، فعلان

POST للإرسال، GET للتحقق من الحالة - نفس عنوان URL ونفس رأس الرمز المميز في كلتا الحالتين.

بريد

يرسل

أرسل رسالة واسترجع رسالة ورمز خطأ على الفور.

المرتجعات msgstr + رمز الخطأ
يحصل

مسار

ابحث عن الرسالة التي أرسلتها بالفعل للتحقق من حالتها الحالية.

المرتجعات الرسالة + الحالة
خطافات الويب

تقارير الحالة، لحظة حدوثها

قم بتعيين عنوان URL لرد الاتصال، وسيصل كل تسليم وفشل ورد وارد إلى هناك على شكل GET أو POST - دون الحاجة إلى استقصاء.

تم التوصيلmsgid 9f2a7c10 · حالة التسليم
الواردةتم استلام الرد · الاتجاه مو
فشلmsgstr 4c81e2 · الحالة فاشلة
نقطة النهاية الخاصة بك200 موافق
ابدأ

احصل على مفتاح API الخاص بك

ابدأ عملية الدمج في دقائق معدودة باستخدام REST API الخاص بنا.

إجابات على أسئلتك

مستندات المطور - الأسئلة المتداولة

قم بتمرير مفتاح الوصول الخاص بك في رأس الرمز المميز في كل طلب - الرمز المميز: {accessKey} - إلى جانب نوع المحتوى: application/json.

كل إرسال يقوم بإرجاع msgid. قم بتوجيهنا إلى عنوان URL لرد الاتصال ونقوم بنشر أو الحصول على تقرير حالة إليه في اللحظة التي تصل فيها الرسالة إلى حالتها النهائية - التاريخ الفرعي والتاريخ المحدد ورمز الحالة الناتج المتضمن.

mt (تم إنهاء الهاتف المحمول) هي الرسالة التي أرسلتها؛ mo (نشأ من الهاتف المحمول) هو الرد الذي تلقيته. كلاهما يستخدم نفس شكل كائن الرسالة.

تتم إعادة محاولة التسليم وفقًا لسياسة إعادة المحاولة - لا يتم إسقاط أي شيء بصمت، ولكن نقطة النهاية التي لا تعترف أبدًا ستستمر في تلقي عمليات إعادة المحاولة.

160 حرفًا بترميز GSM7، أو 70 حرفًا بترميز Unicode. تجاوز الحد الأقصى وتتسلسل الرسالة إلى أجزاء متعددة، تتم فوترة كل منها على حدة.