prihod/terasms-client

PHP client for terasms.ru API

v1.0.0 2024-11-05 16:10 UTC

Requires

• php: >=7.4
• ext-json: *
• guzzlehttp/guzzle: ^7.0
• symfony/deprecation-contracts: ^2.2

Requires (Dev)

• phpunit/phpunit: ^9.5
• squizlabs/php_codesniffer: ^3.7

MIT

• Prihod

• php
• api
• API-Client
• terasms.ru

README

This is client library for the terasms.ru API.

1. Prerequisites

• PHP 7.4 or later

2. Installation

The terasms-client client can be installed using Composer by running the following command:

composer require prihod/terasms-client

3. Initialization

Create Client object using the following code:

<?php

use TeraSMS\Client;

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

$login = 'user';
$token = '2LsWvGkYYOjyPw3GWbp5L';
$client = new Client($login,$token );

4. API Requests

4.1. Request get Balance

use TeraSMS\Exception\RequestException;
use TeraSMS\Request\BalanceRequest;

try {
    $request = new BalanceRequest();
    $response = $client->execute($request);

    if ($response->isSuccess()) {
        echo "Response to array:\n";
        print_r($response->toArray());
        echo "Response get data:\n";
        print_r($response->getData());
    } else {
        echo "Response Status: {$response->getStatus()}";
        echo "Response Error: {$response->getError()}";
    }
} catch (RequestException $e) {
    echo "Exception: {$e->getMessage()}\n";
    print_r($e->request->toArray());
}

4.2. Request to send SMS

use TeraSMS\Client;
use TeraSMS\Exception\RequestException;
use TeraSMS\Request\SMSRequest;

try {
    $request = (new SMSRequest())
        ->setPhone('71234567890')
        ->setSender('SMSTest')
        ->setMessage('Message text to be sent via SMS');

    $response = $client->execute($request);
    if ($response->isSuccess()) {
        echo "Response to array:\n";
        print_r($response->toArray());
        echo "Response get data:\n";
        print_r($response->getData());
        echo "Response get all entries:\n";
        print_r($response->getEntries());
        echo "Response get first entry:\n";
        $entry = $response->getFirstEntry();
        if ($entry->isSuccess()) {
            echo "Entry to array:\n";
            print_r($entry->toArray());
            echo "Entry get data:\n";
            print_r($entry->getData());
        } else {
            echo "Entry Status: {$entry->getStatus()}";
            echo "Entry Error: {$entry->getError()}";
        }
    } else {
        echo "Response Status: {$response->getStatus()}";
        echo "Response Error: {$response->getError()}";
    }
} catch (RequestException $e) {
    echo "Exception: {$e->getMessage()}\n";
    print_r($e->request->toArray());
}

4.3. Multiple SMS sending request

use TeraSMS\Request\MultiSMSRequest;
use TeraSMS\Request\SMSRequest;


 $request1 = (new SMSRequest())
        ->setId(1232)
        ->setPhone('71234567890')
        ->setSender('SMSTest')
        ->setMessage('Message text to be sent via SMS1');

    $request2 = (new SMSRequest())
        ->setId(1233)
        ->setPhone('71234567891')
        ->setSender('SMSTest')
        ->setMessage('Message text to be sent via SMS2');

    $multiRequest = (new MultiSMSRequest())
        ->append($request1)
        ->append($request2);

$response = $client->execute($requests);
...

4.4. Request status message for SMS, Viber, VK, «каскад»

use TeraSMS\Request\StatusRequest;

 $request = new StatusRequest([12323, 23262, 23264]);
   /**
    $request = (new StatusRequest())
        ->setMessageIds([12323, 23262, 23264]);

    $request = (new StatusRequest())
        ->appendMessageId(12323)
        ->appendMessageId(23262)
        ->appendMessageId(23264);

    $request = (new StatusRequest())
        ->setMessageIds([12323, 23262, 23264]);
   */

$response = $client->execute($request);
...

4.5. Request to send a message to Viber

use TeraSMS\Request\ViberRequest;

$request = (new ViberRequest())
        ->setPhone('71234567890')
        ->setSender('ViberTest')
        ->setMessage('Message text to be sent via Viber')
        ->setImage('https://terasms.ru/logo.jpg')
        ->setLink('https://terasms.ru/')
        ->setButtonText('Text');

$response = $client->execute($request);
...

4.6. Multiple Viber sending request

use TeraSMS\Request\MultiViberRequest;
use TeraSMS\Request\ViberRequest;

$request1 = (new ViberRequest())
        ->setPhone('71234567890')
        ->setSender('ViberTest')
        ->setMessage('Message text to be sent via Viber')
        ->setImage('https://terasms.ru/logo.jpg')
        ->setLink('https://terasms.ru/')
        ->setButtonText('Text');

    $request2 = (new ViberRequest())
        ->setPhone('71234567891')
        ->setSender('ViberTest')
        ->setMessage('Message text to be sent via Viber')
        ->setImage('https://terasms.ru/logo.jpg')
        ->setLink('https://terasms.ru/')
        ->setButtonText('Text');

    $multiRequest = (new MultiViberRequest())
        ->append($request1)
        ->append($request2);

$response = $client->execute($request);
...

4.7. Request to send Vk

use TeraSMS\Request\VkRequest;

 $request = (new VkRequest())
        ->setPhone('71234567890')
        ->setSender('VkTest')
        ->setMessage('Message text to be sent via Vk');

$response = $client->execute($request);
...

4.8. Request to send WhatsApp

use TeraSMS\Request\WhatsAppRequest;

   $request = (new WhatsAppRequest())
        ->setPhone('71234567890')
        ->setSender('WhatsAppTest')
        ->setMessage('Message text to be sent via WhatsApp');

$response = $client->execute($request);
...

4.9. Request to send Cascade

use TeraSMS\Request\CascadeRequest;

   $request = (new CascadeRequest())
        ->setPhone('71234567890')
        ->setSender('CascadeTest')
        ->setMessage('Message text to be sent via Cascade');

$response = $client->execute($request);
...

4.10. Request to send Flash Call (Call Password)

use TeraSMS\Request\VoiceOTPRequest;

   $request = (new VoiceOTPRequest())
        ->setCode(2345)
        ->setPhone('71234567890')
        ->setSender('VoiceOTPTest');

$response = $client->execute($request);
...

5. Links

• API docs