https://github.com/smsgateway24/smsgateway24-php-sdk
smsgateway24-php-sdk
https://github.com/smsgateway24/smsgateway24-php-sdk
php-library php-sdk sms
Last synced: 4 months ago
JSON representation
smsgateway24-php-sdk
- Host: GitHub
- URL: https://github.com/smsgateway24/smsgateway24-php-sdk
- Owner: smsgateway24
- License: mit
- Created: 2020-05-29T10:47:24.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-12T09:28:37.000Z (about 3 years ago)
- Last Synced: 2025-10-12T02:34:40.445Z (6 months ago)
- Topics: php-library, php-sdk, sms
- Language: PHP
- Homepage:
- Size: 44.9 KB
- Stars: 9
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SmsGateWay24
SmsGateWay24 is a service that can turn you android phone to gateway and you can start sending messages throw it.
## PHP SDK
PHP library for SmsGateWay24 API interaction.
Requires:
* PHP 7.1+
Here's a demo of how you can use it:
```php
use \SmsGateway24\SmsGateway24;
$gateway = new SmsGateway24('your-api-token-here'); // get it in your profile
$to = "+4915752982212"; //required. Target Phone number
$message = "Hello, how are you?"; // required. Body Message.
$deviceId = 10403; //required. get it in your profile after app installation on your android
$sim=0; // Optional. 0 or 1. For Dual SIM devices. (if you skip it -> default sim is 0)
$timeToSend = "2022-01-12 00:00:00"; // Optional. time when you want to send SMS
$customerid = 12; // Optional. your internal customer ID.
$urgent = 1; // Optional. 1 or 0 to make sms Urgent.
$smsId = $gateway->addSms($to, $message, $deviceId, $timeToSend, $sim, $customerid, $urgent);
```
After that, the phone with the Smsgateway24 application calls the server and takes the SMS and sends it from your sim card.
### Getting Started
Visit our [website](https://smsgateway24.com/), sign up and install app on your phone. Get your API token and device id.
Install the package via composer:
```bash
composer require smsgateway24/smsgateway24-php-sdk
```
### API Methods
#### Add SMS to queue
Creates SMS on the server to send.
```php
use \SmsGateway24\SmsGateway24;
$gateway = new SmsGateway24('your-api-token-here'); // get it in your profile
$to = "+4915752982212"; //required. Target Phone number
$message = "Hello, how are you?"; // required. Body Message.
$deviceId = 10403; //required. get it in your profile after app installation on your android
$sim=0; // Optional. 0 or 1. For Dual SIM devices. (if you skip it -> default sim is 0)
$timeToSend = "2022-01-12 00:00:00"; // Optional. time when you want to send SMS
$customerid = 12; // Optional. your internal customer ID.
$urgent = 1; // Optional. 1 or 0 to make sms Urgent.
$smsId = $gateway->addSms($to, $message, $deviceId, $timeToSend, $sim, $customerid, $urgent);
echo $smsId;
```
#### Get SMS status
You can find out the status of each SMS using this method
```php
use \SmsGateway24\SmsGateway24;
$gateway = new SmsGateway24('your-api-token-here'); // get it in your profile
$smsId = 12345;
$statusResult = $gateway->getSmsStatus($smsId);
print_r($statusResult);
/*
Statuses values:
1 - New (just created)
2 - Taken from Server. The phone picked up the SMS from the server, but there is no information about the delivery yet.
5 - Income.
6 - Sent by Phone. Good status. The phone sent a text message. But there is no information about the delivery yet.
7 - Delivered. Good status. The phone texted and it was 100% delivered by the operator. The delivery status was sent to the server. (You need a webhook to your server - we have one! Write your server in the device settings on the website)
8 - Sms Not Delivered. The text message was not delivered. This usually means that the SIM card is blocked or the balance is negative
9 - Not SENT - Generic failure. The text message was not delivered. This usually means that the SIM card is blocked or the balance is negative
10 - Not sent - No service.
11 - Not Sent - Null PD.
12 - Not Sent - Radio off.
100 - not sent - NOT ALLOWED. Click the permission button in the app
101 - not sent - Not Allowed At all. Click the permission button in the app
*/
```
#### Get device status
```php
use \SmsGateway24\SmsGateway24;
$gateway = new SmsGateway24('your-api-token-here'); // get it in your profile
$deviceId = 12345; // get it in your profile
$statusResult = $gateway->getDeviceStatus($deviceId);
print_r($statusResult);
```
#### Add Tag
Add contacts for any tag. For example, for the tag * Employees * your colleagues will perfectly fit.
```php
use \SmsGateway24\SmsGateway24;
$gateway = new SmsGateway24('your-api-token-here'); // get it in your profile
$tagId = $gateway->saveTag("Rich customers");
echo $tagId;
```
#### Save Contact
Add contacts for any tag. For example, for the tag * Employees * your colleagues will perfectly fit.
```php
use \SmsGateway24\SmsGateway24;
$gateway = new SmsGateway24('your-api-token-here'); // get it in your profile
$contactName = 'Support SmsGateWay24';
$phoneNum = '+4915752982212';
$tagId = 2456;
$contactId = $gateway->saveContact($contactName, $phoneNum, $tagId);
echo $contactId;
```
#### Create a Newsletter
Once you have created the tag, you can do the mailing on the tag phones.
```php
use \SmsGateway24\SmsGateway24;
$gateway = new SmsGateway24('your-api-token-here'); // get it in your profile
$paketTitle = 'some title';
$deviceId = 1234; // get it in your profile
$body = 'body text';
$tags = [12, 13, 14]; // ids
$paketId = $gateway->savePaket($paketTitle, $deviceId, $body, $tags);
echo $paketId;
```
## Contributing
Contributions are welcome!
## Credits
* [Igor](https://github.com/underwear/)
* [Nik](https://github.com/nikitospush/)