smsglobal php

مكتبة عملاء smsglobal php

SMSGlobal REST API والمكتبات لـ PHP

هذه مكتبة PHP Client لـ REST API الخاصة بـ SMSGlobal لدمج إمكانيات الرسائل القصيرة في تطبيق PHP الخاص بك.

قم بالتسجيل للحصول على حساب SMSGlobal مجاني اليوم واحصل على مفتاح API الخاص بك من منصة الرسائل القصيرة المتقدمة لدينا، MXT. بالإضافة إلى ذلك، استمتع باختبارات مجانية غير محدودة لوضع الحماية للمطورين لتجربة واجهة برمجة التطبيقات (API) الخاصة بك بالكامل!

متطلبات

• PHP 7.3 وما فوق
• Guzzle7 (عميل PHP HTTP)

تثبيت

لتثبيت مكتبة عميل PHP على مشروعك، نوصي باستخدام Composer.

composer require smsglobal/smsglobal-php

الاستخدام

تحقق من مجلد examples

إرسال الرسائل القصيرة

 <?php

require_once __DIR__ . ' /vendor/autoload.php ' ;

// get your REST API keys from MXT https://mxt.smsglobal.com/integrations
 SMSGlobal Credentials:: set ( ' YOUR_API_KEY ' , ' YOUR_SECRET_KEY ' );

$ sms = new  SMSGlobal  Resource  Sms ();

try {
    $ response = $ sms -> sendToOne ( ' DESTINATION_NUMBER ' , ' This is a test message. ' );
    print_r ( $ response [ ' messages ' ]);
} catch (  Exception $ e ) {
    echo $ e -> getMessage ();
}

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

 <?php

require_once __DIR__ . ' /vendor/autoload.php ' ;

// get your REST API keys from MXT https://mxt.smsglobal.com/integrations
 SMSGlobal Credentials:: set ( ' YOUR_API_KEY ' , ' YOUR_SECRET_KEY ' );

$ otp = new  SMSGlobal  Resource  Otp ();

try {
    $ response = $ otp -> send ( ' DESTINATION_NUMBER ' , ' {*code*} is your SMSGlobal verification code. ' );
    print_r ( $ response );
} catch (  Exception $ e ) {
    echo $ e -> getMessage ();
}

سيتم إرجاع استجابة json التالية بواسطة الخادم:

{
    "requestId" : " 404372541683674336263499 " ,
    "validUnitlTimestamp" : " 2020-11-18 16:24:51 " ,
    "createdTimestamp" : " 2020-11-18 16:22:51 " ,
    "lastEventTimestamp" : " 2020-11-18 16:22:51 " ,
    "destination" : " 61400000000 " ,
    "status" : " Sent "
}

التحقق من كلمة المرور لمرة واحدة (OTP).

يمكن التحقق من رمز OTP الذي أدخله المستخدم الخاص بك إما باستخدام requestId أو destination number . وفيما يلي أمثلة على كل طريقة:

 <?php


require_once __DIR__ . ' /vendor/autoload.php ' ;

// get your REST API keys from MXT https://mxt.smsglobal.com/integrations
 SMSGlobal Credentials:: set ( ' YOUR_API_KEY ' , ' YOUR_SECRET_KEY ' );

$ otp = new  SMSGlobal  Resource  Otp ();

try {
    $ response = $ otp -> verifyByRequestId ( ' request Id ' , ' OTP code enterted by your user. ' );
    print_r ( $ response );
} catch (  Exception $ e ) {
    echo $ e -> getMessage ();
}

 <?php

require_once __DIR__ . ' /vendor/autoload.php ' ;

// get your REST API keys from MXT https://mxt.smsglobal.com/integrations
 SMSGlobal Credentials:: set ( ' YOUR_API_KEY ' , ' YOUR_SECRET_KEY ' );

$ otp = new  SMSGlobal  Resource  Otp ();

try {
    $ response = $ otp -> verifyByDestination ( ' destination number ' , ' OTP code enterted by your user. ' );
    print_r ( $ response );
} catch (  Exception $ e ) {
    echo $ e -> getMessage ();
}

سيتم إرجاع استجابة json التالية بواسطة الخادم إذا تم التحقق بنجاح:

{
    "requestId" : " 404372541683674336263499 " ,
    "validUnitlTimestamp" : " 2020-11-18 16:24:51 " ,
    "createdTimestamp" : " 2020-11-18 16:22:51 " ,
    "lastEventTimestamp" : " 2020-11-18 16:22:51 " ,
    "destination" : " 61400000000 " ,
    "status" : " Verified "
}

إلغاء كلمة المرور لمرة واحدة

يمكن إلغاء طلب OTP إذا لم تنته صلاحية كلمة المرور لمرة واحدة (OTP) ولم يتم التحقق منها بعد. ويمكن القيام بذلك إما باستخدام requestId أو destination number . وفيما يلي أمثلة على كل طريقة:

 require_once __DIR__ . ' /vendor/autoload.php ' ;

// get your REST API keys from MXT https://mxt.smsglobal.com/integrations
 SMSGlobal Credentials:: set ( ' YOUR_API_KEY ' , ' YOUR_SECRET_KEY ' );

$ otp = new  SMSGlobal  Resource  Otp ();

try {
    $ response = $ otp -> cancelByRequestId ( ' request Id ' );
    print_r ( $ response );
} catch (  Exception $ e ) {
    echo $ e -> getMessage ();
}

 require_once __DIR__ . ' /vendor/autoload.php ' ;

// get your REST API keys from MXT https://mxt.smsglobal.com/integrations
 SMSGlobal Credentials:: set ( ' YOUR_API_KEY ' , ' YOUR_SECRET_KEY ' );

$ otp = new  SMSGlobal  Resource  Otp ();

try {
    $ response = $ otp -> cancelByDestination ( ' destination number ' );
    print_r ( $ response );
} catch (  Exception $ e ) {
    echo $ e -> getMessage ();
}

سيتم إرجاع استجابة json التالية بواسطة الخادم إذا تم الإلغاء بنجاح:

{
    "requestId" : " 404372541683674336263499 " ,
    "validUnitlTimestamp" : " 2020-11-18 16:24:51 " ,
    "createdTimestamp" : " 2020-11-18 16:22:51 " ,
    "lastEventTimestamp" : " 2020-11-18 16:22:51 " ,
    "destination" : " 61400000000 " ,
    "status" : " Cancelled "
}

موارد REST API المتاحة

• رسالة قصيرة
• الرسائل القصيرة الواردة
• كلمة مرور لمرة واحدة (تجريبية)
• مستخدم

اختبارات الوحدة

تثبيت تبعيات التطوير

composer require smsglobal/smsglobal-php

تشغيل اختبارات الوحدة

./vendor/bin/phpunit tests

مع التغطية (يتطلب ملحق pcov أو xdebug)

./vendor/bin/phpunit --coverage-text tests

الحصول على المساعدة

اعرض وثائق REST API للحصول على قائمة بالموارد المتاحة.

لأي استفسار اتصل بنا