Skip to content

Latest commit

 

History

History
228 lines (171 loc) · 9.56 KB

README.md

File metadata and controls

228 lines (171 loc) · 9.56 KB
Raw

Infobip API PHP Client

Packagist MIT License

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.

infobip-api-php-client is built on top of OpenAPI Specification, generated by Infobip OSCAR service powered by OpenAPI Generator.

Infobip

Table of contents:

Documentation

Detailed documentation about Infobip API can be found here. The current version of this library includes this subset of Infobip products:

General Info

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

Published under MIT License.

The library requires PHP version >= 8.0.

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": "5.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

The library supports the API Key Header authentication method. Once you have an Infobip account, you can manage your API keys through the Infobip API key management page.

To see your base URL, log in to the Infobip API Resource hub with your Infobip credentials or visit your Infobip account.

    use Infobip\Configuration;

    $configuration = new Configuration(
        host: 'your-base-url',
        apiKey: 'your-api-key'
    );

Send an SMS

See below, a simple example of sending a single SMS message to a single recipient.

    use Infobip\ApiException;
    use Infobip\Model\SmsAdvancedTextualRequest;
    use Infobip\Model\SmsDestination;
    use Infobip\Model\SmsTextualMessage;

    $sendSmsApi = new SmsApi(config: $configuration);

    $message = new SmsTextualMessage(
        destinations: [
            new SmsDestination(to: '41793026727')
        ],
        from: 'InfoSMS',
        text: 'This is a dummy SMS message sent using infobip-api-php-client'
    );

    $request = new SmsAdvancedTextualRequest(messages: [$message]);

    try {
        $smsResponse = $sendSmsApi->sendSmsMessage($request);
    } catch (ApiException $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 retrieve a bulkId and a messageId from the SmsResponse object to use for troubleshooting or fetching a delivery report for a given message or a 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();
    $messages = $smsResponse->getMessages();
    $messageId = (!empty($messages)) ? current($messages)->getMessageId() : null;

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 when sending SMS in the notifyUrl field within SmsTextualMessage, or subscribe for reports by contacting our support team at [email protected].

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

Example of webhook implementation:

    use Infobip\Model\SmsReportResponse;
    use Infobip\ObjectSerializer;

    $objectSerializer = new ObjectSerializer();

    $data = \file_get_contents('php://input');

    /**
     * @var SmsReportResponse $deliveryResult
     */
    $deliveryResult = $objectSerializer->deserialize($data, SmsReportResponse::class);

    foreach ($deliveryResult->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. See documentation for more details.

    $deliveryReports = $sendSmsApi
        ->getOutboundSmsMessageDeliveryReports(
            bulkId: 'some-bulk-id',
            messageId: 'some-message-id',
            limit: 10
        );

    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.

    use Infobip\Model\SmsPreviewRequest;

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

    foreach ($previewResponse->getPreviews() ?? [] as $preview) {
        echo sprintf(
            'Characters remaining: %s, text preview: %s',
            $preview->getCharactersRemaining(),
            $preview->getTextPreview()
        ) . PHP_EOL;
    }

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 in documentation. e.g. https://{yourDomain}/incoming-sms. Example of webhook implementation:

    use Infobip\ObjectSerializer;
    use Infobip\Model\SmsInboundMessageResult;

    $objectSerializer = new ObjectSerializer();

    $data = \file_get_contents('php://input');

    /**
     * @var SmsInboundMessageResult $messages
     */
    $messages = $objectSerializer->deserialize($data, SmsInboundMessageResult::class);

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

Two-Factor Authentication (2FA)

For 2FA quick start guide please check these examples.

Send email

For send email quick start guide please check these examples.

WhatsApp

For WhatsApp quick start guide, view these examples.

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.

This code is auto generated, and we are unable to merge any pull request from here, but we will review and implement changes directly within our pipeline, as described in the CONTRIBUTING file.

For anything that requires our imminent attention, contact us @ [email protected].