messagebird/php-rest-api

MessageBird REST API client for PHP

v3.1.4 2023-01-16 19:22 UTC

Requires

• php: >=7.3|~8.0.0|~8.1.0|~8.2.0
• ext-curl: *
• ext-json: *
• firebase/php-jwt: ^5.5.1|^6.2

Requires (Dev)

• phpunit/phpunit: ^9.5.14
• vimeo/psalm: 4.18.1

BSD-2-Clause

• MessageBird

README

This repository contains the open source PHP client for MessageBird's REST API. Documentation can be found at: https://developers.messagebird.com/

Requirements

• Sign up for a free MessageBird account
• Create a new access_key in the developers sections
• MessageBird API client for PHP requires PHP >= 7.3.

Installation

Composer installation

• Download composer
• Run composer require messagebird/php-rest-api.

Manual installation

When you do not use Composer. You can git checkout or download this repository and include the MessageBird API client manually.

Usage

We have put some self-explanatory examples in the examples directory, but here is a quick breakdown on how it works. First, you need to set up a MessageBird\Client. Be sure to replace YOUR_ACCESS_KEY with something real.

require 'autoload.php';

$messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY');

That's easy enough. Now we can query the server for information. Lets use getting your balance overview as an example:

// Get your balance
$balance = $messageBird->balance->read();

Conversations WhatsApp Sandbox

To use the WhatsApp sandbox you need to add \MessageBird\Client::ENABLE_CONVERSATIONSAPI_WHATSAPP_SANDBOX to the list of features you want enabled. Don't forget to replace YOUR_ACCESS_KEY with your actual access key.

$messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY', null, [\MessageBird\Client::ENABLE_CONVERSATIONSAPI_WHATSAPP_SANDBOX]);

If you use a custom HttpClient you will have to manually direct Conversation API request to the WhatsApp sandbox endpoint.

Documentation

Complete documentation, instructions, and examples are available at: https://developers.messagebird.com/

License

The MessageBird REST Client for PHP is licensed under The BSD 2-Clause License. Copyright (c) 2014, MessageBird