smsglobal php

smsglobal php 클라이언트 라이브러리

PHP용 SMSGlobal REST API 및 라이브러리

이것은 SMS 기능을 PHP 애플리케이션에 통합하기 위한 SMSGlobal의 REST API용 PHP 클라이언트 라이브러리입니다.

지금 무료 SMSGlobal 계정에 가입하고 고급 SMS 플랫폼인 MXT에서 API 키를 받으세요. 또한 무제한 무료 개발자 샌드박스 테스트를 통해 API 전체를 시험해 보세요!

요구사항

• PHP 7.3 이상
• Guzzle7(PHP HTTP 클라이언트)

설치

프로젝트에 PHP 클라이언트 라이브러리를 설치하려면 Composer를 사용하는 것이 좋습니다.

composer require smsglobal/smsglobal-php

용법

examples 폴더를 확인하세요

SMS 보내기

 <?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 ();
}

OTP 보내기

 <?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가 아직 만료 및 인증되지 않은 경우 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 리소스

• SMS
• SMS 수신
• OTP(베타)
• 사용자

단위 테스트

개발 종속성 설치

composer require smsglobal/smsglobal-php

단위 테스트 실행

./vendor/bin/phpunit tests

적용 범위 포함(확장 pcov 또는 xdebug 필요)

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

도움 받기

사용 가능한 리소스 목록은 REST API 설명서를 참조하세요.

문의사항이 있으시면 저희에게 연락해주세요.