siipoland/infobip-api-php-client

PHP library for consuming Infobip's API

3.1.11 2024-03-05 13:03 UTC

Requires

• php: >=7.2
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ~6.5.5 || 7.*

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.12

MIT

• Infobip Support
• Patryk Święczkowski
• Marcin Bach

• php
• rest
• api
• sms
• sdk
• whatsapp
• tfa
• 2fa
• msisdn
• openapi
• Infobip

README

This is a PHP Client for Infobip API and you can use it as a dependency to add Infobip APIs to your application. To use this, you'll need an Infobip account. If not already having one, you can create a free trial account here.

Built on top of OpenAPI Specification, powered by OpenAPI Generator.

Table of contents:

• Documentation
• General Info
• Installation
• Quickstart
• Ask for help

Documentation

Infobip API Documentation can be found here.

General Info

For infobip-api-php-client versioning we use Semantic Versioning scheme.

Published under MIT License.

PHP versions

All versions above 7.2

Installation

Using Composer

To start using the library add it as dependecy in your composer.json file like shown below.

"require": {
	"infobip/infobip-api-php-client": "3.0.0"
}

And simply run composer install to download dependencies.

Without Composer

If your setup prevents you from using composer you can manually download this package and all of its dependencies and reference them from your code. However, there are solutions that can automate this process. One of them is php-download online tool. You can use it to find pre-composed infobip client package, download it from there and use in your project without manually collecting the dependencies.

Quickstart

Initialize the Configuration & HTTP client

We support multiple authentication methods, e.g. you can use API Key Header, in this case, API_KEY_PREFIX will be "App".

The API_KEY can be created via the web interface.

To see your URL_BASE_PATH, log in to the Infobip API documentation hub with your Infobip credentials.

    $configuration = (new Configuration())
        ->setHost(URL_BASE_PATH)
        ->setApiKeyPrefix('Authorization', API_KEY_PREFIX)
        ->setApiKey('Authorization', API_KEY);

    $client = new GuzzleHttp\Client();

Send an SMS

Simple example for sending an SMS message.

    $sendSmsApi = new SendSMSApi($client, $configuration);
    $destination = (new SmsDestination())->setTo('41793026727');
    $message = (new SmsTextualMessage())
        ->setFrom('InfoSMS')
        ->setText('This is a dummy SMS message sent using infobip-api-php-client')
        ->setDestinations([$destination]);
    $request = (new SmsAdvancedTextualRequest())
        ->setMessages([$message]);

    try {
        $smsResponse = $sendSmsApi->sendSmsMessage($request);
    } catch (Throwable $apiException) {
        // HANDLE THE EXCEPTION
    }

Fields provided within ApiException object are code referring to the HTTP Code response, as well as the responseHeaders and responseBody. Also, you can get the deserialized response body using getResponseObject method.

    $apiException->getCode();
    $apiException->getResponseHeaders();
    $apiException->getResponseBody();
    $apiException->getResponseObject();

Additionally, you can pull out the bulkId and messageId(s) from SmsResponse object and use them to fetch a delivery report for given message or bulk. Bulk ID will be received only when you send a message to more than one destination address or multiple messages in a single request.

    $bulkId = $smsResponse->getBulkId();
    $messageId = $smsResponse->getMessages()[0]->getMessageId();

Receive SMS message delivery report

For each SMS that you send out, we can send you a message delivery report in real time. All you need to do is specify your endpoint, e.g. https://{yourDomain}/delivery-reports, when sending SMS in notifyUrl field of SmsTextualMessage, or subscribe for reports by contacting our support team.

You can use data models from the library and the pre-configured \Infobip\ObjectSerializer serializer.

Example of webhook implementation:

    use \Infobip\ObjectSerializer;

    $data = file_get_contents("php://input");
    $type = '\Infobip\Model\SmsDeliveryResult';
    $deliveryReports = ObjectSerializer::deserialize($data, $type);

    foreach ($deliveryReports->getResults() as $report) {
        echo $report->getMessageId() . " - " . $report->getStatus()->getName() . "\n";
    }

If you prefer to use your own serializer, please pay attention to the supported date format.

Fetching delivery reports

If you are for any reason unable to receive real time delivery reports on your endpoint, you can use messageId or bulkId to fetch them. Each request will return a batch of delivery reports - only once.

    $numberOfReportsLimit = 10;
    $deliveryReports = $sendSmsApi->getOutboundSmsMessageDeliveryReports($bulkId, $messageId, $numberOfReportsLimit);
    foreach ($deliveryReports->getResults() as $report) {
        echo $report->getMessageId() . " - " . $report->getStatus()->getName() . "\n";
    }

Unicode & SMS preview

Infobip API supports Unicode characters and automatically detects encoding. Unicode and non-standard GSM characters use additional space, avoid unpleasant surprises and check how different message configurations will affect your message text, number of characters and message parts.

    $previewResponse = $sendSmsApi->previewSmsMessage((new SmsPreviewRequest())
        ->setText("Let's see how many characters will remain unused in this message."));
    echo $previewResponse;

Receive incoming SMS

If you want to receive SMS messages from your subscribers we can have them delivered to you in real time. When you buy and configure a number capable of receiving SMS, specify your endpoint as explained here, e.g. https://{yourDomain}/incoming-sms. Example of webhook implementation:

    use \Infobip\ObjectSerializer;

    $data = file_get_contents("php://input");
    $type = '\Infobip\Model\SmsInboundMessageResult';
    $messages = ObjectSerializer::deserialize($data, $type);

    foreach ($messages->getResults() as $message) {
        echo $message-> getFrom() . " - " . $message-> getCleanText() . "\n";
    }

Two-Factor Authentication (2FA)

For 2FA quick start guide please check these examples.

Infobip\SendWhatsappApi

All URIs are relative to http://localhost/whatsapp/1.

sendWhatsappMessage()

sendWhatsappMessage($pi_integrator, $pi_platform, $whatsapp_message): \Infobip\Model\WhatsappResponse

Send whatsapp message.

Sends whatsapp message using predefined whatsapp templates

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Infobip\Api\SendWhatsappApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$pi_integrator = 56; // int
$pi_platform = 'pi_platform_example'; // string
$whatsapp_message = new \Infobip\Model\WhatsappMessage(); // \Infobip\Model\WhatsappMessage

try {
    $result = $apiInstance->sendWhatsappMessage($pi_integrator, $pi_platform, $whatsapp_message);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SendWhatsappApi->sendWhatsappMessage: ', $e->getMessage(), PHP_EOL;
}

Parameters

Return type

\Infobip\Model\WhatsappResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Infobip\WhatsappTemplatesApi

All URIs are relative to http://localhost/whatsapp/1.

getTemplates()

getTemplates($sender): \Infobip\Model\WhatsappTemplateResponse

Get template list.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Infobip\Api\WhatsappTemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$sender = 56; // int | Sender number wit country code

try {
    $result = $apiInstance->getTemplates($sender);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WhatsappTemplatesApi->getTemplates: ', $e->getMessage(), PHP_EOL;
}

Parameters

Return type

\Infobip\Model\WhatsappTemplateResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Ask for help

Feel free to open issues on the repository for any issue or feature request. As per pull requests, for details check the CONTRIBUTING file related to it - in short, we will not merge any pull requests, this code is auto-generated.

If it is, however, something that requires our imminent attention feel free to contact us @ [e-mail].