https://github.com/messagebird/php-rest-api
This repository contains the open source PHP client for MessageBird's REST API.
https://github.com/messagebird/php-rest-api
Last synced: 5 months ago
JSON representation
This repository contains the open source PHP client for MessageBird's REST API.
- Host: GitHub
- URL: https://github.com/messagebird/php-rest-api
- Owner: messagebird
- License: bsd-2-clause
- Created: 2014-06-30T11:53:04.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2025-07-18T14:35:31.000Z (12 months ago)
- Last Synced: 2025-07-18T19:02:02.020Z (12 months ago)
- Language: PHP
- Homepage: https://developers.messagebird.com/
- Size: 946 KB
- Stars: 158
- Watchers: 16
- Forks: 94
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
MessageBird's REST API for PHP
===============================
This repository contains the open source PHP client for MessageBird's REST API. Documentation can be found at: https://developers.messagebird.com/
[](https://github.com/messagebird/php-rest-api/actions/workflows/tests.yml?query=branch%3Amaster)
[](https://packagist.org/packages/messagebird/php-rest-api)
[](https://packagist.org/packages/messagebird/php-rest-api)
Requirements
-----
- [Sign up](https://www.messagebird.com/en/signup) 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](https://getcomposer.org/doc/00-intro.md#installation-nix)
- Run `composer require messagebird/php-rest-api`.
#### Manual installation
When you do not use Composer. You can git checkout or download [this repository](https://github.com/messagebird/php-rest-api/archive/master.zip) 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.
```php
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:
```php
// 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.
```php
$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/](https://developers.messagebird.com/)
License
----
The MessageBird REST Client for PHP is licensed under [The BSD 2-Clause License](http://opensource.org/licenses/BSD-2-Clause). Copyright (c) 2014, MessageBird