├── src
    └── MessageBird
    │   ├── Exceptions
    │       ├── HttpException.php
    │       ├── BalanceException.php
    │       ├── RequestException.php
    │       ├── ServerException.php
    │       ├── ValidationException.php
    │       ├── AuthenticateException.php
    │       └── MessageBirdException.php
    │   ├── Objects
    │       ├── PartnerAccount
    │       │   ├── AccessKey.php
    │       │   └── Account.php
    │       ├── Conversation
    │       │   ├── HSM
    │       │   │   ├── Currency.php
    │       │   │   ├── Params.php
    │       │   │   ├── Message.php
    │       │   │   └── Language.php
    │       │   ├── MessageReference.php
    │       │   ├── SendMessageResult.php
    │       │   ├── Fallback.php
    │       │   ├── Contact.php
    │       │   ├── SendMessage.php
    │       │   ├── Channel.php
    │       │   ├── Webhook.php
    │       │   ├── Content.php
    │       │   ├── Message.php
    │       │   └── Conversation.php
    │       ├── Voice
    │       │   ├── BaseList.php
    │       │   ├── Step.php
    │       │   ├── Webhook.php
    │       │   ├── Transcription.php
    │       │   ├── Recording.php
    │       │   ├── CallFlow.php
    │       │   ├── Call.php
    │       │   └── Leg.php
    │       ├── BaseList.php
    │       ├── Balance.php
    │       ├── NumberPurchaseRequest.php
    │       ├── Base.php
    │       ├── Number.php
    │       ├── EmailMessage.php
    │       ├── Recipients.php
    │       ├── Group.php
    │       ├── Recipient.php
    │       ├── Hlr.php
    │       ├── Verify.php
    │       ├── MmsMessage.php
    │       ├── MessageResponse.php
    │       ├── SignedRequest.php
    │       ├── Lookup.php
    │       ├── VoiceMessage.php
    │       ├── Contact.php
    │       └── Message.php
    │   ├── Common
    │       ├── Authentication.php
    │       └── ResponseError.php
    │   └── Resources
    │       ├── Conversation
    │           ├── Contacts.php
    │           ├── Content.php
    │           ├── Webhooks.php
    │           ├── Send.php
    │           └── Conversations.php
    │       ├── Hlr.php
    │       ├── Balance.php
    │       ├── MmsMessages.php
    │       ├── Voice
    │           ├── Calls.php
    │           ├── Webhooks.php
    │           ├── CallFlows.php
    │           ├── Base.php
    │           ├── Legs.php
    │           └── Recordings.php
    │       ├── VoiceMessage.php
    │       ├── EmailMessage.php
    │       ├── Messages.php
    │       ├── Verify.php
    │       ├── Lookup.php
    │       ├── PhoneNumbers.php
    │       ├── AvailablePhoneNumbers.php
    │       ├── LookupHlr.php
    │       ├── Contacts.php
    │       ├── PartnerAccount
    │           └── Accounts.php
    │       └── Groups.php
├── examples
    ├── voice-calls-list.php
    ├── voice-webhooks-list.php
    ├── voice-call-flows-list.php
    ├── voice-calls-read.php
    ├── voice-webhooks-read.php
    ├── conversations
    │   ├── message-read.php
    │   ├── webhooks-delete.php
    │   ├── webhooks-list.php
    │   ├── messages-list.php
    │   ├── webhooks-read.php
    │   ├── list.php
    │   ├── read.php
    │   ├── update.php
    │   ├── create.php
    │   ├── messages-create-location.php
    │   ├── messages-create-text.php
    │   ├── send.php
    │   ├── messages-create-media.php
    │   ├── enable-whatsapp-sandbox.php
    │   ├── webhooks-create.php
    │   └── create-hsm.php
    ├── voice-call-flows-read.php
    ├── voice-webhooks-delete.php
    ├── voice-call-flows-delete.php
    ├── voice-legs-list.php
    ├── voice-legs-read.php
    ├── balance-view.php
    ├── group-list.php
    ├── voice-call-flows-update.php
    ├── contact-list.php
    ├── hlr-list.php
    ├── mms-list.php
    ├── phone-numbers-view.php
    ├── group-view.php
    ├── partner-account-read.php
    ├── group-get-contacts.php
    ├── partner-account-delete.php
    ├── partner-account-list.php
    ├── voice-recordings-list.php
    ├── contact-get-groups.php
    ├── group-delete.php
    ├── message-list.php
    ├── mms-view.php
    ├── phone-numbers-delete.php
    ├── voice-webhooks-create.php
    ├── contact-get-messages.php
    ├── voice-recordings-read.php
    ├── contact-view.php
    ├── hlr-view.php
    ├── available-phone-numbers-view.php
    ├── contact-delete.php
    ├── verify-view.php
    ├── voicemessages-list.php
    ├── message-view.php
    ├── message-delete.php
    ├── voice-transcriptions-read.php
    ├── voice-webhooks-update.php
    ├── voice-transcriptions-list.php
    ├── voice-transcriptions-create.php
    ├── voicemessages-view.php
    ├── lookup-view.php
    ├── emailmessages-view.php
    ├── group-create.php
    ├── group-update.php
    ├── phone-numbers-update.php
    ├── group-remove-contact-from-group.php
    ├── partner-account-create.php
    ├── partner-account-update.php
    ├── group-add-contact-to-group.php
    ├── mms-delete.php
    ├── signedrequest-verification.php
    ├── voice-transcriptions-download.php
    ├── voice-call-flows-create.php
    ├── verify-verification.php
    ├── voice-recordings-download.php
    ├── phone-numbers-create.php
    ├── hlr-create.php
    ├── contact-update.php
    ├── contact-create.php
    ├── voice-calls-create.php
    ├── message-create.php
    ├── verify-create.php
    ├── message-create-unicode.php
    ├── signed-request-validation.php
    ├── mms-create.php
    ├── lookup-hlr-view.php
    ├── voicemessages-create.php
    └── verify-create-email.php
├── psalm.xml
├── composer.json
├── autoload.php
├── LICENSE
└── README.md


/src/MessageBird/Exceptions/HttpException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Exceptions;
 4 | 
 5 | /**
 6 |  * Class HttpException
 7 |  *
 8 |  * @package MessageBird\Exceptions
 9 |  */
10 | class HttpException extends MessageBirdException
11 | {
12 | }
13 | 


--------------------------------------------------------------------------------
/src/MessageBird/Exceptions/BalanceException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Exceptions;
 4 | 
 5 | /**
 6 |  * Class BalanceException
 7 |  *
 8 |  * @package MessageBird\Exceptions
 9 |  */
10 | class BalanceException extends MessageBirdException
11 | {
12 | }
13 | 


--------------------------------------------------------------------------------
/src/MessageBird/Exceptions/RequestException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Exceptions;
 4 | 
 5 | /**
 6 |  * Class RequestException
 7 |  *
 8 |  * @package MessageBird\Exceptions
 9 |  */
10 | class RequestException extends MessageBirdException
11 | {
12 | }
13 | 


--------------------------------------------------------------------------------
/src/MessageBird/Exceptions/ServerException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Exceptions;
 4 | 
 5 | /**
 6 |  * Class ServerException
 7 |  *
 8 |  * @package MessageBird\Exceptions
 9 |  */
10 | class ServerException extends MessageBirdException
11 | {
12 | }
13 | 


--------------------------------------------------------------------------------
/src/MessageBird/Exceptions/ValidationException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Exceptions;
 4 | 
 5 | /**
 6 |  * Class ValidationException
 7 |  *
 8 |  * @package MessageBird\Exceptions
 9 |  */
10 | class ValidationException extends MessageBirdException
11 | {
12 | }
13 | 


--------------------------------------------------------------------------------
/src/MessageBird/Exceptions/AuthenticateException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Exceptions;
 4 | 
 5 | /**
 6 |  * Class AuthenticateException
 7 |  *
 8 |  * @package MessageBird\Exceptions
 9 |  */
10 | class AuthenticateException extends MessageBirdException
11 | {
12 | }
13 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/PartnerAccount/AccessKey.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Objects\PartnerAccount;
 4 | 
 5 | use MessageBird\Objects\Base;
 6 | 
 7 | class AccessKey extends Base
 8 | {
 9 |     public $id;
10 | 
11 |     public $key;
12 | 
13 |     public $mode;
14 | }
15 | 


--------------------------------------------------------------------------------
/src/MessageBird/Exceptions/MessageBirdException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Exceptions;
 4 | 
 5 | use Exception;
 6 | 
 7 | /**
 8 |  * Class MessageBirdException
 9 |  *
10 |  * @package MessageBird\Exceptions
11 |  */
12 | abstract class MessageBirdException extends Exception
13 | {
14 | }
15 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Conversation/HSM/Currency.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Objects\Conversation\HSM;
 4 | 
 5 | class Currency
 6 | {
 7 |     /**
 8 |      * @var string $code
 9 |      */
10 |     public $code;
11 | 
12 |     /**
13 |      * @var int $amount
14 |      */
15 |     public $amount;
16 | }
17 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Voice/BaseList.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Objects\Voice;
 4 | 
 5 | use MessageBird\Objects\Base;
 6 | 
 7 | /**
 8 |  * Class BaseList
 9 |  *
10 |  * @package MessageBird\Objects\Voice
11 |  */
12 | class BaseList extends Base
13 | {
14 |     public $totalCount;
15 |     public $pageCount;
16 |     public $currentPage;
17 |     public $perPage;
18 | 
19 |     public $items = [];
20 | }
21 | 


--------------------------------------------------------------------------------
/examples/voice-calls-list.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $result = $messageBird->voiceCalls->getList(['offset' => 100, 'limit' => 30]);
 9 |     var_dump($result);
10 | } catch (\Exception $e) {
11 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
12 | }
13 | 


--------------------------------------------------------------------------------
/src/MessageBird/Common/Authentication.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Common;
 4 | 
 5 | /**
 6 |  * Class Authentication
 7 |  *
 8 |  * @package MessageBird\Common
 9 |  */
10 | class Authentication
11 | {
12 |     public $accessKey;
13 | 
14 |     /**
15 |      * @param mixed $accessKey
16 |      */
17 |     public function __construct($accessKey)
18 |     {
19 |         $this->accessKey = $accessKey;
20 |     }
21 | }
22 | 


--------------------------------------------------------------------------------
/examples/voice-webhooks-list.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $result = $messageBird->voiceWebhooks->getList(['offset' => 100, 'limit' => 30]);
 9 |     var_dump($result);
10 | } catch (\Exception $e) {
11 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
12 | }
13 | 


--------------------------------------------------------------------------------
/examples/voice-call-flows-list.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $result = $messageBird->voiceCallFlows->getList(['offset' => 100, 'limit' => 30]);
 9 |     var_dump($result);
10 | } catch (\Exception $e) {
11 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
12 | }
13 | 


--------------------------------------------------------------------------------
/examples/voice-calls-read.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $result = $messageBird->voiceCalls->read('dbf1373c-6781-43c7-bfe4-6538583c444b'); // Set a call id here
 9 |     var_dump($result);
10 | } catch (\Exception $e) {
11 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
12 | }
13 | 


--------------------------------------------------------------------------------
/examples/voice-webhooks-read.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $result = $messageBird->voiceWebhooks->read('e5f56d49-4fa2-4802-895d-b0a306f73f76'); // Set a webhook id here
 9 |     var_dump($result);
10 | } catch (\Exception $e) {
11 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
12 | }
13 | 


--------------------------------------------------------------------------------
/examples/conversations/message-read.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | // Retrieves a message.
 4 | 
 5 | require(__DIR__ . '/../../autoload.php');
 6 | 
 7 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 8 | 
 9 | try {
10 |     $message = $messageBird->conversationMessages->read('YOUR MESSAGE ID');
11 | 
12 |     var_dump($message);
13 | } catch (\Exception $e) {
14 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
15 | }
16 | 


--------------------------------------------------------------------------------
/examples/voice-call-flows-read.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $result = $messageBird->voiceCallFlows->read('f24dd28c-90da-4ed6-af92-d8e32a0e5f55'); // Set a call flow id here
 9 |     var_dump($result);
10 | } catch (\Exception $e) {
11 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
12 | }
13 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Conversation/HSM/Params.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Objects\Conversation\HSM;
 4 | 
 5 | class Params
 6 | {
 7 |     /**
 8 |      * @var string $default
 9 |      */
10 |     public $default;
11 | 
12 |     /**
13 |      * @var Currency $currency
14 |      */
15 |     public $currency;
16 | 
17 |     /**
18 |      * Date formatted as RFC3339
19 |      *
20 |      * @var string $dateTime
21 |      */
22 |     public $dateTime;
23 | }
24 | 


--------------------------------------------------------------------------------
/src/MessageBird/Resources/Conversation/Contacts.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Resources\Conversation;
 4 | 
 5 | use MessageBird\Common\HttpClient;
 6 | use MessageBird\Objects\Conversation\Contact;
 7 | use MessageBird\Resources\Base;
 8 | 
 9 | class Contacts extends Base
10 | {
11 |     public function __construct(HttpClient $httpClient)
12 |     {
13 |         parent::__construct($httpClient);
14 | 
15 |         $this->object = new Contact();
16 |     }
17 | }
18 | 


--------------------------------------------------------------------------------
/examples/voice-webhooks-delete.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $deleted = $messageBird->voiceWebhooks->delete('e5f56d49-4fa2-4802-895d-b0a306f73f76'); // Set a webhook id here
 9 |     var_dump('Deleted: ' . $deleted);
10 | } catch (\Exception $e) {
11 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
12 | }
13 | 


--------------------------------------------------------------------------------
/examples/voice-call-flows-delete.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $deleted = $messageBird->voiceCallFlows->delete('7d3c2125-4ab4-4dcb-acf9-1c2dbfa24087'); // Set a call flow id here
 9 |     var_dump('Deleted: ' . $deleted);
10 | } catch (\Exception $e) {
11 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
12 | }
13 | 


--------------------------------------------------------------------------------
/examples/voice-legs-list.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $result = $messageBird->voiceLegs->getList('dbf1373c-6781-43c7-bfe4-6538583c444b', ['offset' => 100, 'limit' => 30]); // Set a call id here
 9 |     var_dump($result);
10 | } catch (\Exception $e) {
11 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
12 | }
13 | 


--------------------------------------------------------------------------------
/src/MessageBird/Resources/Conversation/Content.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Resources\Conversation;
 4 | 
 5 | use MessageBird\Common\HttpClient;
 6 | use MessageBird\Objects\Conversation\Content as ContentObject;
 7 | use MessageBird\Resources\Base;
 8 | 
 9 | class Content extends Base
10 | {
11 |     public function __construct(HttpClient $httpClient)
12 |     {
13 |         parent::__construct($httpClient);
14 | 
15 |         $this->object = new ContentObject();
16 |     }
17 | }
18 | 


--------------------------------------------------------------------------------
/examples/voice-legs-read.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $result = $messageBird->voiceLegs->read('dbf1373c-6781-43c7-bfe4-6538583c444b', '6f39d883-94ac-4068-9fed-a9e31b77acda'); // Set a call and leg id here
 9 |     var_dump($result);
10 | } catch (\Exception $e) {
11 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
12 | }
13 | 


--------------------------------------------------------------------------------
/examples/balance-view.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $balance = $messageBird->balance->read();
 9 |     var_dump($balance);
10 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
11 |     // That means that your accessKey is unknown
12 |     echo 'wrong login';
13 | } catch (\Exception $e) {
14 |     var_dump($e->getMessage());
15 | }
16 | 


--------------------------------------------------------------------------------
/src/MessageBird/Resources/Hlr.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Resources;
 4 | 
 5 | use MessageBird\Common;
 6 | use MessageBird\Objects;
 7 | 
 8 | /**
 9 |  * Class Hlr
10 |  *
11 |  * @package MessageBird\Resources
12 |  */
13 | class Hlr extends Base
14 | {
15 |     public function __construct(Common\HttpClient $httpClient)
16 |     {
17 |         $this->object = new Objects\Hlr();
18 |         $this->setResourceName('hlr');
19 | 
20 |         parent::__construct($httpClient);
21 |     }
22 | }
23 | 


--------------------------------------------------------------------------------
/examples/group-list.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $groupsList = $messageBird->groups->getList([]);
 9 |     var_dump($groupsList);
10 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
11 |     // That means that your accessKey is unknown
12 |     echo 'Wrong login';
13 | } catch (\Exception $e) {
14 |     var_dump($e->getMessage());
15 | }
16 | 


--------------------------------------------------------------------------------
/examples/voice-call-flows-update.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | $callFlow = new \MessageBird\Objects\Voice\CallFlow();
 7 | 
 8 | try {
 9 |     $result = $messageBird->voiceCallFlows->update($callFlow, '21e5fc51-3285-4f41-97fd-cd1785ab54f8');
10 |     var_dump($result);
11 | } catch (\Exception $e) {
12 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
13 | }
14 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/BaseList.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Objects;
 4 | 
 5 | /**
 6 |  * Class BaseList
 7 |  *
 8 |  * @package MessageBird\Objects
 9 |  */
10 | class BaseList extends Base
11 | {
12 |     public $limit;
13 |     public $offset;
14 |     public $count;
15 |     public $totalCount;
16 |     public $links = [
17 |         'first' => null,
18 |         'previous' => null,
19 |         'next' => null,
20 |         'last' => null,
21 |     ];
22 | 
23 |     public $items = [];
24 | }
25 | 


--------------------------------------------------------------------------------
/psalm.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <psalm
 3 |     errorLevel="7"
 4 |     resolveFromConfigFile="true"
 5 |     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 6 |     xmlns="https://getpsalm.org/schema/config"
 7 |     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
 8 | >
 9 |     <projectFiles>
10 |         <directory name="src" />
11 |         <ignoreFiles>
12 |             <directory name="vendor" />
13 |         </ignoreFiles>
14 |     </projectFiles>
15 | </psalm>
16 | 


--------------------------------------------------------------------------------
/examples/contact-list.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $contactList = $messageBird->contacts->getList([]);
 9 |     var_dump($contactList);
10 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
11 |     // That means that your accessKey is unknown
12 |     echo 'Wrong login';
13 | } catch (\Exception $e) {
14 |     var_dump($e->getMessage());
15 | }
16 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Conversation/HSM/Message.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Objects\Conversation\HSM;
 4 | 
 5 | class Message
 6 | {
 7 |     /**
 8 |      * @var string $namespace
 9 |      */
10 |     public $namespace;
11 | 
12 |     /**
13 |      * @var string $templateName
14 |      */
15 |     public $templateName;
16 | 
17 |     /**
18 |      * @var Language $language
19 |      */
20 |     public $language;
21 | 
22 |     /**
23 |      * @var Params[] $params
24 |      */
25 |     public $params;
26 | }
27 | 


--------------------------------------------------------------------------------
/src/MessageBird/Resources/Balance.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Resources;
 4 | 
 5 | use MessageBird\Common;
 6 | use MessageBird\Objects;
 7 | 
 8 | /**
 9 |  * Class Balance
10 |  *
11 |  * @package MessageBird\Resources
12 |  */
13 | class Balance extends Base
14 | {
15 |     public function __construct(Common\HttpClient $httpClient)
16 |     {
17 |         $this->object = new Objects\Balance();
18 |         $this->setResourceName('balance');
19 | 
20 |         parent::__construct($httpClient);
21 |     }
22 | }
23 | 


--------------------------------------------------------------------------------
/examples/hlr-list.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $hlrList = $messageBird->hlr->getList(['offset' => 100, 'limit' => 30]);
 9 |     var_dump($hlrList);
10 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
11 |     // That means that your accessKey is unknown
12 |     echo 'wrong login';
13 | } catch (\Exception $e) {
14 |     var_dump($e->getMessage());
15 | }
16 | 


--------------------------------------------------------------------------------
/examples/mms-list.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $mmsList = $messageBird->mmsMessages->getList(['offset' => 0, 'limit' => 30]);
 9 |     var_dump($mmsList);
10 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
11 |     // That means that your accessKey is unknown
12 |     echo 'wrong login';
13 | } catch (\Exception $e) {
14 |     var_dump($e->getMessage());
15 | }
16 | 


--------------------------------------------------------------------------------
/examples/phone-numbers-view.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('MESSAGEBIRD_API_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $phoneNumbers = $messageBird->phoneNumbers->getList();
 9 |     var_dump($phoneNumbers);
10 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
11 |     // That means that your accessKey is unknown
12 |     print("wrong login\n");
13 | } catch (\Exception $e) {
14 |     var_dump($e->getMessage());
15 | }
16 | 


--------------------------------------------------------------------------------
/src/MessageBird/Resources/MmsMessages.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Resources;
 4 | 
 5 | use MessageBird\Common;
 6 | use MessageBird\Objects;
 7 | 
 8 | /**
 9 |  * Class MmsMessages
10 |  *
11 |  * @package MessageBird\Resources
12 |  */
13 | class MmsMessages extends Base
14 | {
15 |     public function __construct(Common\HttpClient $httpClient)
16 |     {
17 |         $this->object = new Objects\MmsMessage();
18 |         $this->setResourceName('mms');
19 | 
20 |         parent::__construct($httpClient);
21 |     }
22 | }
23 | 


--------------------------------------------------------------------------------
/src/MessageBird/Resources/Voice/Calls.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Resources\Voice;
 4 | 
 5 | use MessageBird\Common;
 6 | use MessageBird\Objects;
 7 | 
 8 | /**
 9 |  * Class Calls
10 |  *
11 |  * @package MessageBird\Resources\Voice
12 |  */
13 | class Calls extends Base
14 | {
15 |     public function __construct(Common\HttpClient $httpClient)
16 |     {
17 |         $this->object = new Objects\Voice\Call();
18 |         $this->setResourceName('calls');
19 | 
20 |         parent::__construct($httpClient);
21 |     }
22 | }
23 | 


--------------------------------------------------------------------------------
/examples/group-view.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $groupResult = $messageBird->groups->read('group_id'); // Set a group id here
 9 |     var_dump($groupResult);
10 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
11 |     // That means that your accessKey is unknown
12 |     echo 'Wrong login';
13 | } catch (\Exception $e) {
14 |     var_dump($e->getMessage());
15 | }
16 | 


--------------------------------------------------------------------------------
/examples/partner-account-read.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $partnerAccountResult = $messageBird->partnerAccounts->read(1);
 9 |     var_dump($partnerAccountResult);
10 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
11 |     // That means that your accessKey is unknown
12 |     echo 'wrong login';
13 | } catch (\Exception $e) {
14 |     echo $e->getMessage();
15 | }
16 | 


--------------------------------------------------------------------------------
/examples/group-get-contacts.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $groupsContactList = $messageBird->groups->getContacts('group_id');
 9 |     var_dump($groupsContactList);
10 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
11 |     // That means that your accessKey is unknown
12 |     echo 'Wrong login';
13 | } catch (\Exception $e) {
14 |     var_dump($e->getMessage());
15 | }
16 | 


--------------------------------------------------------------------------------
/examples/partner-account-delete.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $partnerAccountResult = $messageBird->partnerAccounts->delete(1);
 9 |     var_dump($partnerAccountResult);
10 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
11 |     // That means that your accessKey is unknown
12 |     echo 'wrong login';
13 | } catch (\Exception $e) {
14 |     echo $e->getMessage();
15 | }
16 | 


--------------------------------------------------------------------------------
/examples/partner-account-list.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $partnerAccountResult = $messageBird->partnerAccounts->getList();
 9 |     var_dump($partnerAccountResult);
10 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
11 |     // That means that your accessKey is unknown
12 |     echo 'wrong login';
13 | } catch (\Exception $e) {
14 |     echo $e->getMessage();
15 | }
16 | 


--------------------------------------------------------------------------------
/examples/voice-recordings-list.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $result = $messageBird->voiceRecordings->getList('c226420d-f107-4db1-b2f9-4646656a90bc', '4f5ab5f4-c4b6-4586-9255-980bb3fd7336', ['offset' => 100, 'limit' => 30]); // Set a call and leg id here
 9 |     var_dump($result);
10 | } catch (\Exception $e) {
11 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
12 | }
13 | 


--------------------------------------------------------------------------------
/examples/contact-get-groups.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $contactGroupsList = $messageBird->contacts->getGroups('contact_id');
 9 |     var_dump($contactGroupsList);
10 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
11 |     // That means that your accessKey is unknown
12 |     echo 'Wrong login';
13 | } catch (\Exception $e) {
14 |     var_dump($e->getMessage());
15 | }
16 | 


--------------------------------------------------------------------------------
/examples/group-delete.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $deleted = $messageBird->groups->delete('group_id'); // Set a group id here
 9 |     var_dump('Deleted: ' . $deleted);
10 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
11 |     // That means that your accessKey is unknown
12 |     echo 'Wrong login';
13 | } catch (\Exception $e) {
14 |     var_dump($e->getMessage());
15 | }
16 | 


--------------------------------------------------------------------------------
/examples/message-list.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $messageList = $messageBird->messages->getList(['offset' => 100, 'limit' => 30]);
 9 |     var_dump($messageList);
10 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
11 |     // That means that your accessKey is unknown
12 |     echo 'wrong login';
13 | } catch (\Exception $e) {
14 |     var_dump($e->getMessage());
15 | }
16 | 


--------------------------------------------------------------------------------
/examples/mms-view.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $mmsResult = $messageBird->mmsMessages->read('mms_message_id'); // Set a MMS Message id
 9 |     var_dump($mmsResult);
10 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
11 |     // That means that your accessKey is unknown
12 |     echo 'wrong login';
13 | } catch (\Exception $e) {
14 |     var_dump($e->getMessage());
15 | }
16 | 


--------------------------------------------------------------------------------
/examples/phone-numbers-delete.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('MESSAGEBIRD_API_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $deleted = $messageBird->phoneNumbers->delete('31612345678');
 9 |     var_dump('Deleted: ' . $deleted);
10 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
11 |     // That means that your accessKey is unknown
12 |     print("wrong login\n");
13 | } catch (\Exception $e) {
14 |     echo $e->getMessage();
15 | }
16 | 


--------------------------------------------------------------------------------
/examples/voice-webhooks-create.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | $webhook = new \MessageBird\Objects\Voice\Webhook();
 7 | $webhook->url = 'https://example.com/status';
 8 | $webhook->token = 'foobar';
 9 | 
10 | try {
11 |     $result = $messageBird->voiceWebhooks->create($webhook);
12 |     var_dump($result);
13 | } catch (\Exception $e) {
14 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
15 | }
16 | 


--------------------------------------------------------------------------------
/src/MessageBird/Resources/Voice/Webhooks.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Resources\Voice;
 4 | 
 5 | use MessageBird\Common;
 6 | use MessageBird\Objects;
 7 | 
 8 | /**
 9 |  * Class Webhooks
10 |  *
11 |  * @package MessageBird\Resources\Voice
12 |  */
13 | class Webhooks extends Base
14 | {
15 |     public function __construct(Common\HttpClient $httpClient)
16 |     {
17 |         $this->object = new Objects\Voice\Webhook();
18 |         $this->setResourceName('webhooks');
19 | 
20 |         parent::__construct($httpClient);
21 |     }
22 | }
23 | 


--------------------------------------------------------------------------------
/src/MessageBird/Resources/VoiceMessage.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Resources;
 4 | 
 5 | use MessageBird\Common;
 6 | use MessageBird\Objects;
 7 | 
 8 | /**
 9 |  * Class VoiceMessage
10 |  *
11 |  * @package MessageBird\Resources
12 |  */
13 | class VoiceMessage extends Base
14 | {
15 |     public function __construct(Common\HttpClient $httpClient)
16 |     {
17 |         $this->object = new Objects\VoiceMessage();
18 |         $this->setResourceName('voicemessages');
19 | 
20 |         parent::__construct($httpClient);
21 |     }
22 | }
23 | 


--------------------------------------------------------------------------------
/examples/contact-get-messages.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $contactMessageList = $messageBird->contacts->getMessages('contact_id');
 9 |     var_dump($contactMessageList);
10 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
11 |     // That means that your accessKey is unknown
12 |     echo 'Wrong login';
13 | } catch (\Exception $e) {
14 |     var_dump($e->getMessage());
15 | }
16 | 


--------------------------------------------------------------------------------
/examples/voice-recordings-read.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $result = $messageBird->voiceRecordings->read('c226420d-f107-4db1-b2f9-4646656a90bc', '4f5ab5f4-c4b6-4586-9255-980bb3fd7336', 'a94f7d51-19b5-4eb8-9e8e-90fce490a577'); // Set call, leg and recording id here
 9 |     var_dump($result);
10 | } catch (\Exception $e) {
11 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
12 | }
13 | 


--------------------------------------------------------------------------------
/examples/contact-view.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $contactResult = $messageBird->contacts->read('123_contact_id'); // Set a contact id here
 9 |     var_dump($contactResult);
10 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
11 |     // That means that your accessKey is unknown
12 |     echo 'Wrong login';
13 | } catch (\Exception $e) {
14 |     var_dump($e->getMessage());
15 | }
16 | 


--------------------------------------------------------------------------------
/examples/hlr-view.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $hlrResult = $messageBird->hlr->read('c8143db0152a58755c80492h61377581'); // Set a message id here
 9 |     var_dump($hlrResult);
10 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
11 |     // That means that your accessKey is unknown
12 |     echo 'wrong login';
13 | } catch (\Exception $e) {
14 |     var_dump($e->getMessage());
15 | }
16 | 


--------------------------------------------------------------------------------
/src/MessageBird/Resources/EmailMessage.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Resources;
 4 | 
 5 | use MessageBird\Common;
 6 | use MessageBird\Objects;
 7 | 
 8 | /**
 9 |  * Class EmailMessage
10 |  *
11 |  * @package MessageBird\Resources
12 |  */
13 | class EmailMessage extends Base
14 | {
15 |     public function __construct(Common\HttpClient $httpClient)
16 |     {
17 |         $this->object = new Objects\EmailMessage();
18 |         $this->setResourceName('verify/messages/email');
19 | 
20 |         parent::__construct($httpClient);
21 |     }
22 | }
23 | 


--------------------------------------------------------------------------------
/src/MessageBird/Resources/Voice/CallFlows.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Resources\Voice;
 4 | 
 5 | use MessageBird\Common;
 6 | use MessageBird\Objects;
 7 | 
 8 | /**
 9 |  * Class CallFlows
10 |  *
11 |  * @package MessageBird\Resources\Voice
12 |  */
13 | class CallFlows extends Base
14 | {
15 |     public function __construct(Common\HttpClient $httpClient)
16 |     {
17 |         $this->object = new Objects\Voice\CallFlow();
18 |         $this->setResourceName('call-flows');
19 | 
20 |         parent::__construct($httpClient);
21 |     }
22 | }
23 | 


--------------------------------------------------------------------------------
/examples/available-phone-numbers-view.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('MESSAGEBIRD_API_KEY');
 6 | 
 7 | try {
 8 |     $phoneNumbers = $messageBird->availablePhoneNumbers->getList("nl", []);
 9 |     var_dump($phoneNumbers);
10 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
11 |     var_dump($e->getMessage());
12 |     // That means that your accessKey is unknown
13 |     print("wrong login\n");
14 | } catch (\Exception $e) {
15 |     var_dump($e->getMessage());
16 | }
17 | 


--------------------------------------------------------------------------------
/examples/contact-delete.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $deleted = $messageBird->contacts->delete('123_contact_id'); // Set a contact id here
 9 |     var_dump('Deleted: ' . $deleted);
10 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
11 |     // That means that your accessKey is unknown
12 |     echo 'Wrong login';
13 | } catch (\Exception $e) {
14 |     var_dump($e->getMessage());
15 | }
16 | 


--------------------------------------------------------------------------------
/examples/verify-view.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $verifyResult = $messageBird->verify->read('05a90ee1155d2f4cdd12440v10006813'); // Set a message id here
 9 |     var_dump($verifyResult);
10 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
11 |     // That means that your accessKey is unknown
12 |     echo 'wrong login';
13 | } catch (\Exception $e) {
14 |     echo $e->getMessage();
15 | }
16 | 


--------------------------------------------------------------------------------
/examples/conversations/webhooks-delete.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | // Webhooks enable real-time notifications of conversation events to be
 4 | // delivered to endpoints on your own server. This example deletes an existing
 5 | // webhook.
 6 | 
 7 | require(__DIR__ . '/../../autoload.php');
 8 | 
 9 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
10 | 
11 | try {
12 |     $messageBird->conversationWebhooks->delete('WEBHOOK_ID');
13 | } catch (\Exception $e) {
14 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
15 | }
16 | 


--------------------------------------------------------------------------------
/examples/conversations/webhooks-list.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | // Retrieves all webhooks this key has access to. Pagination is supported
 4 | // through the optional 'limit' and 'offset' parameters.
 5 | 
 6 | require(__DIR__ . '/../../autoload.php');
 7 | 
 8 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 9 | 
10 | try {
11 |     $webhooks = $messageBird->conversationWebhooks->getList();
12 | 
13 |     var_dump($webhooks);
14 | } catch (\Exception $e) {
15 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
16 | }
17 | 


--------------------------------------------------------------------------------
/examples/voicemessages-list.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $voiceMessageList = $messageBird->voicemessages->getList(['offset' => 100, 'limit' => 30]);
 9 |     var_dump($voiceMessageList);
10 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
11 |     // That means that your accessKey is unknown
12 |     echo 'wrong login';
13 | } catch (\Exception $e) {
14 |     var_dump($e->getMessage());
15 | }
16 | 


--------------------------------------------------------------------------------
/examples/message-view.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $messageResult = $messageBird->messages->read('ad86c8c0153a194a59a17e2b71578856'); // Set a message id here
 9 |     var_dump($messageResult);
10 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
11 |     // That means that your accessKey is unknown
12 |     echo 'wrong login';
13 | } catch (\Exception $e) {
14 |     var_dump($e->getMessage());
15 | }
16 | 


--------------------------------------------------------------------------------
/examples/message-delete.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $deleted = $messageBird->messages->delete('deb1fe303539efdf1730124b69920283'); // Set a message id here
 9 |     var_dump('Deleted: ' . $deleted);
10 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
11 |     // That means that your accessKey is unknown
12 |     echo 'wrong login';
13 | } catch (\Exception $e) {
14 |     var_dump($e->getMessage());
15 | }
16 | 


--------------------------------------------------------------------------------
/examples/voice-transcriptions-read.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $result = $messageBird->voiceTranscriptions->read('c226420d-f107-4db1-b2f9-4646656a90bc', '4f5ab5f4-c4b6-4586-9255-980bb3fd7336', 'a94f7d51-19b5-4eb8-9e8e-90fce490a577'); // Set call, leg, recording and transcription id here
 9 |     var_dump($result);
10 | } catch (\Exception $e) {
11 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
12 | }
13 | 


--------------------------------------------------------------------------------
/examples/conversations/messages-list.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | // Retrieves all messages from the conversation. Pagination is supported
 4 | // through the optional 'limit' and 'offset' parameters.
 5 | 
 6 | require(__DIR__ . '/../../autoload.php');
 7 | 
 8 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 9 | 
10 | try {
11 |     $messages = $messageBird->conversationMessages->getList('CONVERSATION_ID');
12 | 
13 |     var_dump($messages);
14 | } catch (\Exception $e) {
15 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
16 | }
17 | 


--------------------------------------------------------------------------------
/examples/voice-webhooks-update.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | $webhook = new \MessageBird\Objects\Voice\Webhook();
 7 | $webhook->url = 'https://example.com/foobar';
 8 | $webhook->token = 'baz';
 9 | 
10 | try {
11 |     $result = $messageBird->voiceWebhooks->update($webhook, 'e5f56d49-4fa2-4802-895d-b0a306f73f76');
12 |     var_dump($result);
13 | } catch (\Exception $e) {
14 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
15 | }
16 | 


--------------------------------------------------------------------------------
/src/MessageBird/Resources/Conversation/Webhooks.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Resources\Conversation;
 4 | 
 5 | use MessageBird\Common\HttpClient;
 6 | use MessageBird\Objects\Conversation\Webhook;
 7 | use MessageBird\Resources\Base;
 8 | 
 9 | class Webhooks extends Base
10 | {
11 |     public const RESOURCE_NAME = 'webhooks';
12 | 
13 |     public function __construct(HttpClient $httpClient)
14 |     {
15 |         parent::__construct($httpClient);
16 | 
17 |         $this->object = new Webhook();
18 |         $this->setResourceName(self::RESOURCE_NAME);
19 |     }
20 | }
21 | 


--------------------------------------------------------------------------------
/examples/voice-transcriptions-list.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $result = $messageBird->voiceTranscriptions->getList('c226420d-f107-4db1-b2f9-4646656a90bc', '4f5ab5f4-c4b6-4586-9255-980bb3fd7336', 'a94f7d51-19b5-4eb8-9e8e-90fce490a577', ['offset' => 100, 'limit' => 30]); // Set a call and leg id here
 9 |     var_dump($result);
10 | } catch (\Exception $e) {
11 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
12 | }
13 | 


--------------------------------------------------------------------------------
/examples/voice-transcriptions-create.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | $transcription = new \MessageBird\Objects\Voice\Recording();
 7 | 
 8 | try {
 9 |     $result = $messageBird->voiceTranscriptions->create('c226420d-f107-4db1-b2f9-4646656a90bc', '4f5ab5f4-c4b6-4586-9255-980bb3fd7336', 'a94f7d51-19b5-4eb8-9e8e-90fce490a577');
10 |     var_dump($result);
11 | } catch (\Exception $e) {
12 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
13 | }
14 | 


--------------------------------------------------------------------------------
/examples/voicemessages-view.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $voiceMessageResult = $messageBird->voicemessages->read('ca0a8220453bc36ddeb3115a37400870'); // Set a message id here
 9 |     var_dump($voiceMessageResult);
10 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
11 |     // That means that your accessKey is unknown
12 |     echo 'wrong login';
13 | } catch (\Exception $e) {
14 |     var_dump($e->getMessage());
15 | }
16 | 


--------------------------------------------------------------------------------
/src/MessageBird/Resources/Messages.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Resources;
 4 | 
 5 | use MessageBird\Common;
 6 | use MessageBird\Objects;
 7 | 
 8 | /**
 9 |  * Class Messages
10 |  *
11 |  * @package MessageBird\Resources
12 |  */
13 | class Messages extends Base
14 | {
15 |     public function __construct(Common\HttpClient $httpClient)
16 |     {
17 |         $this->object = new Objects\Message();
18 |         $this->setResponseObject(new Objects\MessageResponse());
19 |         $this->setResourceName('messages');
20 | 
21 |         parent::__construct($httpClient);
22 |     }
23 | }
24 | 


--------------------------------------------------------------------------------
/examples/lookup-view.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $lookup = $messageBird->lookup->read(31624971134);
 9 |     var_dump($lookup);
10 | 
11 |     $lookup = $messageBird->lookup->read("624971134", "NL");
12 |     var_dump($lookup);
13 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
14 |     // That means that your accessKey is unknown
15 |     echo 'wrong login';
16 | } catch (\Exception $e) {
17 |     var_dump($e->getMessage());
18 | }
19 | 


--------------------------------------------------------------------------------
/examples/conversations/webhooks-read.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | // Webhooks enable real-time notifications of conversation events to be
 4 | // delivered to endpoints on your own server. This example retrieves an
 5 | // existing webhook.
 6 | 
 7 | require(__DIR__ . '/../../autoload.php');
 8 | 
 9 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
10 | 
11 | try {
12 |     $webhook = $messageBird->conversationWebhooks->read('WEBHOOK_ID');
13 | 
14 |     var_dump($webhook);
15 | } catch (\Exception $e) {
16 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
17 | }
18 | 


--------------------------------------------------------------------------------
/examples/emailmessages-view.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | use MessageBird\Client;
 4 | 
 5 | require_once(__DIR__ . '/../autoload.php');
 6 | 
 7 | $messageBird = new Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 8 | 
 9 | try {
10 |     $emailMessageResult = $messageBird->emailmessages->read('ca0a8220453bc36ddeb3115a37400870'); // Set a message id here
11 |     var_dump($emailMessageResult);
12 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
13 |     // That means that your accessKey is unknown
14 |     echo 'wrong login';
15 | } catch (\Exception $e) {
16 |     var_dump($e->getMessage());
17 | }
18 | 


--------------------------------------------------------------------------------
/examples/group-create.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | $group             = new \MessageBird\Objects\Group();
 8 | $group->name       = "group_name";
 9 | 
10 | try {
11 |     $groupResult = $messageBird->groups->create($group);
12 |     var_dump($groupResult);
13 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
14 |     // That means that your accessKey is unknown
15 |     echo 'Wrong login';
16 | } catch (\Exception $e) {
17 |     echo $e->getMessage();
18 | }
19 | 


--------------------------------------------------------------------------------
/examples/group-update.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | $group = new \MessageBird\Objects\Group();
 8 | $group->name = 'New group name';
 9 | 
10 | try {
11 |     $groupResult = $messageBird->groups->update($group, 'group_id');
12 |     var_dump($groupResult);
13 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
14 |     // That means that your accessKey is unknown
15 |     echo 'Wrong login';
16 | } catch (\Exception $e) {
17 |     echo $e->getMessage();
18 | }
19 | 


--------------------------------------------------------------------------------
/examples/phone-numbers-update.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('MESSAGEBIRD_API_KEY'); // Set your own API access key here.
 6 | $number = new \MessageBird\Objects\Number();
 7 | $number->tags = ['tag1'];
 8 | 
 9 | try {
10 |     $numberResult = $messageBird->phoneNumbers->update($number, '31612345678');
11 |     var_dump($numberResult);
12 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
13 |     // That means that your accessKey is unknown
14 |     print("wrong login\n");
15 | } catch (\Exception $e) {
16 |     echo $e->getMessage();
17 | }
18 | 


--------------------------------------------------------------------------------
/examples/group-remove-contact-from-group.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $contact_id = 'contact_id';
 9 |     $group_id = 'group_id';
10 |     $groupAddContact = $messageBird->groups->removeContact($contact_id, $group_id);
11 |     var_dump($groupAddContact);
12 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
13 |     // That means that your accessKey is unknown
14 |     echo 'Wrong login';
15 | } catch (\Exception $e) {
16 |     var_dump($e->getMessage());
17 | }
18 | 


--------------------------------------------------------------------------------
/examples/partner-account-create.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | $account = new \MessageBird\Objects\PartnerAccount\Account();
 8 | $account->name = 'Name Test';
 9 | 
10 | try {
11 |     $partnerAccountResult = $messageBird->partnerAccounts->create($account);
12 |     var_dump($partnerAccountResult);
13 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
14 |     // That means that your accessKey is unknown
15 |     echo 'wrong login';
16 | } catch (\Exception $e) {
17 |     echo $e->getMessage();
18 | }
19 | 


--------------------------------------------------------------------------------
/examples/partner-account-update.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | $account = new \MessageBird\Objects\PartnerAccount\Account();
 8 | $account->name = 'Name Test';
 9 | 
10 | try {
11 |     $partnerAccountResult = $messageBird->partnerAccounts->update($account, 1);
12 |     var_dump($partnerAccountResult);
13 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
14 |     // That means that your accessKey is unknown
15 |     echo 'wrong login';
16 | } catch (\Exception $e) {
17 |     echo $e->getMessage();
18 | }
19 | 


--------------------------------------------------------------------------------
/examples/group-add-contact-to-group.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $contacts['ids'] = [
 9 |         'contact_id_1',
10 |         'contact_id_2',
11 |     ];
12 |     $group_id = 'group_id';
13 |     $groupAddContact = $messageBird->groups->addContacts($contacts, $group_id);
14 |     var_dump($groupAddContact);
15 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
16 |     // That means that your accessKey is unknown
17 |     echo 'Wrong login';
18 | } catch (\Exception $e) {
19 |     var_dump($e->getMessage());
20 | }
21 | 


--------------------------------------------------------------------------------
/examples/mms-delete.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $deleted = $messageBird->mmsMessages->delete('mms_message_id'); // id here
 9 |     var_dump('Deleted: ' . $deleted);
10 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
11 |     // That means that your accessKey is unknown
12 |     echo 'wrong login';
13 | } catch (\MessageBird\Exceptions\BalanceException $e) {
14 |     // That means that you are out of credits, so do something about it.
15 |     echo 'no balance';
16 | } catch (\Exception $e) {
17 |     echo $e->getMessage();
18 | }
19 | 


--------------------------------------------------------------------------------
/examples/conversations/list.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | // Retrieves all conversations for this account. Pagination is supported
 4 | // through the optional 'limit' and 'offset' parameters.
 5 | 
 6 | require(__DIR__ . '/../../autoload.php');
 7 | 
 8 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 9 | 
10 | // Take 10 objects, but skip the first 5.
11 | $optionalParameters = [
12 |     'limit' => '10',
13 |     'offset' => '5',
14 | ];
15 | 
16 | try {
17 |     $conversations = $messageBird->conversations->getList($optionalParameters);
18 | 
19 |     var_dump($conversations);
20 | } catch (\Exception $e) {
21 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
22 | }
23 | 


--------------------------------------------------------------------------------
/examples/signedrequest-verification.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | // Create the validator for incoming requests.
 6 | $requestValidator = new \MessageBird\RequestValidator('YOUR_SIGNING_KEY');
 7 | 
 8 | // Set up the signed request from the PHP global variables.
 9 | try {
10 |     $request = \MessageBird\Objects\SignedRequest::createFromGlobals();
11 | } catch (\MessageBird\Exceptions\ValidationException $e) {
12 |     // The request was missing expected values, so respond accordingly.
13 |     http_response_code(412);
14 | }
15 | 
16 | if (!$requestValidator->verify($request)) {
17 |     // The request was invalid, so respond accordingly.
18 |     http_response_code(412);
19 | }
20 | 


--------------------------------------------------------------------------------
/examples/voice-transcriptions-download.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $data = $messageBird->voiceTranscriptions->download('c226420d-f107-4db1-b2f9-4646656a90bc', '4f5ab5f4-c4b6-4586-9255-980bb3fd7336', 'a94f7d51-19b5-4eb8-9e8e-90fce490a577', '44e73d1f-201d-4a7d-963a-9d76bbca6c4f'); // Set call, leg, recording and transcription id here
 9 |     echo sprintf("Received %d bytes.\n", mb_strlen($data));
10 |     echo sprintf("Transcription contents: `%s`.\n", $data);
11 | } catch (\Exception $e) {
12 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
13 | }
14 | 


--------------------------------------------------------------------------------
/examples/voice-call-flows-create.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | $callFlow = new \MessageBird\Objects\Voice\CallFlow();
 7 | $step = new \MessageBird\Objects\Voice\Step();
 8 | $step->action = 'say';
 9 | $step->options = [
10 |     'payload' => 'This is a journey into sound.',
11 |     'language' => 'en-GB',
12 |     'voice' => 'male',
13 | ];
14 | $callFlow->steps = [$step];
15 | 
16 | try {
17 |     $result = $messageBird->voiceCallFlows->create($callFlow);
18 |     var_dump($result);
19 | } catch (\Exception $e) {
20 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
21 | }
22 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Balance.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Objects;
 4 | 
 5 | /**
 6 |  * Class Balance
 7 |  *
 8 |  * @package MessageBird\Objects
 9 |  */
10 | class Balance extends Base
11 | {
12 |     /**
13 |      * Your payment method. Possible values are: prepaid & postpaid
14 |      *
15 |      * @var string
16 |      */
17 |     public $payment;
18 | 
19 |     /**
20 |      * Your payment type. Possible values are: credits & euros
21 |      *
22 |      * @var string
23 |      */
24 |     public $type;
25 | 
26 |     /**
27 |      * The amount of balance of the payment type. When postpaid is your payment method, the amount will be 0.
28 |      *
29 |      * @var float
30 |      */
31 |     public $amount;
32 | }
33 | 


--------------------------------------------------------------------------------
/examples/conversations/read.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | // Retrieves a single conversation by its ID.
 4 | 
 5 | require(__DIR__ . '/../../autoload.php');
 6 | 
 7 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 8 | 
 9 | // Setting the optional 'include' parameter to 'content' requests the API to
10 | // include the expanded Contact object in its response. Excluded by default.
11 | $optionalParameters = [
12 |     'include' => 'content',
13 | ];
14 | 
15 | try {
16 |     $conversation = $messageBird->conversations->read(
17 |         'CONVERSATION_ID'
18 |     );
19 | 
20 |     var_dump($conversation);
21 | } catch (\Exception $e) {
22 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
23 | }
24 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Conversation/MessageReference.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Objects\Conversation;
 4 | 
 5 | use MessageBird\Objects\Base;
 6 | 
 7 | /**
 8 |  * A link to the messages belonging to a conversation.
 9 |  */
10 | class MessageReference extends Base
11 | {
12 |     /**
13 |      * A link to the endpoint to retrieve messages of this conversation.
14 |      *
15 |      * @var string
16 |      */
17 |     public $href;
18 | 
19 |     /**
20 |      * The total number of messages that can be retrieved for this conversation
21 |      * through pagination.
22 |      *
23 |      * @var int
24 |      */
25 |     public $totalCount;
26 |     
27 |     /**
28 |      * @var string|null
29 |      */
30 |     public $lastMessageId;
31 | }
32 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/NumberPurchaseRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Objects;
 4 | 
 5 | /**
 6 |  * Class NumberPurchaseRequest
 7 |  *
 8 |  * Represents a specific phone number
 9 |  *
10 |  * @package MessageBird\Objects
11 |  */
12 | class NumberPurchaseRequest extends Base
13 | {
14 |     /**
15 |      * The phone number in E.164 format without the prefixed plus-sign.
16 |      * @var string
17 |      */
18 |     public $number;
19 | 
20 |     /**
21 |      * The country code for this number in ISO 3166-1 alpha-2 format.
22 |      *
23 |      * @var string
24 |      */
25 |     public $countryCode;
26 | 
27 |     /**
28 |      * The interval in months that this number will be billed by
29 |      */
30 |     public $billingIntervalMonths;
31 | }
32 | 


--------------------------------------------------------------------------------
/examples/conversations/update.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | // Updating the conversation allows moving them between 'active' and 'archived'
 4 | // status. This example restores an archived conversation by setting it to active.
 5 | 
 6 | require(__DIR__ . '/../../autoload.php');
 7 | 
 8 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 9 | 
10 | try {
11 |     $conversationId = 'CONVERSATION_ID';
12 |     $conversation = $messageBird->conversations->read($conversationId);
13 | 
14 |     $conversation->status = \MessageBird\Objects\Conversation\Conversation::STATUS_ACTIVE;
15 |     $messageBird->conversations->update($conversation, $conversationId);
16 | } catch (\Exception $e) {
17 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
18 | }
19 | 


--------------------------------------------------------------------------------
/examples/verify-verification.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $verifyResult = $messageBird->verify->verify('05a90ee1155d2f4cdd12440v10006813', '585438'); // Set a message id and the token here.
 9 |     var_dump($verifyResult);
10 | 
11 |     // Check if $verifyResult->getStatus() === MessageBird\Objects\Verify::STATUS_VERIFIED
12 | } catch (\MessageBird\Exceptions\RequestException $e) {
13 |     echo 'token incorrect';
14 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
15 |     // That means that your accessKey is unknown
16 |     echo 'wrong login';
17 | } catch (\Exception $e) {
18 |     echo $e->getMessage();
19 | }
20 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Conversation/SendMessageResult.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Objects\Conversation;
 4 | 
 5 | use JsonSerializable;
 6 | use MessageBird\Objects\Base;
 7 | 
 8 | class SendMessageResult extends Base implements JsonSerializable
 9 | {
10 |     /**
11 |      * @var string
12 |      */
13 |     public $id;
14 | 
15 |     /**
16 |      * @var string
17 |      */
18 |     public $status;
19 | 
20 |     /**
21 |      * Serialize only non empty fields.
22 |      */
23 |     public function jsonSerialize(): array
24 |     {
25 |         $json = [];
26 | 
27 |         foreach (get_object_vars($this) as $key => $value) {
28 |             if (!empty($value)) {
29 |                 $json[$key] = $value;
30 |             }
31 |         }
32 | 
33 |         return $json;
34 |     }
35 | }
36 | 


--------------------------------------------------------------------------------
/examples/voice-recordings-download.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $data = $messageBird->voiceRecordings->download('c226420d-f107-4db1-b2f9-4646656a90bc', '4f5ab5f4-c4b6-4586-9255-980bb3fd7336', 'a94f7d51-19b5-4eb8-9e8e-90fce490a577'); // Set call, leg and recording id here
 9 |     echo sprintf("Received %d bytes.\n", mb_strlen($data));
10 |     $tmpfname = tempnam('/tmp', 'voice-recording-');
11 |     $handle = fopen($tmpfname, "w");
12 |     fwrite($handle, $data);
13 |     fclose($handle);
14 |     echo sprintf("Wrote to file: %s\n", $tmpfname);
15 | } catch (\Exception $e) {
16 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
17 | }
18 | 


--------------------------------------------------------------------------------
/examples/phone-numbers-create.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('MESSAGEBIRD_API_KEY'); // Set your own API access key here.
 6 | $numberPurchaseRequest = new \MessageBird\Objects\NumberPurchaseRequest();
 7 | $numberPurchaseRequest->number = '31612345678';
 8 | $numberPurchaseRequest->countryCode = 'NL';
 9 | $numberPurchaseRequest->billingIntervalMonths = 1;
10 | 
11 | try {
12 |     $numberPurchaseRequestResult = $messageBird->phoneNumbers->create($numberPurchaseRequest);
13 |     var_dump($numberPurchaseRequestResult);
14 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
15 |     // That means that your accessKey is unknown
16 |     print("wrong login\n");
17 | } catch (\Exception $e) {
18 |     echo $e->getMessage();
19 | }
20 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Conversation/Fallback.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Objects\Conversation;
 4 | 
 5 | class Fallback
 6 | {
 7 |     /**
 8 |      * The ID that identifies the channel over which the message should be sent.
 9 |      *
10 |      * @var string
11 |      */
12 |     public $from;
13 | 
14 |     /**
15 |      * This is optional. You can set a time period before attempting to send the fallback.
16 |      * After this time, if the original message isn't in a successfully delivered state, the fallback will be triggered.
17 |      * Formatted as a short-hand duration, for example: "30m" for 30 minutes, "3h" for 3 hours. If the fallback time
18 |      * period isn't specified, 1 minute will be used as the default value.
19 |      *
20 |      * @var string
21 |      */
22 |     public $after;
23 | }
24 | 


--------------------------------------------------------------------------------
/examples/hlr-create.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | $hlr            = new \MessageBird\Objects\Hlr();
 8 | $hlr->msisdn    = 31612345678;
 9 | $hlr->reference = "Custom reference";
10 | 
11 | try {
12 |     $hlrResult = $messageBird->hlr->create($hlr);
13 |     var_export($hlrResult);
14 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
15 |     // That means that your accessKey is unknown
16 |     echo 'wrong login';
17 | } catch (\MessageBird\Exceptions\BalanceException $e) {
18 |     // That means that you are out of credits, so do something about it.
19 |     echo 'no balance';
20 | } catch (\MessageBird\Exceptions\RequestException $e) {
21 |     echo $e->getMessage();
22 | }
23 | 


--------------------------------------------------------------------------------
/examples/contact-update.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | $contact = new \MessageBird\Objects\Contact();
 8 | $contact->msisdn = '31123456789';
 9 | $contact->firstName = 'ChangedFirst';
10 | $contact->lastName = "ChangedLast";
11 | $contact->custom1 = "custom-1b";
12 | $contact->custom2 = "custom-2b";
13 | $contact->custom3 = "custom-3b";
14 | $contact->custom4 = "custom-4b";
15 | 
16 | 
17 | try {
18 |     $groupResult = $messageBird->contacts->update($contact, 'contact_id');
19 |     var_dump($groupResult);
20 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
21 |     // That means that your accessKey is unknown
22 |     echo 'Wrong login';
23 | } catch (\Exception $e) {
24 |     echo $e->getMessage();
25 | }
26 | 


--------------------------------------------------------------------------------
/examples/contact-create.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | $contact             = new \MessageBird\Objects\Contact();
 8 | $contact->msisdn = "31123456780";
 9 | $contact->firstName = "FirstName";
10 | $contact->lastName = "LastName";
11 | $contact->custom1 = "test_custom1";
12 | $contact->custom2 = "test_custom2";
13 | $contact->custom3 = "test_custom3";
14 | $contact->custom4 = "test_custom4";
15 | 
16 | 
17 | try {
18 |     $contactResult = $messageBird->contacts->create($contact);
19 |     var_dump($contactResult);
20 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
21 |     // That means that your accessKey is unknown
22 |     echo 'Wrong login';
23 | } catch (\Exception $e) {
24 |     echo $e->getMessage();
25 | }
26 | 


--------------------------------------------------------------------------------
/examples/voice-calls-create.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | $call = new \MessageBird\Objects\Voice\Call();
 7 | $call->source = '31971234567';
 8 | $call->destination = '31612345678';
 9 | $callFlow = new \MessageBird\Objects\Voice\CallFlow();
10 | $step = new \MessageBird\Objects\Voice\Step();
11 | $step->action = 'say';
12 | $step->options = [
13 |     'payload' => 'This is a journey into sound.',
14 |     'language' => 'en-GB',
15 |     'voice' => 'male',
16 | ];
17 | $callFlow->steps = [$step];
18 | $call->callFlow = $callFlow;
19 | 
20 | try {
21 |     $result = $messageBird->voiceCalls->create($call);
22 |     var_dump($result);
23 | } catch (\Exception $e) {
24 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
25 | }
26 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Conversation/HSM/Language.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Objects\Conversation\HSM;
 4 | 
 5 | class Language
 6 | {
 7 |     // Will deliver the message template in the user's device language. If the settings can't be found on the user's
 8 |     // device the fallback language is used.
 9 |     public const FALLBACK_POLICY = 'fallback';
10 | 
11 |     // Will deliver the message template exactly in the language and locale asked for.
12 |     public const DETERMINISTIC_POLICY = 'deterministic';
13 | 
14 |     /**
15 |      * It accepts FALLBACK_POLICY or DETERMINISTIC_POLICY.
16 |      *
17 |      * @var string $policy
18 |      */
19 |     public $policy;
20 | 
21 |     /**
22 |      * Code can be both language and language_locale formats (e.g. en and en_US).
23 |      *
24 |      * @var string $code
25 |      */
26 |     public $code;
27 | }
28 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Voice/Step.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Objects\Voice;
 4 | 
 5 | use MessageBird\Objects\Base;
 6 | 
 7 | class Step extends Base
 8 | {
 9 |     /**
10 |      * The name of the VoIP action
11 |      *
12 |      * Possible values: transfer, say, play, pause, record, fetchCallFlow, hangup.
13 |      *
14 |      * @var string
15 |      */
16 |     public $action;
17 |     /**
18 |      * Contains zero or more key-value pairs, where the key is the identifier of the option and value is the option
19 |      * value.
20 |      *
21 |      * @var array
22 |      */
23 |     public $options;
24 |     /**
25 |      * The unique (within the call flow) identifier of the step.
26 |      *
27 |      * @var string
28 |      */
29 |     protected $id;
30 | 
31 |     public function getId(): string
32 |     {
33 |         return $this->id;
34 |     }
35 | }
36 | 


--------------------------------------------------------------------------------
/examples/message-create.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | $message             = new \MessageBird\Objects\Message();
 8 | $message->originator = 'YourBrand';
 9 | $message->recipients = [31612345678];
10 | $message->body       = 'This is a test message.';
11 | 
12 | try {
13 |     $messageResult = $messageBird->messages->create($message);
14 |     var_dump($messageResult);
15 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
16 |     // That means that your accessKey is unknown
17 |     echo 'wrong login';
18 | } catch (\MessageBird\Exceptions\BalanceException $e) {
19 |     // That means that you are out of credits, so do something about it.
20 |     echo 'no balance';
21 | } catch (\Exception $e) {
22 |     echo $e->getMessage();
23 | }
24 | 


--------------------------------------------------------------------------------
/examples/verify-create.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | $verify             = new \MessageBird\Objects\Verify();
 8 | $verify->recipient = 31612345678;
 9 | 
10 | $extraOptions = [
11 |     'originator' => 'YourBrand',
12 |     'timeout' => 60,
13 | ];
14 | 
15 | try {
16 |     $verifyResult = $messageBird->verify->create($verify, $extraOptions);
17 |     var_dump($verifyResult);
18 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
19 |     // That means that your accessKey is unknown
20 |     echo 'wrong login';
21 | } catch (\MessageBird\Exceptions\BalanceException $e) {
22 |     // That means that you are out of credits, so do something about it.
23 |     echo 'no balance';
24 | } catch (\Exception $e) {
25 |     echo $e->getMessage();
26 | }
27 | 


--------------------------------------------------------------------------------
/examples/message-create-unicode.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | $message             = new \MessageBird\Objects\Message();
 8 | $message->originator = 'YourBrand';
 9 | $message->recipients = [31612345678];
10 | $message->body       = 'This is a test message with a smiling emoji 😀.';
11 | $message->datacoding = 'unicode';
12 | 
13 | try {
14 |     $messageResult = $messageBird->messages->create($message);
15 |     var_dump($messageResult);
16 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
17 |     // That means that your accessKey is unknown
18 |     echo 'wrong login';
19 | } catch (\MessageBird\Exceptions\BalanceException $e) {
20 |     // That means that you are out of credits, so do something about it.
21 |     echo 'no balance';
22 | } catch (\Exception $e) {
23 |     echo $e->getMessage();
24 | }
25 | 


--------------------------------------------------------------------------------
/examples/conversations/create.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | // Initiates a conversation by sending a first message. This example uses a
 4 | // plain text message, but other types are also available. See the
 5 | // conversations-messages-create examples.
 6 | 
 7 | require(__DIR__ . '/../../autoload.php');
 8 | 
 9 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
10 | 
11 | $content = new \MessageBird\Objects\Conversation\Content();
12 | $content->text = 'Hello world';
13 | 
14 | $message = new \MessageBird\Objects\Conversation\Message();
15 | $message->channelId = 'CHANNEL_ID';
16 | $message->content = $content;
17 | $message->to = 'RECIPIENT'; // Channel-specific, e.g. MSISDN for SMS.
18 | $message->type = 'text';
19 | 
20 | try {
21 |     $conversation = $messageBird->conversations->start($message);
22 | 
23 |     var_dump($conversation);
24 | } catch (\Exception $e) {
25 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
26 | }
27 | 


--------------------------------------------------------------------------------
/examples/signed-request-validation.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | // Create the validator for incoming requests.
 6 | $requestValidator = new \MessageBird\RequestValidator('YOUR_SIGNING_KEY');
 7 | 
 8 | // Verify the incoming request from the PHP global variables.
 9 | try {
10 |     $request = $requestValidator->validateRequestFromGlobals();
11 | } catch (\MessageBird\Exceptions\ValidationException $e) {
12 |     // The request was invalid, so respond accordingly.
13 |     http_response_code(412);
14 | }
15 | 
16 | // Or directly verify the signature of the incoming request
17 | $signature = 'JWT_TOKEN_STRING';
18 | $url = 'https://yourdomain.com/path';
19 | $body = 'REQUEST_BODY';
20 | 
21 | try {
22 |     $request = $requestValidator->validateSignature($signature, $url, $body);
23 | } catch (\MessageBird\Exceptions\ValidationException $e) {
24 |     // The request was invalid, so respond accordingly.
25 |     http_response_code(412);
26 | }
27 | 


--------------------------------------------------------------------------------
/examples/conversations/messages-create-location.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | // Sends a message to an existing conversation, with a location as its content.
 4 | 
 5 | require(__DIR__ . '/../../autoload.php');
 6 | 
 7 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 8 | 
 9 | $content = new \MessageBird\Objects\Conversation\Content();
10 | $content->location = [
11 |     'latitude' => 52.379112,
12 |     'longitude' => 4.900384,
13 | ];
14 | 
15 | $message = new \MessageBird\Objects\Conversation\Message();
16 | $message->channelId = 'CHANNEL_ID';
17 | $message->content = $content;
18 | $message->to = 'RECIPIENT';
19 | $message->type = \MessageBird\Objects\Conversation\Content::TYPE_LOCATION; // 'location'
20 | 
21 | try {
22 |     $conversation = $messageBird->conversationMessages->create(
23 |         'CONVERSATION_ID',
24 |         $message
25 |     );
26 | 
27 |     var_dump($conversation);
28 | } catch (\Exception $e) {
29 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
30 | }
31 | 


--------------------------------------------------------------------------------
/examples/mms-create.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | $mmsMessage = new \MessageBird\Objects\MmsMessage();
 8 | $mmsMessage->originator = 'YourNumber';
 9 | $mmsMessage->recipients = [31612345678];
10 | $mmsMessage->subject = "Check out this cool MMS";
11 | $mmsMessage->body = 'Have you seen this logo?';
12 | $mmsMessage->mediaUrls = ['https://www.messagebird.com/assets/images/og/messagebird.gif'];
13 | 
14 | try {
15 |     $mmsMessageResult = $messageBird->mmsMessages->create($mmsMessage);
16 |     var_dump($mmsMessageResult);
17 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
18 |     // That means that your accessKey is unknown
19 |     echo 'wrong login';
20 | } catch (\MessageBird\Exceptions\BalanceException $e) {
21 |     // That means that you are out of credits, so do something about it.
22 |     echo 'no balance';
23 | } catch (\Exception $e) {
24 |     echo $e->getMessage();
25 | }
26 | 


--------------------------------------------------------------------------------
/examples/conversations/messages-create-text.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | // Sends a plain text message to a contact. If there's an active conversation
 4 | // with that contact the message will be added to this conversation, otherwise
 5 | // it creates a new conversation.
 6 | 
 7 | require(__DIR__ . '/../../autoload.php');
 8 | 
 9 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
10 | 
11 | $content = new \MessageBird\Objects\Conversation\Content();
12 | $content->text = 'Hello world';
13 | 
14 | $message = new \MessageBird\Objects\Conversation\Message();
15 | $message->channelId = 'CHANNEL_ID';
16 | $message->content = $content;
17 | $message->to = 'RECIPIENT';
18 | $message->type = \MessageBird\Objects\Conversation\Content::TYPE_TEXT;
19 | 
20 | try {
21 |     $conversation = $messageBird->conversationMessages->create(
22 |         'CONVERSATION_ID',
23 |         $message
24 |     );
25 | 
26 |     var_dump($conversation);
27 | } catch (\Exception $e) {
28 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
29 | }
30 | 


--------------------------------------------------------------------------------
/examples/conversations/send.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | // Initiates a conversation by sending a first message, or adding a message to an already existing conversation with
 4 | // the same contact as mentioned in "to". This example uses a plain text message, but other types are also available.
 5 | // See the conversations-messages-create examples.
 6 | 
 7 | require(__DIR__ . '/../../autoload.php');
 8 | 
 9 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
10 | 
11 | $content = new \MessageBird\Objects\Conversation\Content();
12 | $content->text = 'Hello world';
13 | 
14 | $sendMessage = new \MessageBird\Objects\Conversation\SendMessage();
15 | $sendMessage->from = 'CHANNEL_ID';
16 | $sendMessage->to = 'RECIPIENT'; // Channel-specific, e.g. MSISDN for SMS.
17 | $sendMessage->content = $content;
18 | $sendMessage->type = 'text';
19 | 
20 | try {
21 |     $sendResult = $messageBird->conversationSend->send($sendMessage);
22 | 
23 |     var_dump($sendResult);
24 | } catch (\Exception $e) {
25 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
26 | }
27 | 


--------------------------------------------------------------------------------
/examples/lookup-hlr-view.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | try {
 8 |     $hlrObject             = new \MessageBird\Objects\Hlr();
 9 |     $hlrObject->msisdn     = '31624971134';
10 |     $hlrObject->reference  = "yoloswag3001";
11 | 
12 |     // create a new hlr request
13 |     $hlr = $messageBird->lookupHlr->create($hlrObject);
14 |     var_dump($hlr);
15 | 
16 |     // pool for the results
17 |     $poolCount = 10;
18 |     while ($poolCount--) {
19 |         $hlr = $messageBird->lookupHlr->read($hlrObject->msisdn);
20 |         if ($hlr->status !== \MessageBird\Objects\Hlr::STATUS_SENT) {
21 |             // we have something
22 |             var_dump($hlr);
23 |             break;
24 |         }
25 |         sleep(0.5);
26 |     }
27 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
28 |     // That means that your accessKey is unknown
29 |     echo 'wrong login';
30 | } catch (\Exception $e) {
31 |     var_dump($e->getMessage());
32 | }
33 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/PartnerAccount/Account.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Objects\PartnerAccount;
 4 | 
 5 | use MessageBird\Objects\Base;
 6 | 
 7 | class Account extends Base
 8 | {
 9 |     public $id;
10 | 
11 |     public $name;
12 | 
13 |     public $email;
14 | 
15 |     public $accessKeys = [];
16 | 
17 |     public $signingKey;
18 | 
19 |     /**
20 |      * @return false|string
21 |      * @throws \JsonException
22 |      */
23 |     public function loadToJson()
24 |     {
25 |         return json_encode([
26 |             'name' => $this->name,
27 |         ], \JSON_THROW_ON_ERROR);
28 |     }
29 | 
30 |     /**
31 |      * @param mixed $object
32 |      */
33 |     public function loadFromArray($object): Account
34 |     {
35 |         parent::loadFromArray($object);
36 | 
37 |         if (empty($this->accessKeys)) {
38 |             return $this;
39 |         }
40 | 
41 |         foreach ($this->accessKeys as &$item) {
42 |             $accessKey = new AccessKey();
43 |             $item = $accessKey->loadFromArray($item);
44 |         }
45 | 
46 |         return $this;
47 |     }
48 | }
49 | 


--------------------------------------------------------------------------------
/examples/voicemessages-create.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once(__DIR__ . '/../autoload.php');
 4 | 
 5 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 6 | 
 7 | $voiceMessage             = new \MessageBird\Objects\VoiceMessage();
 8 | $voiceMessage->recipients =  [31654286496];
 9 | $voiceMessage->body = 'This is a test message. The message is converted to speech and the recipient is called on his mobile.';
10 | $voiceMessage->language = 'en-gb';
11 | $voiceMessage->voice = 'female';
12 | $voiceMessage->ifMachine = 'continue'; // We don't care if it is a machine.
13 | 
14 | try {
15 |     $voiceMessageResult = $messageBird->voicemessages->create($voiceMessage);
16 |     var_dump($voiceMessageResult);
17 | } catch (\MessageBird\Exceptions\AuthenticateException $e) {
18 |     // That means that your accessKey is unknown
19 |     echo 'wrong login';
20 | } catch (\MessageBird\Exceptions\BalanceException $e) {
21 |     // That means that you are out of credits, so do something about it.
22 |     echo 'no balance';
23 | } catch (\Exception $e) {
24 |     echo $e->getMessage();
25 | }
26 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Base.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Objects;
 4 | 
 5 | use stdClass;
 6 | 
 7 | /**
 8 |  * Class Base
 9 |  *
10 |  * @package MessageBird\Objects
11 |  */
12 | class Base
13 | {
14 |     /**
15 |      * @deprecated 2.2.0 No longer used by internal code, please switch to {@see self::loadFromStdclass()}
16 |      * 
17 |      * @param mixed $object
18 |      *
19 |      * @return self
20 |      */
21 |     public function loadFromArray($object)
22 |     {
23 |         if ($object) {
24 |             foreach ($object as $key => $value) {
25 |                 if (property_exists($this, $key)) {
26 |                     $this->$key = $value;
27 |                 }
28 |             }
29 |         }
30 |         return $this;
31 |     }
32 | 
33 |     /**
34 |      * @param stdClass $object
35 |      * @return self
36 |      */
37 |     public function loadFromStdclass(stdClass $object)
38 |     {
39 |         foreach ($object as $key => $value) {
40 |             if (property_exists($this, $key)) {
41 |                 $this->$key = $value;
42 |             }
43 |         }
44 |         return $this;
45 |     }
46 | }
47 | 


--------------------------------------------------------------------------------
/examples/conversations/messages-create-media.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | // Sends a message to an existing conversation, with media as its content.
 4 | // Supported media types are 'audio', 'file', 'image' and 'video.
 5 | 
 6 | require(__DIR__ . '/../../autoload.php');
 7 | 
 8 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 9 | 
10 | $content = new \MessageBird\Objects\Conversation\Content();
11 | $content->image = [
12 |     'url' => 'https://cdn-gc.messagebird.com/assets/images/logo.png'
13 | ];
14 | 
15 | $message = new \MessageBird\Objects\Conversation\Message();
16 | $message->channelId = 'CHANNEL_ID';
17 | $message->content = $content;
18 | $message->to = 'RECIPIENT_MSISDN';
19 | $message->type = \MessageBird\Objects\Conversation\Content::TYPE_IMAGE; // 'image'
20 | 
21 | try {
22 |     // Using a contactId instead of a conversationId is also supported.
23 |     $conversation = $messageBird->conversationMessages->create(
24 |         'CONVERSATION_ID',
25 |         $message
26 |     );
27 | 
28 |     var_dump($conversation);
29 | } catch (\Exception $e) {
30 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
31 | }
32 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "messagebird/php-rest-api",
 3 |     "description": "MessageBird REST API client for PHP",
 4 |     "type": "library",
 5 |     "homepage": "https://github.com/messagebird/php-rest-api",
 6 |     "license": "BSD-2-Clause",
 7 |     "authors": [
 8 |         {
 9 |             "name": "MessageBird",
10 |             "email": "info@messagebird.com"
11 |         }
12 |     ],
13 |     "support": {
14 |         "docs": "https://developers.messagebird.com/api",
15 |         "issues": "https://github.com/messagebird/php-rest-api/issues",
16 |         "source": "https://github.com/messagebird/php-rest-api"
17 |     },
18 |     "require": {
19 |         "php": ">=7.3|~8.0.0|~8.1.0|~8.2.0",
20 |         "ext-curl": "*",
21 |         "ext-json": "*",
22 |         "firebase/php-jwt": "^5.5.1|^6.2"
23 |     },
24 |     "require-dev": {
25 |         "phpunit/phpunit": "^9.5.14",
26 |         "vimeo/psalm": "4.18.1"
27 |     },
28 |     "autoload": {
29 |         "psr-4": {
30 |             "MessageBird\\": "src/MessageBird/"
31 |         }
32 |     },
33 |     "autoload-dev": {
34 |         "psr-4": {
35 |             "Tests\\": "tests/"
36 |         }
37 |     }
38 | }
39 | 


--------------------------------------------------------------------------------
/examples/conversations/enable-whatsapp-sandbox.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | // Initiates a conversation by sending a first message. This example uses a
 4 | // plain text message, but other types are also available. See the
 5 | // conversations-messages-create examples.
 6 | 
 7 | require(__DIR__ . '/../../autoload.php');
 8 | 
 9 | // Set your own API access key here.
10 | // Create a client with WhatsApp sandbox enabled.
11 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY', null, [\MessageBird\Client::ENABLE_CONVERSATIONSAPI_WHATSAPP_SANDBOX]);
12 | 
13 | // Use WhatsApp sandbox channel as normal.
14 | 
15 | $content = new \MessageBird\Objects\Conversation\Content();
16 | $content->text = 'Hello world';
17 | 
18 | $message = new \MessageBird\Objects\Conversation\Message();
19 | $message->channelId = 'WHATSAPP_SANDBOX_CHANNEL_ID';
20 | $message->content = $content;
21 | $message->to = 'RECIPIENT'; // Channel-specific, e.g. MSISDN for SMS.
22 | $message->type = 'text';
23 | 
24 | try {
25 |     $conversation = $messageBird->conversations->start($message);
26 | 
27 |     var_dump($conversation);
28 | } catch (\Exception $e) {
29 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
30 | }
31 | 


--------------------------------------------------------------------------------
/autoload.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | if (file_exists(__DIR__.'/vendor/autoload.php')) {
 4 |     require_once __DIR__.'/vendor/autoload.php';
 5 | } else {
 6 |     spl_autoload_register(function ($class) {
 7 |         // project-specific namespace prefix
 8 |         $prefix = 'MessageBird\\';
 9 | 
10 |         // base directory for the namespace prefix
11 |         $base_dir = __DIR__ . '/src/MessageBird/';
12 | 
13 |         // does the class use the namespace prefix?
14 |         $len = strlen($prefix);
15 |         if (strncmp($prefix, $class, $len) !== 0) {
16 |             // no, move to the next registered autoloader
17 |             return;
18 |         }
19 | 
20 |         // get the relative class name
21 |         $relative_class = substr($class, $len);
22 | 
23 |         // replace the namespace prefix with the base directory, replace namespace
24 |         // separators with directory separators in the relative class name, append
25 |         // with .php
26 |         $file = $base_dir . str_replace('\\', '/', $relative_class) . '.php';
27 | 
28 |         // if the file exists, require it
29 |         if (file_exists($file)) {
30 |             require $file;
31 |         }
32 |     });
33 | }
34 | 


--------------------------------------------------------------------------------
/examples/verify-create-email.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | use MessageBird\Client;
 4 | use MessageBird\Exceptions\AuthenticateException;
 5 | use MessageBird\Exceptions\BalanceException;
 6 | use MessageBird\Objects\Verify;
 7 | 
 8 | require_once(__DIR__ . '/../autoload.php');
 9 | 
10 | $messageBird = new Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
11 | 
12 | $verify = new Verify();
13 | $verify->recipient = 'Client Name <client-email@example.com>';
14 | 
15 | $extraOptions = [
16 |     'type' => 'email',
17 |     // This email domain needs to be set up as an email channel in your account at https://dashboard.messagebird.com/en/channels/
18 |     'originator' => 'Email Verification <verify@company.com>',
19 |     'timeout' => 60,
20 | ];
21 | 
22 | try {
23 |     $verifyResult = $messageBird->verify->create($verify, $extraOptions);
24 |     var_dump($verifyResult);
25 | } catch (AuthenticateException $e) {
26 |     // That means that your accessKey is unknown
27 |     echo 'wrong login';
28 | } catch (BalanceException $e) {
29 |     // That means that you are out of credits, so do something about it.
30 |     echo 'no balance';
31 | } catch (\Exception $e) {
32 |     echo $e->getMessage();
33 | }
34 | 


--------------------------------------------------------------------------------
/examples/conversations/webhooks-create.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | // Webhooks enable real-time notifications of conversation events to be
 4 | // delivered to endpoints on your own server. This example creates a webhook
 5 | // that is invoked when new conversations and messages are created in the
 6 | // specified channel.
 7 | 
 8 | require(__DIR__ . '/../../autoload.php');
 9 | 
10 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
11 | 
12 | try {
13 |     $webhook = new \MessageBird\Objects\Conversation\Webhook();
14 |     $webhook->channelId = 'CHANNEL_ID';
15 |     $webhook->url = 'https://example.com/webhook';
16 |     $webhook->events = [
17 |         \MessageBird\Objects\Conversation\Webhook::EVENT_CONVERSATION_CREATED,
18 |         \MessageBird\Objects\Conversation\Webhook::EVENT_MESSAGE_CREATED,
19 | 
20 |         // Other options:
21 |         // \MessageBird\Objects\Conversation\Webhook::EVENT_CONVERSATION_UPDATED,
22 |         // \MessageBird\Objects\Conversation\Webhook::EVENT_MESSAGE_UPDATED,
23 |     ];
24 | 
25 |     $messageBird->conversationWebhooks->create($webhook);
26 | } catch (\Exception $e) {
27 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
28 | }
29 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Voice/Webhook.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Objects\Voice;
 4 | 
 5 | use MessageBird\Objects\Base;
 6 | 
 7 | class Webhook extends Base
 8 | {
 9 |     /**
10 |      * The callback URL that will be requested when the MessageBird platform sends a webhook.
11 |      *
12 |      * @var string
13 |      */
14 |     public $url;
15 |     /**
16 |      * The secret used for signing webhook requests.
17 |      *
18 |      * @var string
19 |      * @see https://developers.messagebird.com/docs/voice-calling#handle-callbacks
20 |      */
21 |     public $token;
22 |     /**
23 |      * The unique ID of the webhook
24 |      *
25 |      * @var string
26 |      */
27 |     protected $id;
28 |     /**
29 |      * The date and time the webhook was created
30 |      *
31 |      * @var string
32 |      */
33 |     protected $createdAt;
34 | 
35 |     /**
36 |      * The date and time the webhook was last updated
37 |      *
38 |      * @var string
39 |      */
40 |     protected $updatedAt;
41 | 
42 |     public function getId(): string
43 |     {
44 |         return $this->id;
45 |     }
46 | 
47 |     public function getCreatedAt(): string
48 |     {
49 |         return $this->createdAt;
50 |     }
51 | 
52 |     public function getUpdatedAt(): string
53 |     {
54 |         return $this->updatedAt;
55 |     }
56 | }
57 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Number.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Objects;
 4 | 
 5 | /**
 6 |  * Class Number
 7 |  *
 8 |  * Represents a specific phone number
 9 |  *
10 |  * @package MessageBird\Objects
11 |  */
12 | class Number extends Base
13 | {
14 |     /**
15 |      * The phone number in E.164 format without the prefixed plus-sign.
16 |      * @var string
17 |      */
18 |     public $number;
19 | 
20 |     /**
21 |      * The Number's country
22 |      * @var string
23 |      */
24 |     public $country;
25 | 
26 |     /**
27 |      * The country code for this number in ISO 3166-1 alpha-2 format.
28 |      * @var string
29 |      */
30 |     public $region;
31 | 
32 |     /**
33 |      * Finer-grained locality for this Number
34 |      * @var string
35 |      */
36 |     public $locality;
37 | 
38 |     /**
39 |      * The available features for this Number
40 |      * @var array
41 |      */
42 |     public $features;
43 | 
44 |     /**
45 |      * Additional user-provided tags for this Number
46 |      * @var array
47 |      */
48 |     public $tags = [];
49 | 
50 |     /**
51 |      * Number type (example: landline, mobile).
52 |      * @var string
53 |      */
54 |     public $type;
55 | 
56 |     /**
57 |      * Number availability and current activated status
58 |      * @var string
59 |      */
60 |     public $status;
61 | }
62 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | BSD 2-Clause License
 2 | 
 3 | Copyright (c) 2014, MessageBird
 4 | All rights reserved.
 5 | 
 6 | Redistribution and use in source and binary forms, with or without
 7 | modification, are permitted provided that the following conditions are met:
 8 | 
 9 | 1. Redistributions of source code must retain the above copyright notice, this
10 |    list of conditions and the following disclaimer.
11 | 
12 | 2. Redistributions in binary form must reproduce the above copyright notice,
13 |    this list of conditions and the following disclaimer in the documentation
14 |    and/or other materials provided with the distribution.
15 | 
16 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
20 | FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
23 | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24 | OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


--------------------------------------------------------------------------------
/src/MessageBird/Resources/Verify.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Resources;
 4 | 
 5 | use MessageBird\Common;
 6 | use MessageBird\Exceptions\AuthenticateException;
 7 | use MessageBird\Exceptions\HttpException;
 8 | use MessageBird\Exceptions\RequestException;
 9 | use MessageBird\Exceptions\ServerException;
10 | use MessageBird\Objects;
11 | 
12 | /**
13 |  * Class Verify
14 |  *
15 |  * @package MessageBird\Resources
16 |  */
17 | class Verify extends Base
18 | {
19 |     public function __construct(Common\HttpClient $httpClient)
20 |     {
21 |         $this->object = new Objects\Verify();
22 |         $this->setResourceName('verify');
23 | 
24 |         parent::__construct($httpClient);
25 |     }
26 | 
27 |     /**
28 |      * @param mixed $id
29 |      * @param mixed $token
30 |      *
31 |      * @return Objects\Balance|Objects\Conversation\Conversation|Objects\Hlr|Objects\Lookup|Objects\Message|Objects\Verify|Objects\VoiceMessage|null
32 |      *
33 |      * @throws HttpException
34 |      * @throws RequestException
35 |      * @throws ServerException|AuthenticateException
36 |      */
37 |     public function verify($id, $token)
38 |     {
39 |         $resourceName = $this->resourceName . (($id) ? '/' . $id : null);
40 |         [, , $body] = $this->httpClient->performHttpRequest(
41 |             Common\HttpClient::REQUEST_GET,
42 |             $resourceName,
43 |             ['token' => $token]
44 |         );
45 |         return $this->processRequest($body);
46 |     }
47 | }
48 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Voice/Transcription.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Objects\Voice;
 4 | 
 5 | use MessageBird\Objects\Base;
 6 | 
 7 | class Transcription extends Base
 8 | {
 9 |     /**
10 |      * The unique ID of the transcription
11 |      *
12 |      * @var string
13 |      */
14 |     protected $id;
15 | 
16 |     /**
17 |      * The ID of the recording that this transcription belongs to
18 |      *
19 |      * @var string
20 |      */
21 |     protected $recordingId;
22 | 
23 |     /**
24 |      * In case that an error was occurred while executing the transcription request, it appears here
25 |      *
26 |      * @var string
27 |      */
28 |     protected $error;
29 | 
30 |     /**
31 |      * The date and time the transcription was created
32 |      *
33 |      * @var string
34 |      */
35 |     protected $createdAt;
36 | 
37 |     /**
38 |      * The date and time the transcription was last updated
39 |      *
40 |      * @var string
41 |      */
42 |     protected $updatedAt;
43 | 
44 |     public function getId(): string
45 |     {
46 |         return $this->id;
47 |     }
48 | 
49 |     public function getRecordingId(): string
50 |     {
51 |         return $this->recordingId;
52 |     }
53 | 
54 |     public function getError(): string
55 |     {
56 |         return $this->error;
57 |     }
58 | 
59 |     public function getCreatedAt(): string
60 |     {
61 |         return $this->createdAt;
62 |     }
63 | 
64 |     public function getUpdatedAt(): string
65 |     {
66 |         return $this->updatedAt;
67 |     }
68 | }
69 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/EmailMessage.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Objects;
 4 | 
 5 | /**
 6 |  * Class EmailMessage
 7 |  *
 8 |  * @package MessageBird\Objects
 9 |  */
10 | class EmailMessage extends Base
11 | {
12 |     /**
13 |      * An unique random ID which is created on the MessageBird
14 |      * platform and is returned upon creation of the object.
15 |      *
16 |      * @var string
17 |      */
18 |     protected $id;
19 | 
20 |     /**
21 |      * The status of the Email Message.
22 |      *
23 |      * @var string
24 |      */
25 |     protected $status;
26 | 
27 |     /**
28 |      * Failure code in the event that something went wrong
29 |      *
30 |      * @var int|null
31 |      */
32 |     protected $failure_code;
33 | 
34 |     /**
35 |      * Failure description in the event that something went wrong
36 |      *
37 |      * @var string|null
38 |      */
39 |     protected $failure_description;
40 | 
41 |     /**
42 |      * Get the created id
43 |      */
44 |     public function getId(): string
45 |     {
46 |         return $this->id;
47 |     }
48 | 
49 |     /**
50 |      * Get the status
51 |      */
52 |     public function getStatus(): string
53 |     {
54 |         return $this->status;
55 |     }
56 | 
57 |     /**
58 |      * @return int|null
59 |      */
60 |     public function getFailureCode()
61 |     {
62 |         return $this->failure_code;
63 |     }
64 | 
65 |     /**
66 |      * @return string|null
67 |      */
68 |     public function getFailureDescription()
69 |     {
70 |         return $this->failure_description;
71 |     }
72 | }
73 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Recipients.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Objects;
 4 | 
 5 | use stdClass;
 6 | 
 7 | /**
 8 |  * Class Recipients
 9 |  *
10 |  * @package MessageBird\Objects
11 |  */
12 | class Recipients extends Base
13 | {
14 |     /**
15 |      * @var int
16 |      */
17 |     public $totalCount;
18 | 
19 |     /**
20 |      * @var int
21 |      */
22 |     public $totalSentCount;
23 | 
24 |     /**
25 |      * @var int
26 |      */
27 |     public $totalDeliveredCount;
28 | 
29 |     /**
30 |      * @var int
31 |      */
32 |     public $totalDeliveryFailedCount;
33 | 
34 |     /**
35 |      * @var Recipient[]
36 |      */
37 |     public $items;
38 | 
39 |     /**
40 |      * @deprecated 2.2.0 No longer used by internal code, please switch to {@see self::loadFromStdclass()}
41 |      * 
42 |      * @param $object
43 |      *
44 |      * @return $this|void
45 |      */
46 |     public function loadFromArray($object): self
47 |     {
48 |         parent::loadFromArray($object);
49 | 
50 |         foreach ($this->items as &$item) {
51 |             $recipient = new Recipient();
52 |             $recipient->loadFromArray($item);
53 | 
54 |             $item = $recipient;
55 |         }
56 | 
57 |         return $this;
58 |     }
59 | 
60 |     public function loadFromStdclass(stdClass $object): self
61 |     {
62 |         parent::loadFromStdclass($object);
63 | 
64 |         foreach ($this->items as &$item) {
65 |             $recipient = new Recipient();
66 |             $recipient->loadFromStdclass($item);
67 | 
68 |             $item = $recipient;
69 |         }
70 | 
71 |         return $this;
72 |     }
73 | }
74 | 


--------------------------------------------------------------------------------
/examples/conversations/create-hsm.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | // Initiates a conversation by sending a first message. This example uses a hsm message.
 4 | 
 5 | require(__DIR__ . '/../../autoload.php');
 6 | 
 7 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
 8 | 
 9 | $hsmParam1 = new \MessageBird\Objects\Conversation\HSM\Params();
10 | $hsmParam1->default = 'YOUR FIRST TEMPLATE PARAM VALUE';
11 | 
12 | $hsmParam2 = new \MessageBird\Objects\Conversation\HSM\Params();
13 | $hsmParam2->default = 'YOUR SECOND TEMPLATE PARAM VALUE';
14 | 
15 | $hsmLanguage = new \MessageBird\Objects\Conversation\HSM\Language();
16 | $hsmLanguage->policy = \MessageBird\Objects\Conversation\HSM\Language::DETERMINISTIC_POLICY;
17 | //$hsmLanguage->policy = \MessageBird\Objects\Conversation\HSM\Language::FALLBACK_POLICY;
18 | $hsmLanguage->code = 'YOUR LANGUAGE CODE';
19 | 
20 | $hsm = new \MessageBird\Objects\Conversation\HSM\Message();
21 | $hsm->templateName = 'YOUR TEMPLATE NAME';
22 | $hsm->namespace = 'YOUR NAMESPACE';
23 | $hsm->params = [$hsmParam1, $hsmParam2];
24 | $hsm->language = $hsmLanguage;
25 | 
26 | $content = new \MessageBird\Objects\Conversation\Content();
27 | $content->hsm = $hsm;
28 | 
29 | $message = new \MessageBird\Objects\Conversation\Message();
30 | $message->channelId = 'YOUR CHANNEL ID';
31 | $message->content = $content;
32 | $message->to = 'YOUR MSISDN';
33 | $message->type = 'hsm';
34 | 
35 | try {
36 |     $conversation = $messageBird->conversations->start($message);
37 | 
38 |     var_dump($conversation);
39 | } catch (\Exception $e) {
40 |     echo sprintf("%s: %s", get_class($e), $e->getMessage());
41 | }
42 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Voice/Recording.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Objects\Voice;
 4 | 
 5 | use MessageBird\Objects\Base;
 6 | 
 7 | class Recording extends Base
 8 | {
 9 |     /**
10 |      * The unique ID of the recording
11 |      *
12 |      * @var string
13 |      */
14 |     protected $id;
15 | 
16 |     /**
17 |      * The ID of the leg that this recording belongs to
18 |      *
19 |      * @var string
20 |      */
21 |     protected $legId;
22 | 
23 |     /**
24 |      * The status of the recording. Possible values: initialised, queued, recording, paused, done, failed, canceled
25 |      *
26 |      * @var string
27 |      */
28 |     protected $status;
29 | 
30 |     /**
31 |      * The duration of the recording in seconds.
32 |      *
33 |      * @var int
34 |      */
35 |     protected $duration;
36 | 
37 |     /**
38 |      * The date and time the recording was created
39 |      *
40 |      * @var string
41 |      */
42 |     protected $createdAt;
43 | 
44 |     /**
45 |      * The date and time the recording was last updated
46 |      *
47 |      * @var string
48 |      */
49 |     protected $updatedAt;
50 | 
51 |     public function getId(): string
52 |     {
53 |         return $this->id;
54 |     }
55 | 
56 |     public function getLegId(): string
57 |     {
58 |         return $this->legId;
59 |     }
60 | 
61 |     public function getStatus(): string
62 |     {
63 |         return $this->status;
64 |     }
65 | 
66 |     public function getDuration(): int
67 |     {
68 |         return $this->duration;
69 |     }
70 | 
71 |     public function getCreatedAt(): string
72 |     {
73 |         return $this->createdAt;
74 |     }
75 | 
76 |     public function getUpdatedAt(): string
77 |     {
78 |         return $this->updatedAt;
79 |     }
80 | }
81 | 


--------------------------------------------------------------------------------
/src/MessageBird/Resources/Lookup.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Resources;
 4 | 
 5 | use InvalidArgumentException;
 6 | use MessageBird\Common;
 7 | use MessageBird\Exceptions\AuthenticateException;
 8 | use MessageBird\Exceptions\HttpException;
 9 | use MessageBird\Exceptions\RequestException;
10 | use MessageBird\Exceptions\ServerException;
11 | use MessageBird\Objects;
12 | 
13 | /**
14 |  * Class Verify
15 |  *
16 |  * @package MessageBird\Resources
17 |  */
18 | class Lookup extends Base
19 | {
20 |     public function __construct(Common\HttpClient $httpClient)
21 |     {
22 |         $this->object = new Objects\Lookup();
23 |         $this->setResourceName('lookup');
24 | 
25 |         parent::__construct($httpClient);
26 |     }
27 | 
28 |     /**
29 |      * @no-named-arguments
30 |      *
31 |      * @param string|int $phoneNumber
32 |      * @param string|null $countryCode
33 |      *
34 |      * @return Objects\Balance|Objects\Conversation\Conversation|Objects\Hlr|Objects\Lookup|Objects\Message|Objects\Verify|Objects\VoiceMessage|null
35 |      *
36 |      * @throws HttpException
37 |      * @throws RequestException
38 |      * @throws ServerException
39 |      * @throws AuthenticateException
40 |      */
41 |     public function read($phoneNumber = null, ?string $countryCode = null)
42 |     {
43 |         if (empty($phoneNumber)) {
44 |             throw new InvalidArgumentException('The phone number cannot be empty.');
45 |         }
46 |         $query = null;
47 |         if ($countryCode !== null) {
48 |             $query = ["countryCode" => $countryCode];
49 |         }
50 |         $resourceName = $this->resourceName . '/' . $phoneNumber;
51 |         [, , $body] = $this->httpClient->performHttpRequest(Common\HttpClient::REQUEST_GET, $resourceName, $query);
52 |         return $this->processRequest($body);
53 |     }
54 | }
55 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Voice/CallFlow.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Objects\Voice;
 4 | 
 5 | use MessageBird\Objects\Base;
 6 | 
 7 | class CallFlow extends Base
 8 | {
 9 |     /**
10 |      * The title of the call flow
11 |      *
12 |      * @var string
13 |      * @deprecated
14 |      */
15 |     public $title;
16 |     /**
17 |      * An array of step objects.
18 |      *
19 |      * The sequence of the array items describe the order of execution, where the first item will be executed first,
20 |      * than the second, etcetera.
21 |      *
22 |      * @var Step[]
23 |      */
24 |     public $steps;
25 |     /**
26 |      * The unique ID of the call
27 |      *
28 |      * @var string
29 |      */
30 |     protected $id;
31 |     /**
32 |      * The date and time the call flow was created
33 |      *
34 |      * @var string
35 |      */
36 |     protected $createdAt;
37 | 
38 |     /**
39 |      * The date and time the call flow was last updated
40 |      *
41 |      * @var string
42 |      */
43 |     protected $updatedAt;
44 | 
45 |     function __construct() {
46 |         if ($this->title == null) {
47 |             unset($this->title);
48 |         }
49 |     }
50 | 
51 |     /**
52 |      * @inheritdoc
53 |      */
54 |     public function loadFromArray($object): self
55 |     {
56 |         parent::loadFromArray($object);
57 | 
58 |         foreach ($this->steps as &$item) {
59 |             $step = new Step();
60 |             $step->loadFromArray($item);
61 | 
62 |             $item = $step;
63 |         }
64 | 
65 |         return $this;
66 |     }
67 | 
68 |     public function getId()
69 |     {
70 |         return $this->id;
71 |     }
72 | 
73 |     public function getCreatedAt(): string
74 |     {
75 |         return $this->createdAt;
76 |     }
77 | 
78 |     public function getUpdatedAt(): string
79 |     {
80 |         return $this->updatedAt;
81 |     }
82 | }
83 | 


--------------------------------------------------------------------------------
/src/MessageBird/Resources/Conversation/Send.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Resources\Conversation;
 4 | 
 5 | use MessageBird\Common\HttpClient;
 6 | use MessageBird\Exceptions;
 7 | use MessageBird\Objects\Balance;
 8 | use MessageBird\Objects\Conversation\Conversation;
 9 | use MessageBird\Objects\Conversation\SendMessage;
10 | use MessageBird\Objects\Conversation\SendMessageResult;
11 | use MessageBird\Objects\Hlr;
12 | use MessageBird\Objects\Lookup;
13 | use MessageBird\Objects\Message;
14 | use MessageBird\Objects\Verify;
15 | use MessageBird\Objects\VoiceMessage;
16 | use MessageBird\Resources\Base;
17 | 
18 | class Send extends Base
19 | {
20 |     public const RESOURCE_NAME = 'send';
21 | 
22 |     public function __construct(HttpClient $httpClient)
23 |     {
24 |         parent::__construct($httpClient);
25 | 
26 |         $this->object = new SendMessageResult();
27 |         $this->setResourceName(self::RESOURCE_NAME);
28 |     }
29 | 
30 |     /**
31 |      * Starts a conversation or adding a message to the conversation when a conversation with the contact already exist.
32 |      *
33 |      * @return Balance|Conversation|Hlr|Lookup|Message|Verify|VoiceMessage|null
34 |      *
35 |      * @throws Exceptions\AuthenticateException
36 |      * @throws Exceptions\BalanceException
37 |      * @throws Exceptions\HttpException
38 |      * @throws Exceptions\RequestException
39 |      * @throws Exceptions\ServerException
40 |      * @throws \JsonException
41 |      */
42 |     public function send(SendMessage $object, ?array $query = null)
43 |     {
44 |         $body = json_encode($object, \JSON_THROW_ON_ERROR);
45 | 
46 |         [, , $resultBody] = $this->httpClient->performHttpRequest(
47 |             HttpClient::REQUEST_POST,
48 |             $this->getResourceName(),
49 |             $query,
50 |             $body
51 |         );
52 | 
53 |         return $this->processRequest($resultBody);
54 |     }
55 | }
56 | 


--------------------------------------------------------------------------------
/src/MessageBird/Resources/PhoneNumbers.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Resources;
 4 | 
 5 | use MessageBird\Common\HttpClient;
 6 | use MessageBird\Objects;
 7 | 
 8 | /**
 9 |  * Class PhoneNumbers
10 |  *
11 |  * @package MessageBird\Resources
12 |  */
13 | class PhoneNumbers extends Base
14 | {
15 |     /**
16 |      * @var HttpClient
17 |      */
18 |     protected $httpClient;
19 | 
20 |     public function __construct(HttpClient $httpClient)
21 |     {
22 |         $this->object = new Objects\Number();
23 |         $this->setResourceName('phone-numbers');
24 | 
25 |         parent::__construct($httpClient);
26 |     }
27 | 
28 |     /**
29 |      * @param mixed $object
30 |      * @param mixed $id
31 |      *
32 |      * @return Objects\Balance|Objects\Conversation\Conversation|Objects\Hlr|Objects\Lookup|Objects\Message|Objects\Verify|Objects\VoiceMessage|null
33 |      *
34 |      * @throws \JsonException
35 |      * @throws \MessageBird\Exceptions\AuthenticateException
36 |      * @throws \MessageBird\Exceptions\HttpException
37 |      * @throws \MessageBird\Exceptions\RequestException
38 |      * @throws \MessageBird\Exceptions\ServerException
39 |      * @internal param array $parameters
40 |      */
41 |     public function update($object, $id)
42 |     {
43 |         $objVars = get_object_vars($object);
44 |         $body = [];
45 |         foreach ($objVars as $key => $value) {
46 |             if ($value !== null) {
47 |                 $body[$key] = $value;
48 |             }
49 |         }
50 | 
51 |         $resourceName = $this->resourceName . ($id ? '/' . $id : null);
52 |         $body = json_encode($body, \JSON_THROW_ON_ERROR);
53 | 
54 |         // This override is only needed to use the PATCH http method
55 |         [, , $body] = $this->httpClient->performHttpRequest(
56 |             HttpClient::REQUEST_PATCH,
57 |             $resourceName,
58 |             false,
59 |             $body
60 |         );
61 |         return $this->processRequest($body);
62 |     }
63 | }
64 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Conversation/Contact.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Objects\Conversation;
 4 | 
 5 | use MessageBird\Objects\Base;
 6 | use stdClass;
 7 | 
 8 | /**
 9 |  * Represents a counterparty with who messages can be exchanged.
10 |  */
11 | class Contact extends Base
12 | {
13 |     /**
14 |      * A unique ID generated by the MessageBird platform that identifies the
15 |      * contact.
16 |      *
17 |      * @var string
18 |      */
19 |     public $id;
20 | 
21 |     /**
22 |      * The URL of this contact object.
23 |      *
24 |      * @var string
25 |      */
26 |     public $href;
27 | 
28 |     /**
29 |      * The MSISDN/phone number of this contact.
30 |      *
31 |      * @var int|null
32 |      */
33 |     public $msisdn;
34 | 
35 |     /**
36 |      * @var string
37 |      */
38 |     public $firstName;
39 | 
40 |     /**
41 |      * @var string
42 |      */
43 |     public $lastName;
44 | 
45 |     /**
46 |      * An associative array containing additional details about this contact.
47 |      *
48 |      * @var array
49 |      */
50 |     public $customDetails;
51 | 
52 |     /**
53 |      * The date and time when this contact was first created in RFC3339
54 |      * format.
55 |      *
56 |      * @var string
57 |      */
58 |     public $createdDatetime;
59 | 
60 |     /**
61 |      * The date and time when this contact was most recently updated in
62 |      * RFC3339 format.
63 |      *
64 |      * @var string
65 |      */
66 |     public $updatedDatetime;
67 | 
68 |     /**
69 |      * @deprecated 2.2.0 No longer used by internal code, please switch to {@see self::loadFromStdclass()}
70 |      * 
71 |      * @param mixed $object
72 |      */
73 |     public function loadFromArray($object): Contact
74 |     {
75 |         parent::loadFromArray($object);
76 | 
77 |         if (!empty($this->customDetails)) {
78 |             $this->customDetails = (array)$this->customDetails;
79 |         }
80 | 
81 |         return $this;
82 |     }
83 | 
84 |     public function loadFromStdclass(stdClass $object): self
85 |     {
86 |         parent::loadFromStdclass($object);
87 | 
88 |         if (!empty($this->customDetails)) {
89 |             $this->customDetails = (array)$this->customDetails;
90 |         }
91 | 
92 |         return $this;
93 |     }
94 | }
95 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Conversation/SendMessage.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Objects\Conversation;
 4 | 
 5 | use JsonSerializable;
 6 | use MessageBird\Objects\Base;
 7 | use stdClass;
 8 | 
 9 | /**
10 |  * Message that is send via the /send endpoint of the Conversations API
11 |  */
12 | class SendMessage extends Base implements JsonSerializable
13 | {
14 |     /**
15 |      * Either a channel-specific identifier for the receiver (e.g. MSISDN for SMS or WhatsApp channels),
16 |      * or the ID of a MessageBird Contact.
17 |      *
18 |      * @var string
19 |      */
20 |     public $to;
21 | 
22 |     /**
23 |      * The ID that identifies the channel over which the message should be sent.
24 |      *
25 |      * @var string
26 |      */
27 |     public $from;
28 | 
29 |     /**
30 |      * Type of this message's content. Possible values: "text", "image",
31 |      * "audio", "video", "file", "location".
32 |      *
33 |      * @var string
34 |      */
35 |     public $type;
36 | 
37 |     /**
38 |      * Content of the message. Implementation dependent on this message's type.
39 |      *
40 |      * @var Content
41 |      */
42 |     public $content;
43 | 
44 |     /**
45 |      * The URL for delivery of status reports for the message. Must be HTTPS.
46 |      *
47 |      * @var string
48 |      */
49 |     public $reportUrl;
50 | 
51 |     /**
52 |      * The additional settings to send a Fallback message if the primary delivery fails
53 |      *
54 |      * @var Fallback
55 |      */
56 |     public $fallback;
57 | 
58 |     /**
59 |      * The source of the response/action that sent the message.
60 |      *
61 |      * @var stdClass
62 |      */
63 |     public $source;
64 | 
65 |     /**
66 |      * Mark the message with a particular MessageBird Message Tag. The meaning and effect of each tag depend on each
67 |      * specific platform.
68 |      *
69 |      * @var string
70 |      */
71 |     public $tag;
72 | 
73 |     /**
74 |      * Serialize only non empty fields.
75 |      */
76 |     public function jsonSerialize(): array
77 |     {
78 |         $json = [];
79 | 
80 |         foreach (get_object_vars($this) as $key => $value) {
81 |             if (!empty($value)) {
82 |                 $json[$key] = $value;
83 |             }
84 |         }
85 | 
86 |         return $json;
87 |     }
88 | }
89 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Conversation/Channel.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Objects\Conversation;
 4 | 
 5 | use MessageBird\Objects\Base;
 6 | 
 7 | /**
 8 |  * Channels represent a platform that messages can be sent and received on. You
 9 |  * can configure your channels via the MessageBird dashboard. A conversation
10 |  * can take place over multiple channels simultaneously.
11 |  */
12 | class Channel extends Base
13 | {
14 |     public const STATUS_ACTIVE = 'active';
15 |     public const STATUS_ACTIVATING = 'activating';
16 |     public const STATUS_ACTIVATION_CODE_REQUIRED = 'activation_code_required';
17 |     public const STATUS_ACTIVATION_REQUIRED = 'activation_required';
18 |     public const STATUS_DELETED = 'deleted';
19 |     public const STATUS_INACTIVE = 'inactive';
20 |     public const STATUS_PENDING = 'pending';
21 |     public const STATUS_UNAVAILABLE = 'unavailable';
22 |     public const STATUS_ACTION_REQUIRED = 'action_required';
23 |     public const STATUS_ACTIVATION_FAILED = 'activation_failed';
24 |     public const STATUS_NOT_VERIFIED = 'not_verified';
25 | 
26 |     /**
27 |      * The unique ID generated by the MessageBird platform that identifies this
28 |      * channel.
29 |      *
30 |      * @var string
31 |      */
32 |     public $id;
33 | 
34 |     /**
35 |      * The name of this channel (configured through the MessageBird dashboard).
36 |      *
37 |      * @var string
38 |      */
39 |     public $name;
40 | 
41 |     /**
42 |      * A unique identifier for the platform that is used by this channel, for
43 |      * example: sms, telegram or messenger.
44 |      *
45 |      * @var string
46 |      */
47 |     public $platformId;
48 | 
49 |     /**
50 |      * The status of this channel. Only active channels can be used for
51 |      * messaging. Can be one of inactive, active, pending, activation_required,
52 |      * activation_code_required, activating, and deleted.
53 |      *
54 |      * @var string
55 |      */
56 |     public $status;
57 | 
58 |     /**
59 |      * The datetime when the message was created (in RFC3339 format).
60 |      *
61 |      * @var string
62 |      */
63 |     public $createdDatetime;
64 | 
65 |     /**
66 |      * The datetime when the message was updated (in RFC3339 format).
67 |      *
68 |      * @var string
69 |      */
70 |     public $updatedDatetime;
71 | }
72 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Voice/Call.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace MessageBird\Objects\Voice;
  4 | 
  5 | use MessageBird\Objects\Base;
  6 | 
  7 | class Call extends Base
  8 | {
  9 |     /**
 10 |      * The caller ID of the call
 11 |      *
 12 |      * @var string
 13 |      */
 14 |     public $source;
 15 |     /**
 16 |      * The number/address to be called.
 17 |      *
 18 |      * @var string
 19 |      */
 20 |     public $destination;
 21 |     /**
 22 |      * The call flow object to be executed when the call is answered.
 23 |      *
 24 |      * @var CallFlow
 25 |      */
 26 |     public $callFlow;
 27 |     /**
 28 |      * The unique ID of the call
 29 |      *
 30 |      * @var string
 31 |      */
 32 |     protected $id;
 33 |     /**
 34 |      * The unique ID of the number that is/was called
 35 |      *
 36 |      * @var string
 37 |      */
 38 |     protected $numberId;
 39 | 
 40 |     /**
 41 |      * The status of the call. Possible values: starting, ongoing, ended.
 42 |      *
 43 |      * @var string
 44 |      */
 45 |     protected $status;
 46 | 
 47 |     /**
 48 |      * The date and time the call was created
 49 |      *
 50 |      * @var string
 51 |      */
 52 |     protected $createdAt;
 53 | 
 54 |     /**
 55 |      * The date and time the call was last updated
 56 |      *
 57 |      * @var string
 58 |      */
 59 |     protected $updatedAt;
 60 | 
 61 |     /**
 62 |      * The date and time the call ended
 63 |      *
 64 |      * @var string
 65 |      */
 66 |     protected $endedAt;
 67 | 
 68 |     /**
 69 |      * @inheritdoc
 70 |      */
 71 |     public function loadFromArray($object): self
 72 |     {
 73 |         parent::loadFromArray($object);
 74 | 
 75 |         if (!empty($this->callFlow)) {
 76 |             $callFlow = new CallFlow();
 77 |             $this->callFlow = $callFlow->loadFromArray($this->callFlow);
 78 |         }
 79 | 
 80 |         return $this;
 81 |     }
 82 | 
 83 |     public function getId(): string
 84 |     {
 85 |         return $this->id;
 86 |     }
 87 | 
 88 |     public function getNumberId(): string
 89 |     {
 90 |         return $this->numberId;
 91 |     }
 92 | 
 93 |     public function getStatus(): string
 94 |     {
 95 |         return $this->status;
 96 |     }
 97 | 
 98 |     public function getCreatedAt(): string
 99 |     {
100 |         return $this->createdAt;
101 |     }
102 | 
103 |     public function getUpdatedAt(): string
104 |     {
105 |         return $this->updatedAt;
106 |     }
107 | 
108 |     public function getEndedAt(): string
109 |     {
110 |         return $this->endedAt;
111 |     }
112 | }
113 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Conversation/Webhook.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Objects\Conversation;
 4 | 
 5 | use JsonSerializable;
 6 | use MessageBird\Objects\Base;
 7 | 
 8 | /**
 9 |  * Webhooks enable real-time notifications of conversation events to be
10 |  * delivered to endpoints on your own server. A webhook can be configured with
11 |  * a URL and a list of events that should be subscribed to for notifications.
12 |  * It's possible to create multiple webhooks with different URLs to listen to
13 |  * one or more events each.
14 |  */
15 | class Webhook extends Base implements JsonSerializable
16 | {
17 |     public const EVENT_CONVERSATION_CREATED = 'conversation.created';
18 |     public const EVENT_CONVERSATION_UPDATED = 'conversation.updated';
19 |     public const EVENT_MESSAGE_CREATED = 'message.created';
20 |     public const EVENT_MESSAGE_UPDATED = 'message.updated';
21 | 
22 |     /**
23 |      * A unique ID generated by the MessageBird platform that identifies this
24 |      * webhook.
25 |      *
26 |      * @var string
27 |      */
28 |     public $id;
29 | 
30 |     /**
31 |      * The URL of this webhook object.
32 |      *
33 |      * @var string|null
34 |      */
35 |     public $href;
36 | 
37 |     /**
38 |      * The unique identifier for a MessageBird channel taht this webhook will
39 |      * subscribe to events for.
40 |      *
41 |      * @var string
42 |      */
43 |     public $channelId;
44 | 
45 |     /**
46 |      * A list of event name strings from the list of available events that
47 |      * trigger this webhook. Possible values: "conversation.created",
48 |      * "conversation.updated", "message.created", "message.updated".
49 |      *
50 |      * @var array
51 |      */
52 |     public $events;
53 | 
54 |     /**
55 |      * The endpoint URL that requests are sent to.
56 |      *
57 |      * @var string
58 |      */
59 |     public $url;
60 | 
61 |     /**
62 |      * The date and time when this webhook was first created in RFC3339 format.
63 |      *
64 |      * @var string
65 |      */
66 |     public $createdDatetime;
67 | 
68 |     /**
69 |      * The date and time when this webhook was last updated in RFC3339 format.
70 |      *
71 |      * @var string
72 |      */
73 |     public $updatedDatetime;
74 | 
75 |     /**
76 |      * Serialize only non empty fields.
77 |      */
78 |     public function jsonSerialize(): array
79 |     {
80 |         $json = [];
81 | 
82 |         foreach (get_object_vars($this) as $key => $value) {
83 |             if (!empty($value)) {
84 |                 $json[$key] = $value;
85 |             }
86 |         }
87 | 
88 |         return $json;
89 |     }
90 | }
91 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Group.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace MessageBird\Objects;
  4 | 
  5 | use stdClass;
  6 | 
  7 | /**
  8 |  * Class Group
  9 |  *
 10 |  * @package MessageBird\Objects
 11 |  */
 12 | class Group extends Base
 13 | {
 14 |     /**
 15 |      * The name of the group.
 16 |      *
 17 |      * @var int
 18 |      */
 19 |     public $name;
 20 | 
 21 |     /**
 22 |      * An unique random ID which is created on the MessageBird
 23 |      * platform and is returned upon creation of the object.
 24 |      *
 25 |      * @var string
 26 |      */
 27 |     protected $id;
 28 | 
 29 |     /**
 30 |      * The URL of the created object.
 31 |      *
 32 |      * @var string
 33 |      */
 34 |     protected $href;
 35 | 
 36 |     /**
 37 |      * The hash with the contacts in group.
 38 |      *
 39 |      * @var ?stdClass
 40 |      */
 41 |     protected $contacts = null;
 42 | 
 43 |     /**
 44 |      * The date and time of the creation of the group in RFC3339 format (Y-m-d\TH:i:sP)
 45 |      *
 46 |      * @var string
 47 |      */
 48 |     protected $createdDatetime;
 49 | 
 50 |     /**
 51 |      * The date and time of the updated of the group in RFC3339 format (Y-m-d\TH:i:sP)
 52 |      *
 53 |      * @var string
 54 |      */
 55 |     protected $updatedDatetime;
 56 | 
 57 |     /**
 58 |      * Get the created id
 59 |      */
 60 |     public function getId(): string
 61 |     {
 62 |         return $this->id;
 63 |     }
 64 | 
 65 |     /**
 66 |      * Get the created href
 67 |      */
 68 |     public function getHref(): string
 69 |     {
 70 |         return $this->href;
 71 |     }
 72 | 
 73 |     /**
 74 |      * Get the $createdDatetime value
 75 |      */
 76 |     public function getCreatedDatetime(): string
 77 |     {
 78 |         return $this->createdDatetime;
 79 |     }
 80 | 
 81 |     /**
 82 |      * Get the $updatedDatetime value
 83 |      */
 84 |     public function getUpdatedDatetime(): ?string
 85 |     {
 86 |         return $this->createdDatetime;
 87 |     }
 88 | 
 89 |     public function getContacts(): stdClass
 90 |     {
 91 |         return $this->contacts;
 92 |     }
 93 | 
 94 |     /**
 95 |      * @deprecated 2.2.0 No longer used by internal code, please switch to {@see self::loadFromStdclass()}
 96 |      * 
 97 |      * @param mixed $object
 98 |      *
 99 |      * @return $this|void
100 |      */
101 |     public function loadFromArray($object): self
102 |     {
103 |         return parent::loadFromArray($object);
104 |     }
105 | 
106 |     public function loadFromStdclass(stdClass $object): self
107 |     {
108 |         return parent::loadFromStdclass($object);
109 |     }
110 | }
111 | 


--------------------------------------------------------------------------------
/src/MessageBird/Common/ResponseError.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Common;
 4 | 
 5 | use MessageBird\Exceptions;
 6 | 
 7 | /**
 8 |  * Class ResponseError
 9 |  *
10 |  * @package MessageBird\Common
11 |  */
12 | class ResponseError
13 | {
14 |     public const EXCEPTION_MESSAGE = 'Got error response from the server: %s';
15 | 
16 |     public const SUCCESS = 1;
17 | 
18 |     public const REQUEST_NOT_ALLOWED = 2;
19 | 
20 |     public const MISSING_PARAMS = 9;
21 |     public const INVALID_PARAMS = 10;
22 | 
23 |     public const NOT_FOUND = 20;
24 | 
25 |     public const NOT_ENOUGH_CREDIT = 25;
26 | 
27 |     public $errors = [];
28 | 
29 |     /**
30 |      * Load the error data into an array.
31 |      * Throw an exception when important errors are found.
32 |      *
33 |      * @param mixed $body
34 |      *
35 |      * @throws Exceptions\AuthenticateException
36 |      * @throws Exceptions\BalanceException
37 |      */
38 |     public function __construct($body)
39 |     {
40 |         if (!empty($body->errors)) {
41 |             foreach ($body->errors as $error) {
42 |                 // Voice API returns errors with a "message" field instead of "description".
43 |                 // This ensures all errors have a description set.
44 |                 if (!empty($error->message)) {
45 |                     $error->description = $error->message;
46 |                     unset($error->message);
47 |                 }
48 | 
49 |                 if ($error->code === self::NOT_ENOUGH_CREDIT) {
50 |                     throw new Exceptions\BalanceException($this->getExceptionMessage($error));
51 |                 } elseif ($error->code === self::REQUEST_NOT_ALLOWED) {
52 |                     throw new Exceptions\AuthenticateException($this->getExceptionMessage($error));
53 |                 }
54 | 
55 |                 $this->errors[] = $error;
56 |             }
57 |         }
58 |     }
59 | 
60 |     /**
61 |      * Get the exception message for the provided error.
62 |      *
63 |      * @param mixed $error
64 |      *
65 |      * @return string
66 |      */
67 |     private function getExceptionMessage($error)
68 |     {
69 |         return sprintf(self::EXCEPTION_MESSAGE, $error->description);
70 |     }
71 | 
72 |     /**
73 |      * Get a string of all of this response's concatenated error descriptions.
74 |      *
75 |      * @return string
76 |      */
77 |     public function getErrorString()
78 |     {
79 |         $errorDescriptions = [];
80 | 
81 |         foreach ($this->errors as $error) {
82 |             $errorDescriptions[] = $error->description;
83 |         }
84 | 
85 |         return implode(', ', $errorDescriptions);
86 |     }
87 | }
88 | 


--------------------------------------------------------------------------------
/src/MessageBird/Resources/AvailablePhoneNumbers.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Resources;
 4 | 
 5 | use MessageBird\Common;
 6 | use MessageBird\Common\HttpClient;
 7 | use MessageBird\Exceptions;
 8 | use MessageBird\Objects;
 9 | 
10 | /**
11 |  * Class AvailablePhoneNumbers
12 |  *
13 |  * @package MessageBird\Resources
14 |  */
15 | class AvailablePhoneNumbers
16 | {
17 |     /**
18 |      * @var HttpClient
19 |      */
20 |     protected $httpClient;
21 | 
22 |     public function __construct(HttpClient $httpClient)
23 |     {
24 |         $this->httpClient = $httpClient;
25 |     }
26 | 
27 |     /**
28 |      * @return Objects\BaseList|Objects\Number
29 |      *
30 |      * @throws Exceptions\AuthenticateException
31 |      * @throws Exceptions\BalanceException
32 |      * @throws Exceptions\HttpException
33 |      * @throws Exceptions\RequestException
34 |      * @throws Exceptions\ServerException
35 |      * @throws \JsonException
36 |      */
37 |     public function getList(string $countryCode, array $parameters = [])
38 |     {
39 |         [$status, , $body] = $this->httpClient->performHttpRequest(
40 |             HttpClient::REQUEST_GET,
41 |             "available-phone-numbers/$countryCode",
42 |             $parameters
43 |         );
44 | 
45 |         if ($status !== 200) {
46 |             return $this->processRequest($body);
47 |         }
48 |         $body = json_decode($body, null, 512, \JSON_THROW_ON_ERROR);
49 | 
50 |         $items = $body->items;
51 |         unset($body->items);
52 | 
53 |         $baseList = new Objects\BaseList();
54 |         $baseList->loadFromStdclass($body);
55 | 
56 |         foreach ($items as $item) {
57 |             $object = new Objects\Number();
58 |             $itemObject = $object->loadFromStdclass($item);
59 |             $baseList->items[] = $itemObject;
60 |         }
61 |         return $baseList;
62 |     }
63 | 
64 |     /**
65 |      * @throws Exceptions\AuthenticateException
66 |      * @throws Exceptions\BalanceException
67 |      * @throws Exceptions\ServerException
68 |      * @throws Exceptions\RequestException
69 |      */
70 |     private function processRequest(?string $body): Objects\Number
71 |     {
72 |         if ($body === null) {
73 |             throw new Exceptions\ServerException('Got an invalid JSON response from the server.');
74 |         }
75 | 
76 |         try {
77 |             $body = json_decode($body, true, 512, JSON_THROW_ON_ERROR);
78 |         } catch (\JsonException $e) {
79 |             throw new Exceptions\ServerException('Got an invalid JSON response from the server.');
80 |         }
81 | 
82 |         if (!empty($body->errors)) {
83 |             $responseError = new Common\ResponseError($body);
84 |             throw new Exceptions\RequestException($responseError->getErrorString());
85 |         }
86 | 
87 |         return (new Objects\Number())->loadFromStdclass($body->data[0]);
88 |     }
89 | }
90 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Recipient.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace MessageBird\Objects;
  4 | 
  5 | /**
  6 |  * Class Recipient
  7 |  *
  8 |  * @package MessageBird\Objects
  9 |  */
 10 | class Recipient extends Base
 11 | {
 12 |     /**
 13 |      * The msisdn of the recipient
 14 |      *
 15 |      * @var int
 16 |      */
 17 |     public $recipient;
 18 | 
 19 |     /**
 20 |      * The status of the message sent to the recipient.
 21 |      * Possible values for SMS are: scheduled, sent, buffered,
 22 |      * delivered, delivery_failed
 23 |      *
 24 |      * Possible values for voice messages are: calling, answered,
 25 |      * failed, busy, machine
 26 |      *
 27 |      * @var string
 28 |      */
 29 |     public $status;
 30 | 
 31 |     /**
 32 |      * The date and time of the last status in RFC3339 format (Y-m-d\TH:i:sP)
 33 |      *
 34 |      * @var string
 35 |      */
 36 |     public $statusDatetime;
 37 | 
 38 | 
 39 |     /**
 40 |      * The details about the status message. More details can be found here:
 41 |      * https://developers.messagebird.com/api/sms-messaging/#sms-statuses
 42 |      *
 43 |      * @var string
 44 |      */
 45 |     public $statusReason;
 46 | 
 47 |     /**
 48 |      * Extra error code that describes the failure in more detail (optional, 
 49 |      * null if not available)
 50 |      *
 51 |      * @var string
 52 |      */
 53 |     public $statusErrorCode;
 54 | 
 55 |     /**
 56 |      * The name of the recipient’s original country, based on MSISDN.
 57 |      *
 58 |      * @var string
 59 |      */
 60 |     public $recipientCountry;
 61 | 
 62 |     /**
 63 |      * The prefix code for the recipient’s original country, based on MSISDN.
 64 |      *
 65 |      * @var int
 66 |      */
 67 |     public $recipientCountryPrefix;
 68 | 
 69 |     /**
 70 |      * The name of the operator of the recipient. Identified by MCCMNC 
 71 |      * of the message.
 72 |      *
 73 |      * @var string
 74 |      */
 75 |     public $recipientOperator;
 76 | 
 77 |     /**
 78 |      * The code of the operator of the message sender. 
 79 |      * It could have null value if the message isn’t delivered yet.
 80 |      *
 81 |      * @var string
 82 |      */
 83 |     public $mccmnc;
 84 | 
 85 |     /**
 86 |      * The MCC (Mobile Country Code) part of MCCMNC.
 87 |      *
 88 |      * @var string
 89 |      */
 90 |     public $mcc;
 91 | 
 92 |     /**
 93 |      * The MNC (Mobile Network Code) part of MCCMNC.
 94 |      *
 95 |      * @var string
 96 |      */
 97 |     public $mnc;
 98 |     
 99 |     /**
100 |      * The length of the message in characters. Depends on the 
101 |      * message datacoding.
102 |      *
103 |      * @var int
104 |      */
105 |     public $messageLength;
106 | 
107 |     /**
108 |      * The count of total messages send. Personalisation not taken in account.
109 |      *
110 |      * @var int
111 |      */
112 |     public $messagePartCount;
113 | }
114 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Hlr.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace MessageBird\Objects;
  4 | 
  5 | /**
  6 |  * Class Hlr
  7 |  *
  8 |  * @package MessageBird\Objects
  9 |  */
 10 | class Hlr extends Base
 11 | {
 12 |     public const STATUS_SENT = 'sent';
 13 |     public const STATUS_ABSENT = 'absent';
 14 |     public const STATUS_ACTIVE = 'active';
 15 |     public const STATUS_UNKNOWN = 'unknown';
 16 |     public const STATUS_FAILED = 'failed';
 17 |     /**
 18 |      * The msisdns you want to do a network query on
 19 |      *
 20 |      * @var int
 21 |      */
 22 |     public $msisdn;
 23 |     /**
 24 |      * The MCCMNC code of the network provider. (http://en.wikipedia.org/wiki/Mobile_country_code)
 25 |      *
 26 |      * @var int
 27 |      */
 28 |     public $network;
 29 |     /**
 30 |      * A array with extra HLR information. Do note that the attributes in the array can change over time and
 31 |      * can be null (not all information is availble for all countries and providers).
 32 |      *
 33 |      * @var array
 34 |      */
 35 |     public $details = [];
 36 |     /**
 37 |      * A client reference. Here you can put your own reference,
 38 |      * like your internal reference.
 39 |      *
 40 |      * @var string
 41 |      */
 42 |     public $reference;
 43 |     /**
 44 |      * The status of the msisdns. Possible values: sent, absent, active, unknown, and failed
 45 |      *
 46 |      * @var string
 47 |      */
 48 |     public $status;
 49 |     /**
 50 |      * An unique random ID which is created on the MessageBird platform and is returned upon creation of the object.
 51 |      *
 52 |      * @var string
 53 |      */
 54 |     protected $id;
 55 |     /**
 56 |      * The URL of the created object.
 57 |      *
 58 |      * @var string
 59 |      */
 60 |     protected $href;
 61 |     /**
 62 |      * The date and time of the creation of the hlr in RFC3339 format (Y-m-d\TH:i:sP)
 63 |      *
 64 |      * @var string
 65 |      */
 66 |     protected $createdDatetime;
 67 | 
 68 |     /**
 69 |      * The datum time of the last status in RFC3339 format (Y-m-d\TH:i:sP)
 70 |      *
 71 |      * @var string
 72 |      */
 73 |     protected $statusDatetime;
 74 | 
 75 |     /**
 76 |      * Get the created id
 77 |      */
 78 |     public function getId(): string
 79 |     {
 80 |         return $this->id;
 81 |     }
 82 | 
 83 |     /**
 84 |      * Get the created href
 85 |      */
 86 |     public function getHref(): string
 87 |     {
 88 |         return $this->href;
 89 |     }
 90 | 
 91 |     /**
 92 |      * Get the date and time the resource was created
 93 |      */
 94 |     public function getCreatedDatetime(): string
 95 |     {
 96 |         return $this->createdDatetime;
 97 |     }
 98 | 
 99 |     /**
100 |      * Get the date and time the resource was created
101 |      */
102 |     public function getStatusDatetime(): string
103 |     {
104 |         return $this->statusDatetime;
105 |     }
106 | }
107 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Voice/Leg.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace MessageBird\Objects\Voice;
  4 | 
  5 | use MessageBird\Objects\Base;
  6 | 
  7 | class Leg extends Base
  8 | {
  9 |     /**
 10 |      * The unique ID of the leg
 11 |      *
 12 |      * @var string
 13 |      */
 14 |     protected $id;
 15 | 
 16 |     /**
 17 |      * The unique ID of the call that this leg belongs to
 18 |      *
 19 |      * @var string
 20 |      */
 21 |     protected $callId;
 22 | 
 23 |     /**
 24 |      * The number/SIP URL that is making the connection
 25 |      *
 26 |      * @var string
 27 |      */
 28 |     protected $source;
 29 | 
 30 |     /**
 31 |      * The number/SIP URL that a connection is made to
 32 |      *
 33 |      * @var string
 34 |      */
 35 |     protected $destination;
 36 | 
 37 |     /**
 38 |      * The status of the leg. Possible values: ongoing, hangup
 39 |      *
 40 |      * @var string
 41 |      */
 42 |     protected $status;
 43 | 
 44 |     /**
 45 |      * The direction of the leg, indicating if it's an incoming connection or outgoing (e.g. for transfering a call).
 46 |      * Possible values: incoming, outgoing.
 47 |      *
 48 |      * @var string
 49 |      */
 50 |     protected $direction;
 51 | 
 52 |     /**
 53 |      * The date and time the leg was created
 54 |      *
 55 |      * @var string
 56 |      */
 57 |     protected $createdAt;
 58 | 
 59 |     /**
 60 |      * The date and time the leg was last updated
 61 |      *
 62 |      * @var string
 63 |      */
 64 |     protected $updatedAt;
 65 | 
 66 |     /**
 67 |      * The date and time the leg was answered at
 68 |      *
 69 |      * @var string
 70 |      */
 71 |     protected $answeredAt;
 72 | 
 73 |     /**
 74 |      * The date and time the leg ended
 75 |      *
 76 |      * @var string
 77 |      */
 78 |     protected $endedAt;
 79 | 
 80 |     public function getId(): string
 81 |     {
 82 |         return $this->id;
 83 |     }
 84 | 
 85 |     public function getCallId(): string
 86 |     {
 87 |         return $this->callId;
 88 |     }
 89 | 
 90 |     public function getSource(): string
 91 |     {
 92 |         return $this->source;
 93 |     }
 94 | 
 95 |     public function getDestination(): string
 96 |     {
 97 |         return $this->destination;
 98 |     }
 99 | 
100 |     public function getStatus(): string
101 |     {
102 |         return $this->status;
103 |     }
104 | 
105 |     public function getDirection(): string
106 |     {
107 |         return $this->direction;
108 |     }
109 | 
110 |     public function getCreatedAt(): string
111 |     {
112 |         return $this->createdAt;
113 |     }
114 | 
115 |     public function getUpdatedAt(): string
116 |     {
117 |         return $this->updatedAt;
118 |     }
119 | 
120 |     public function getAnsweredAt(): string
121 |     {
122 |         return $this->answeredAt;
123 |     }
124 | 
125 |     public function getEndedAt(): string
126 |     {
127 |         return $this->endedAt;
128 |     }
129 | }
130 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | MessageBird's REST API for PHP
 2 | ===============================
 3 | This repository contains the open source PHP client for MessageBird's REST API. Documentation can be found at: https://developers.messagebird.com/
 4 | 
 5 | [![Build Status](https://github.com/messagebird/php-rest-api/actions/workflows/tests.yml/badge.svg?branch=master)](https://github.com/messagebird/php-rest-api/actions/workflows/tests.yml?query=branch%3Amaster)
 6 | [![Latest Stable Version](https://poser.pugx.org/messagebird/php-rest-api/v/stable.svg)](https://packagist.org/packages/messagebird/php-rest-api)
 7 | [![License](https://poser.pugx.org/messagebird/php-rest-api/license.svg)](https://packagist.org/packages/messagebird/php-rest-api)
 8 | 
 9 | Requirements
10 | -----
11 | 
12 | - [Sign up](https://www.messagebird.com/en/signup) for a free MessageBird account
13 | - Create a new access_key in the developers sections
14 | - MessageBird API client for PHP requires PHP >= 7.3.
15 | 
16 | Installation
17 | -----
18 | 
19 | #### Composer installation
20 | 
21 | - [Download composer](https://getcomposer.org/doc/00-intro.md#installation-nix)
22 | - Run `composer require messagebird/php-rest-api`.
23 | 
24 | #### Manual installation
25 | 
26 | 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.
27 | 
28 | 
29 | Usage
30 | -----
31 | 
32 | 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.
33 | 
34 | ```php
35 | require 'autoload.php';
36 | 
37 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY');
38 | 
39 | ```
40 | 
41 | That's easy enough. Now we can query the server for information. Lets use getting your balance overview as an example:
42 | 
43 | ```php
44 | // Get your balance
45 | $balance = $messageBird->balance->read();
46 | ```
47 | 
48 | 
49 | Conversations WhatsApp Sandbox
50 | -------------
51 | 
52 | 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.
53 | 
54 | ```php
55 | $messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY', null, [\MessageBird\Client::ENABLE_CONVERSATIONSAPI_WHATSAPP_SANDBOX]);
56 | ```
57 | 
58 | If you use a custom `HttpClient` you will have to manually direct Conversation API request to the WhatsApp sandbox endpoint.
59 | 
60 | 
61 | Documentation
62 | ----
63 | Complete documentation, instructions, and examples are available at:
64 | [https://developers.messagebird.com/](https://developers.messagebird.com/)
65 | 
66 | 
67 | License
68 | ----
69 | 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
70 | 


--------------------------------------------------------------------------------
/src/MessageBird/Resources/Voice/Base.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Resources\Voice;
 4 | 
 5 | use MessageBird\Common;
 6 | use MessageBird\Exceptions;
 7 | use MessageBird\Objects\Balance;
 8 | use MessageBird\Objects\Conversation\Conversation;
 9 | use MessageBird\Objects\Hlr;
10 | use MessageBird\Objects\Lookup;
11 | use MessageBird\Objects\Message;
12 | use MessageBird\Objects\Verify;
13 | use MessageBird\Objects\Voice\BaseList;
14 | use MessageBird\Objects\VoiceMessage;
15 | 
16 | /**
17 |  * Class Base
18 |  *
19 |  * @package MessageBird\Resources\Voice
20 |  */
21 | class Base extends \MessageBird\Resources\Base
22 | {
23 |     /**
24 |      * @param array $parameters
25 |      * @return BaseList|Balance|Conversation|Hlr|Lookup|Message|Verify|VoiceMessage|null
26 |      * @throws Exceptions\AuthenticateException
27 |      * @throws Exceptions\BalanceException
28 |      * @throws Exceptions\HttpException
29 |      * @throws Exceptions\RequestException
30 |      * @throws Exceptions\ServerException
31 |      * @throws \JsonException
32 |      */
33 |     public function getList($parameters = [])
34 |     {
35 |         [$status, , $body] = $this->httpClient->performHttpRequest(
36 |             Common\HttpClient::REQUEST_GET,
37 |             $this->resourceName,
38 |             $parameters
39 |         );
40 | 
41 |         if ($status === 200) {
42 |             $body = json_decode($body, null, 512, \JSON_THROW_ON_ERROR);
43 | 
44 |             $data = $body->data;
45 | 
46 |             $baseList = new BaseList();
47 |             if (property_exists($body, 'pagination')) {
48 |                 $baseList->loadFromStdclass($body->pagination);
49 |             }
50 | 
51 |             $objectName = $this->object;
52 | 
53 |             foreach ($data as $singleData) {
54 |                 /** @psalm-suppress UndefinedClass */
55 |                 $itemObject = new $objectName($this->httpClient);
56 | 
57 |                 $message = $itemObject->loadFromStdclass($singleData);
58 |                 $baseList->items[] = $message;
59 |             }
60 |             return $baseList;
61 |         }
62 | 
63 |         return $this->processRequest($body);
64 |     }
65 | 
66 |     /**
67 |      * @inheritdoc
68 |      *
69 |      * @return Balance|Conversation|Hlr|Lookup|Message|Verify|VoiceMessage|null
70 |      */
71 |     public function processRequest(?string $body)
72 |     {
73 |         if ($body === null) {
74 |             throw new Exceptions\ServerException('Got an invalid JSON response from the server.');
75 |         }
76 | 
77 |         try {
78 |             $body = json_decode($body, null, 512, \JSON_THROW_ON_ERROR);
79 |         } catch (\JsonException $e) {
80 |             throw new Exceptions\ServerException('Got an invalid JSON response from the server.');
81 | 
82 |         }
83 | 
84 |         if (empty($body->errors)) {
85 |             return $this->object->loadFromStdclass($body->data[0]);
86 |         }
87 | 
88 |         $responseError = new Common\ResponseError($body);
89 |         throw new Exceptions\RequestException($responseError->getErrorString());
90 |     }
91 | }
92 | 


--------------------------------------------------------------------------------
/src/MessageBird/Resources/LookupHlr.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MessageBird\Resources;
 4 | 
 5 | use InvalidArgumentException;
 6 | use MessageBird\Common;
 7 | use MessageBird\Exceptions\AuthenticateException;
 8 | use MessageBird\Exceptions\HttpException;
 9 | use MessageBird\Exceptions\RequestException;
10 | use MessageBird\Exceptions\ServerException;
11 | use MessageBird\Objects;
12 | 
13 | /**
14 |  * Class LookupHlr
15 |  *
16 |  * @package MessageBird\Resources
17 |  */
18 | class LookupHlr extends Base
19 | {
20 |     public function __construct(Common\HttpClient $httpClient)
21 |     {
22 |         $this->object = new Objects\Hlr();
23 |         $this->setResourceName('lookup');
24 | 
25 |         parent::__construct($httpClient);
26 |     }
27 | 
28 |     /**
29 |      * @param Objects\Hlr $object
30 |      * @param array|null $query
31 |      *
32 |      * @return Objects\Balance|Objects\Conversation\Conversation|Objects\Hlr|Objects\Lookup|Objects\Message|Objects\Verify|Objects\VoiceMessage|null
33 |      *
34 |      * @throws HttpException
35 |      * @throws RequestException
36 |      * @throws ServerException
37 |      * @throws \JsonException
38 |      * @throws AuthenticateException
39 |      */
40 |     public function create($hlr, $countryCode = null)
41 |     {
42 |         if (empty($hlr->msisdn)) {
43 |             throw new InvalidArgumentException('The phone number ($hlr->msisdn) cannot be empty.');
44 |         }
45 | 
46 |         $query = null;
47 |         if ($countryCode !== null) {
48 |             $query = ["countryCode" => $countryCode];
49 |         }
50 |         $resourceName = $this->resourceName . '/' . ($hlr->msisdn) . '/hlr';
51 |         [, , $body] = $this->httpClient->performHttpRequest(
52 |             Common\HttpClient::REQUEST_POST,
53 |             $resourceName,
54 |             $query,
55 |             json_encode($hlr, \JSON_THROW_ON_ERROR)
56 |         );
57 |         return $this->processRequest($body);
58 |     }
59 | 
60 |     /**
61 |      * @no-named-arguments
62 |      *
63 |      * @param mixed $phoneNumber
64 |      * @param string|null $countryCode
65 |      *
66 |      * @return Objects\Balance|Objects\Conversation\Conversation|Objects\Hlr|Objects\Lookup|Objects\Message|Objects\Verify|Objects\VoiceMessage|null
67 |      *
68 |      * @throws HttpException
69 |      * @throws RequestException
70 |      * @throws ServerException
71 |      * @throws AuthenticateException
72 |      */
73 |     public function read($phoneNumber = null, ?string $countryCode = null)
74 |     {
75 |         if (empty($phoneNumber)) {
76 |             throw new InvalidArgumentException('The phone number cannot be empty.');
77 |         }
78 | 
79 |         $query = null;
80 |         if ($countryCode !== null) {
81 |             $query = ["countryCode" => $countryCode];
82 |         }
83 |         $resourceName = $this->resourceName . '/' . $phoneNumber . '/hlr';
84 |         [, , $body] = $this->httpClient->performHttpRequest(
85 |             Common\HttpClient::REQUEST_GET,
86 |             $resourceName,
87 |             $query,
88 |             null
89 |         );
90 |         return $this->processRequest($body);
91 |     }
92 | }
93 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Verify.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace MessageBird\Objects;
  4 | 
  5 | /**
  6 |  * Class Verify
  7 |  *
  8 |  * @package MessageBird\Objects
  9 |  */
 10 | class Verify extends Base
 11 | {
 12 |     public const STATUS_SENT = 'sent';
 13 |     public const STATUS_VERIFIED = 'verified';
 14 |     public const STATUS_FAILED = 'failed';
 15 |     public const STATUS_EXPIRED = 'expired';
 16 |     public const STATUS_DELETED = 'deleted';
 17 |     /**
 18 |      * The msisdn or email of the recipient
 19 |      *
 20 |      * @var int|string
 21 |      */
 22 |     public $recipient;
 23 |     /**
 24 |      * A client reference. Here you can put your own reference,
 25 |      * like your internal reference.
 26 |      *
 27 |      * @var string
 28 |      */
 29 |     public $reference;
 30 |     /**
 31 |      * An unique random ID which is created on the MessageBird platform and is returned upon
 32 |      * creation of the object.
 33 |      *
 34 |      * @var string
 35 |      */
 36 |     protected $id;
 37 |     /**
 38 |      * The URL of the created object.
 39 |      *
 40 |      * @var string
 41 |      */
 42 |     protected $href;
 43 |     /**
 44 |      * An associative array containing one href entry referring to the URL of the created object.
 45 |      * The entry can either refer to either the messages or the voicemessages endpoint
 46 |      *
 47 |      * @var object
 48 |      */
 49 |     protected $messages;
 50 | 
 51 |     /**
 52 |      * The status of the Verify. Possible values: sent, expired, failed, verified, and deleted
 53 |      *
 54 |      * @var string
 55 |      */
 56 |     protected $status;
 57 | 
 58 |     /**
 59 |      * The date and time of the creation of the hlr in RFC3339 format (Y-m-d\TH:i:sP)
 60 |      *
 61 |      * @var string
 62 |      */
 63 |     protected $createdDatetime;
 64 | 
 65 |     /**
 66 |      * The date and time indicating the expiration time of the verify object in RFC3339 format (Y-m-d\TH:i:sP)
 67 |      *
 68 |      * @var string
 69 |      */
 70 |     protected $validUntilDatetime;
 71 | 
 72 | 
 73 |     /**
 74 |      * Get the created id
 75 |      *
 76 |      * @return mixed
 77 |      */
 78 |     public function getId()
 79 |     {
 80 |         return $this->id;
 81 |     }
 82 | 
 83 |     /**
 84 |      * Get the created href
 85 |      */
 86 |     public function getHref(): string
 87 |     {
 88 |         return $this->href;
 89 |     }
 90 | 
 91 |     /**
 92 |      * Get the created href
 93 |      */
 94 |     public function getMessage(): string
 95 |     {
 96 |         return $this->messages->href;
 97 |     }
 98 | 
 99 |     /**
100 |      * Get the status
101 |      */
102 |     public function getStatus(): string
103 |     {
104 |         return $this->status;
105 |     }
106 | 
107 |     /**
108 |      * Get the $createdDatetime value
109 |      */
110 |     public function getCreatedDatetime(): string
111 |     {
112 |         return $this->createdDatetime;
113 |     }
114 | 
115 |     /**
116 |      * Get the $validUntilDatetime value
117 |      */
118 |     public function getValidUntilDatetime(): string
119 |     {
120 |         return $this->validUntilDatetime;
121 |     }
122 | }
123 | 


--------------------------------------------------------------------------------
/src/MessageBird/Resources/Contacts.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace MessageBird\Resources;
  4 | 
  5 | use InvalidArgumentException;
  6 | use MessageBird\Common;
  7 | use MessageBird\Exceptions;
  8 | use MessageBird\Objects;
  9 | use MessageBird\Resources\Messages;
 10 | 
 11 | /**
 12 |  * Class Contacts
 13 |  *
 14 |  * @package MessageBird\Resources
 15 |  */
 16 | class Contacts extends Base
 17 | {
 18 |     /**
 19 |      * @var Messages
 20 |      */
 21 |     private $messagesObject;
 22 | 
 23 |     public function __construct(Common\HttpClient $httpClient)
 24 |     {
 25 |         $this->object = new Objects\Contact();
 26 |         $this->setResourceName('contacts');
 27 | 
 28 |         $this->messagesObject = new Messages($httpClient);
 29 | 
 30 |         parent::__construct($httpClient);
 31 |     }
 32 | 
 33 |     /**
 34 |      * @param mixed $object
 35 |      * @param mixed $id
 36 |      *
 37 |      * @return Objects\Balance|Objects\Conversation\Conversation|Objects\Hlr|Objects\Lookup|Objects\Message|Objects\Verify|Objects\VoiceMessage|null ->object
 38 |      *
 39 |      * @throws \JsonException
 40 |      * @throws Exceptions\AuthenticateException
 41 |      * @throws Exceptions\HttpException
 42 |      * @throws Exceptions\RequestException
 43 |      * @throws Exceptions\ServerException
 44 |      *
 45 |      * @internal param array $parameters
 46 |      */
 47 |     public function update($object, $id)
 48 |     {
 49 |         $objVars = get_object_vars($object);
 50 |         $body = [];
 51 |         foreach ($objVars as $key => $value) {
 52 |             if ($value !== null) {
 53 |                 $body[$key] = $value;
 54 |             }
 55 |         }
 56 | 
 57 |         $resourceName = $this->resourceName . ($id ? '/' . $id : null);
 58 |         $body = json_encode($body, \JSON_THROW_ON_ERROR);
 59 | 
 60 |         [, , $body] = $this->httpClient->performHttpRequest(
 61 |             Common\HttpClient::REQUEST_PATCH,
 62 |             $resourceName,
 63 |             false,
 64 |             $body
 65 |         );
 66 |         return $this->processRequest($body);
 67 |     }
 68 | 
 69 |     /**
 70 |      * @param mixed $id
 71 |      * @param array|null $parameters
 72 |      *
 73 |      * @return Objects\Balance|Objects\BaseList|Objects\Conversation\Conversation|Objects\Hlr|Objects\Lookup|Objects\Message|Objects\Verify|Objects\VoiceMessage|null ->object
 74 |      * @throws \JsonException
 75 |      */
 76 |     public function getMessages($id, ?array $parameters = [])
 77 |     {
 78 |         if ($id === null) {
 79 |             throw new InvalidArgumentException('No contact id provided.');
 80 |         }
 81 | 
 82 |         $this->messagesObject->setResourceName($this->resourceName . '/' . $id . '/messages');
 83 |         return $this->messagesObject->getList($parameters);
 84 |     }
 85 | 
 86 |     /**
 87 |      * @param mixed $id
 88 |      * @param array|null $parameters
 89 |      *
 90 |      * @return Objects\Balance|Objects\BaseList|Objects\Conversation\Conversation|Objects\Hlr|Objects\Lookup|Objects\Message|Objects\Verify|Objects\VoiceMessage|null ->object
 91 |      * @throws \JsonException
 92 |      */
 93 |     public function getGroups($id, ?array $parameters = [])
 94 |     {
 95 |         if ($id === null) {
 96 |             throw new InvalidArgumentException('No contact id provided.');
 97 |         }
 98 | 
 99 |         $this->object = new Objects\Group();
100 |         $this->setResourceName($this->resourceName . '/' . $id . '/groups');
101 |         return $this->getList($parameters);
102 |     }
103 | }
104 | 


--------------------------------------------------------------------------------
/src/MessageBird/Resources/PartnerAccount/Accounts.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace MessageBird\Resources\PartnerAccount;
  4 | 
  5 | use MessageBird\Common\HttpClient;
  6 | use MessageBird\Objects\Balance;
  7 | use MessageBird\Objects\Conversation\Conversation;
  8 | use MessageBird\Objects\Hlr;
  9 | use MessageBird\Objects\Lookup;
 10 | use MessageBird\Objects\Message;
 11 | use MessageBird\Objects\PartnerAccount\Account;
 12 | use MessageBird\Objects\Verify;
 13 | use MessageBird\Objects\VoiceMessage;
 14 | use MessageBird\Resources\Base;
 15 | use MessageBird\Exceptions;
 16 | 
 17 | class Accounts extends Base
 18 | {
 19 |     public const RESOURCE_NAME = 'child-accounts';
 20 | 
 21 |     public function __construct(HttpClient $httpClient)
 22 |     {
 23 |         parent::__construct($httpClient);
 24 | 
 25 |         $this->object = new Account();
 26 |         $this->setResourceName(self::RESOURCE_NAME);
 27 |     }
 28 | 
 29 |     /**
 30 |      * @param $object
 31 |      * @param array|null $query
 32 |      * @return Balance|Conversation|Hlr|Lookup|Message|Verify|VoiceMessage|null
 33 |      * @throws Exceptions\AuthenticateException
 34 |      * @throws Exceptions\BalanceException
 35 |      * @throws Exceptions\HttpException
 36 |      * @throws Exceptions\RequestException
 37 |      * @throws Exceptions\ServerException
 38 |      */
 39 |     public function create($object, ?array $query = null)
 40 |     {
 41 |         [, , $body] = $this->httpClient->performHttpRequest(
 42 |             HttpClient::REQUEST_POST,
 43 |             self::RESOURCE_NAME,
 44 |             null,
 45 |             $object->loadToJson()
 46 |         );
 47 | 
 48 |         return $this->processRequest($body);
 49 |     }
 50 | 
 51 |     /**
 52 |      * @return array|Balance|\MessageBird\Objects\BaseList|Conversation|Hlr|Lookup|Message|\MessageBird\Objects\MessageResponse|Verify|VoiceMessage|null
 53 |      * @throws Exceptions\AuthenticateException
 54 |      * @throws Exceptions\BalanceException
 55 |      * @throws Exceptions\HttpException
 56 |      * @throws Exceptions\RequestException
 57 |      * @throws Exceptions\ServerException
 58 |      * @throws \JsonException
 59 |      */
 60 |     public function getList(?array $parameters = [])
 61 |     {
 62 |         [$status, , $body] = $this->httpClient->performHttpRequest(
 63 |             HttpClient::REQUEST_GET,
 64 |             self::RESOURCE_NAME,
 65 |             $parameters
 66 |         );
 67 | 
 68 |         if ($status !== 200) {
 69 |             return $this->processRequest($body);
 70 |         }
 71 | 
 72 |         $response = json_decode($body, false, 512, \JSON_THROW_ON_ERROR);
 73 | 
 74 |         $return = [];
 75 |         foreach ($response as &$singleResponse) {
 76 |             $object = clone $this->getObject();
 77 |             $return[] = $object->loadFromStdclass($singleResponse);
 78 |         }
 79 | 
 80 |         return $return;
 81 |     }
 82 | 
 83 |     /**
 84 |      * @param $object
 85 |      * @param $id
 86 |      * @return Balance|Conversation|Hlr|Lookup|Message|Verify|VoiceMessage|null
 87 |      * @throws Exceptions\AuthenticateException
 88 |      * @throws Exceptions\BalanceException
 89 |      * @throws Exceptions\HttpException
 90 |      * @throws Exceptions\RequestException
 91 |      * @throws Exceptions\ServerException
 92 |      */
 93 |     public function update($object, $id)
 94 |     {
 95 |         [, , $body] = $this->httpClient->performHttpRequest(
 96 |             HttpClient::REQUEST_PATCH,
 97 |             sprintf('%s/%s', self::RESOURCE_NAME, $id),
 98 |             null,
 99 |             $object->loadToJson()
100 |         );
101 | 
102 |         return $this->processRequest($body);
103 |     }
104 | }
105 | 


--------------------------------------------------------------------------------
/src/MessageBird/Resources/Conversation/Conversations.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace MessageBird\Resources\Conversation;
  4 | 
  5 | use MessageBird\Common\HttpClient;
  6 | use MessageBird\Exceptions;
  7 | use MessageBird\Objects\Balance;
  8 | use MessageBird\Objects\Conversation\Conversation;
  9 | use MessageBird\Objects\Conversation\Message;
 10 | use MessageBird\Objects\Hlr;
 11 | use MessageBird\Objects\Lookup;
 12 | use MessageBird\Objects\Verify;
 13 | use MessageBird\Objects\VoiceMessage;
 14 | use MessageBird\Resources\Base;
 15 | 
 16 | class Conversations extends Base
 17 | {
 18 |     public const RESOURCE_NAME = 'conversations';
 19 | 
 20 |     public function __construct(HttpClient $httpClient)
 21 |     {
 22 |         parent::__construct($httpClient);
 23 | 
 24 |         $this->object = new Conversation();
 25 |         $this->setResourceName(self::RESOURCE_NAME);
 26 |     }
 27 | 
 28 |     /**
 29 |      * Starts a conversation by sending an initial message.
 30 |      *
 31 |      * @param Message $object
 32 |      * @param array|null $query
 33 |      *
 34 |      * @return Conversation|Balance|Hlr|Lookup|\MessageBird\Objects\Message|Verify|VoiceMessage|null
 35 |      *
 36 |      * @throws Exceptions\HttpException
 37 |      * @throws Exceptions\RequestException
 38 |      * @throws Exceptions\ServerException
 39 |      */
 40 |     public function start($object, $query = null)
 41 |     {
 42 |         $body = json_encode($object, \JSON_THROW_ON_ERROR);
 43 | 
 44 |         [, , $body] = $this->httpClient->performHttpRequest(
 45 |             HttpClient::REQUEST_POST,
 46 |             $this->getStartUrl(),
 47 |             $query,
 48 |             $body
 49 |         );
 50 | 
 51 |         return $this->processRequest($body);
 52 |     }
 53 | 
 54 |     /**
 55 |      * Conversations API uses a special URL scheme for starting a conversation.
 56 |      */
 57 |     private function getStartUrl(): string
 58 |     {
 59 |         return $this->resourceName . '/start';
 60 |     }
 61 | 
 62 |     /**
 63 |      * Starts a conversation without sending an initial message.
 64 |      *
 65 |      * @param int $object
 66 |      *
 67 |      * @return Conversation|Balance|Hlr|Lookup|\MessageBird\Objects\Message|Verify|VoiceMessage|null
 68 |      *
 69 |      * @throws Exceptions\HttpException
 70 |      * @throws Exceptions\RequestException
 71 |      * @throws Exceptions\ServerException
 72 |      */
 73 |     public function create($object, ?array $query = null)
 74 |     {
 75 |         $body = json_encode(['contactId' => $object], \JSON_THROW_ON_ERROR);
 76 | 
 77 |         [, , $body] = $this->httpClient->performHttpRequest(
 78 |             HttpClient::REQUEST_POST,
 79 |             $this->resourceName,
 80 |             $query,
 81 |             $body
 82 |         );
 83 | 
 84 |         return $this->processRequest($body);
 85 |     }
 86 | 
 87 |     /**
 88 |      * @param mixed $object
 89 |      * @param mixed $id
 90 |      *
 91 |      * @return Conversation|Balance|Hlr|Lookup|\MessageBird\Objects\Message|Verify|VoiceMessage|null ->object
 92 |      *
 93 |      * @internal param array $parameters
 94 |      */
 95 |     public function update($object, $id)
 96 |     {
 97 |         $objVars = get_object_vars($object);
 98 |         $body = [];
 99 | 
100 |         foreach ($objVars as $key => $value) {
101 |             if ($value !== null) {
102 |                 $body[$key] = $value;
103 |             }
104 |         }
105 | 
106 |         $resourceName = $this->resourceName . ($id ? '/' . $id : null);
107 |         $body = json_encode($body, \JSON_THROW_ON_ERROR);
108 | 
109 |         [, , $body] = $this->httpClient->performHttpRequest(HttpClient::REQUEST_PATCH, $resourceName, false, $body);
110 | 
111 |         return $this->processRequest($body);
112 |     }
113 | }
114 | 


--------------------------------------------------------------------------------
/src/MessageBird/Resources/Voice/Legs.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace MessageBird\Resources\Voice;
  4 | 
  5 | use MessageBird\Common;
  6 | use MessageBird\Common\HttpClient;
  7 | use MessageBird\Exceptions;
  8 | use MessageBird\Objects;
  9 | 
 10 | /**
 11 |  * Class Legs
 12 |  *
 13 |  * @package MessageBird\Resources\Voice
 14 |  */
 15 | class Legs
 16 | {
 17 |     /**
 18 |      * @var HttpClient
 19 |      */
 20 |     protected $httpClient;
 21 | 
 22 |     /**
 23 |      * @var Objects\Voice\Leg
 24 |      */
 25 |     protected $object;
 26 | 
 27 |     public function __construct(HttpClient $httpClient)
 28 |     {
 29 |         $this->httpClient = $httpClient;
 30 |         $this->object = new Objects\Voice\Leg();
 31 |     }
 32 | 
 33 |     public function getObject(): Objects\Voice\Leg
 34 |     {
 35 |         return $this->object;
 36 |     }
 37 | 
 38 |     /**
 39 |      * @deprecated
 40 |      * 
 41 |      * @param mixed $object
 42 |      */
 43 |     public function setObject($object): void
 44 |     {
 45 |         $this->object = $object;
 46 |     }
 47 | 
 48 |     /**
 49 |      * @param string $callId
 50 |      * @param array $parameters
 51 |      *
 52 |      * @return Objects\BaseList|Objects\Voice\Leg
 53 |      * @throws Exceptions\AuthenticateException
 54 |      * @throws Exceptions\HttpException
 55 |      * @throws \JsonException
 56 |      */
 57 |     public function getList(string $callId, array $parameters = [])
 58 |     {
 59 |         [$status, , $body] = $this->httpClient->performHttpRequest(
 60 |             HttpClient::REQUEST_GET,
 61 |             "calls/$callId/legs",
 62 |             $parameters
 63 |         );
 64 | 
 65 |         if ($status === 200) {
 66 |             $body = json_decode($body, null, 512, \JSON_THROW_ON_ERROR);
 67 | 
 68 |             $items = $body->data;
 69 |             unset($body->data);
 70 | 
 71 |             $baseList = new Objects\BaseList();
 72 |             $baseList->loadFromStdclass($body);
 73 | 
 74 |             $objectName = $this->object;
 75 | 
 76 |             foreach ($items as $item) {
 77 |                 /** @psalm-suppress UndefinedClass */
 78 |                 $object = new $objectName($this->httpClient);
 79 | 
 80 |                 $itemObject = $object->loadFromStdclass($item);
 81 |                 $baseList->items[] = $itemObject;
 82 |             }
 83 |             return $baseList;
 84 |         }
 85 | 
 86 |         return $this->processRequest($body);
 87 |     }
 88 | 
 89 |     /**
 90 |      * @throws Exceptions\AuthenticateException
 91 |      * @throws Exceptions\BalanceException
 92 |      * @throws Exceptions\RequestException
 93 |      * @throws Exceptions\ServerException
 94 |      */
 95 |     public function processRequest(?string $body): Objects\Voice\Leg
 96 |     {
 97 |         if ($body === null) {
 98 |             throw new Exceptions\ServerException('Got an invalid JSON response from the server.');
 99 |         }
100 | 
101 |         try {
102 |             $body = json_decode($body, null, 512, \JSON_THROW_ON_ERROR);
103 |         } catch (\JsonException $e) {
104 |             throw new Exceptions\ServerException('Got an invalid JSON response from the server.');
105 |         }
106 | 
107 |         if (empty($body->errors)) {
108 |             return $this->object->loadFromStdclass($body->data[0]);
109 |         }
110 | 
111 |         $responseError = new Common\ResponseError($body);
112 |         throw new Exceptions\RequestException($responseError->getErrorString());
113 |     }
114 | 
115 |     public function read(string $callId, string $legId): Objects\Voice\Leg
116 |     {
117 |         [, , $body] = $this->httpClient->performHttpRequest(
118 |             HttpClient::REQUEST_GET,
119 |             "calls/$callId/legs/$legId"
120 |         );
121 | 
122 |         return $this->processRequest($body);
123 |     }
124 | }
125 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Conversation/Content.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace MessageBird\Objects\Conversation;
  4 | 
  5 | use JsonSerializable;
  6 | use MessageBird\Objects\Base;
  7 | use MessageBird\Objects\Conversation\HSM\Message as HSMMessage;
  8 | use stdClass;
  9 | 
 10 | /**
 11 |  * Represents a Message object's actual content. Formatted depending on type.
 12 |  */
 13 | class Content extends Base implements JsonSerializable
 14 | {
 15 |     public const TYPE_AUDIO = 'audio';
 16 |     public const TYPE_FILE = 'file';
 17 |     public const TYPE_IMAGE = 'image';
 18 |     public const TYPE_LOCATION = 'location';
 19 |     public const TYPE_TEXT = 'text';
 20 |     public const TYPE_VIDEO = 'video';
 21 |     public const TYPE_HSM = 'hsm';
 22 | 
 23 |     /**
 24 |      * @var string[]
 25 |      */
 26 |     public $audio;
 27 | 
 28 |     /**
 29 |      * @var string[]
 30 |      */
 31 |     public $file;
 32 | 
 33 |     /**
 34 |      * @var string[]
 35 |      */
 36 |     public $image;
 37 | 
 38 |     /**
 39 |      * @var float[]
 40 |      */
 41 |     public $location;
 42 | 
 43 |     /**
 44 |      * @var string
 45 |      */
 46 |     public $text;
 47 | 
 48 |     /**
 49 |      * @var string[]
 50 |      */
 51 |     public $video;
 52 | 
 53 |     /**
 54 |      * @var HSMMessage
 55 |      */
 56 |     public $hsm;
 57 | 
 58 |     /**
 59 |      * @deprecated 2.2.0 No longer used by internal code, please switch to {@see self::loadFromStdclass()}
 60 |      * 
 61 |      * @param mixed $object
 62 |      *
 63 |      * @return $this
 64 |      */
 65 |     public function loadFromArray($object): self
 66 |     {
 67 |         // Text is already properly set if available due to the response's structure.
 68 |         parent::loadFromArray($object);
 69 | 
 70 |         $this->loadLocationIfNeeded();
 71 |         $this->loadMediaIfNeeded();
 72 | 
 73 |         return $this;
 74 |     }
 75 | 
 76 |     public function loadFromStdclass(stdClass $object): self
 77 |     {
 78 |         // Text is already properly set if available due to the response's structure.
 79 |         parent::loadFromStdclass($object);
 80 | 
 81 |         $this->loadLocationIfNeeded();
 82 |         $this->loadMediaIfNeeded();
 83 | 
 84 |         return $this;
 85 |     }
 86 | 
 87 |     /**
 88 |      * Sets the location on this object if available.
 89 |      */
 90 |     private function loadLocationIfNeeded(): void
 91 |     {
 92 |         if (empty($this->location->latitude)) {
 93 |             return;
 94 |         }
 95 |         if (empty($this->location->longitude)) {
 96 |             return;
 97 |         }
 98 |         $this->location = [
 99 |             'latitude' => $this->location->latitude,
100 |             'longitude' => $this->location->longitude,
101 |         ];
102 |     }
103 | 
104 |     /**
105 |      * Sets the media on this object if available.
106 |      */
107 |     private function loadMediaIfNeeded(): void
108 |     {
109 |         if (!empty($this->audio->url)) {
110 |             $this->audio = ['url' => $this->audio->url];
111 |         }
112 | 
113 |         if (!empty($this->file->url)) {
114 |             $this->file = ['url' => $this->file->url];
115 |         }
116 | 
117 |         if (!empty($this->image->url)) {
118 |             $this->image = ['url' => $this->image->url];
119 |         }
120 | 
121 |         if (!empty($this->video->url)) {
122 |             $this->video = ['url' => $this->video->url];
123 |         }
124 |     }
125 | 
126 |     /**
127 |      * Serialize only non empty fields.
128 |      */
129 |     public function jsonSerialize(): array
130 |     {
131 |         $json = [];
132 | 
133 |         foreach (get_object_vars($this) as $key => $value) {
134 |             if (!empty($value)) {
135 |                 $json[$key] = $value;
136 |             }
137 |         }
138 | 
139 |         return $json;
140 |     }
141 | }
142 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/MmsMessage.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace MessageBird\Objects;
  4 | 
  5 | use stdClass;
  6 | 
  7 | /**
  8 |  * Class MmsMessage
  9 |  *
 10 |  * @package MessageBird\Objects
 11 |  */
 12 | class MmsMessage extends Base
 13 | {
 14 |     /**
 15 |      * Tells you if the message is sent or received.
 16 |      * mt: mobile terminated (sent to mobile)
 17 |      * mo: mobile originated (received from mobile)
 18 |      *
 19 |      * @var string
 20 |      */
 21 |     public $direction = 'mt';
 22 |     /**
 23 |      * The sender of the MMS message. This can be a telephone number
 24 |      * (including country code) or an alphanumeric string. In case
 25 |      * of an alphanumeric string, the maximum length is 11 characters.
 26 |      *
 27 |      * @var string
 28 |      */
 29 |     public $originator;
 30 |     /**
 31 |      * An array of recipients.
 32 |      *
 33 |      * @var array
 34 |      */
 35 |     public $recipients = [];
 36 |     /**
 37 |      * The subject of MMS the message.
 38 |      *
 39 |      * @var string
 40 |      */
 41 |     public $subject;
 42 |     /**
 43 |      * The body of the MMS message.
 44 |      *
 45 |      * @var string
 46 |      */
 47 |     public $body;
 48 |     /**
 49 |      * The array of URL's to the media attachments that you want to
 50 |      * send as part of the MMS message.
 51 |      *
 52 |      * @var array
 53 |      */
 54 |     public $mediaUrls = [];
 55 |     /**
 56 |      * A client reference.
 57 |      *
 58 |      * @var string
 59 |      */
 60 |     public $reference;
 61 |     /**
 62 |      * The scheduled date and time of the message in RFC3339 format (Y-m-d\TH:i:sP)
 63 |      *
 64 |      * @var string
 65 |      */
 66 |     public $scheduledDatetime;
 67 |     /**
 68 |      * The date and time of the creation of the message in RFC3339 format (Y-m-d\TH:i:sP)
 69 |      * @var string
 70 |      */
 71 |     public $createdDatetime;
 72 |     /**
 73 |      * An unique random ID which is created on the MessageBird
 74 |      * platform and is returned upon creation of the object.
 75 |      *
 76 |      * @var string
 77 |      */
 78 |     protected $id;
 79 |     /**
 80 |      * The url of the created object.
 81 |      *
 82 |      * @var string
 83 |      */
 84 |     protected $href;
 85 | 
 86 |     /**
 87 |      * Get the created id
 88 |      */
 89 |     public function getId(): string
 90 |     {
 91 |         return $this->id;
 92 |     }
 93 | 
 94 |     /**
 95 |      * Get the created href
 96 |      */
 97 |     public function getHref(): string
 98 |     {
 99 |         return $this->href;
100 |     }
101 | 
102 |     /**
103 |      * Get the $createdDatetime value
104 |      */
105 |     public function getCreatedDatetime(): string
106 |     {
107 |         return $this->createdDatetime;
108 |     }
109 | 
110 |     /**
111 |      * @deprecated 2.2.0 No longer used by internal code, please switch to {@see self::loadFromStdclass()}
112 |      * 
113 |      * @param mixed $object
114 |      *
115 |      * @return $this|void
116 |      */
117 |     public function loadFromArray($object): self
118 |     {
119 |         parent::loadFromArray($object);
120 | 
121 |         if (!empty($this->recipients->items)) {
122 |             foreach ($this->recipients->items as &$item) {
123 |                 $recipient = new Recipient();
124 |                 $recipient->loadFromArray($item);
125 | 
126 |                 $item = $recipient;
127 |             }
128 |         }
129 | 
130 |         return $this;
131 |     }
132 |     
133 |     public function loadFromStdclass(stdClass $object): self
134 |     {
135 |         parent::loadFromStdclass($object);
136 | 
137 |         if (!empty($this->recipients->items)) {
138 |             foreach ($this->recipients->items as &$item) {
139 |                 $recipient = new Recipient();
140 |                 $recipient->loadFromStdclass($item);
141 | 
142 |                 $item = $recipient;
143 |             }
144 |         }
145 | 
146 |         return $this;
147 |     }
148 | }
149 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/MessageResponse.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace MessageBird\Objects;
  4 | 
  5 | use stdClass;
  6 | 
  7 | /**
  8 |  * Class Message
  9 |  *
 10 |  * @property int $protocolId
 11 |  * @package MessageBird\Objects
 12 |  */
 13 | class MessageResponse extends Base
 14 | {
 15 |     /**
 16 |      * An unique random ID which is created on the MessageBird
 17 |      * platform and is returned upon creation of the object.
 18 |      *
 19 |      * @var string
 20 |      */
 21 |     public $id;
 22 | 
 23 |     /**
 24 |      * The URL of the created object.
 25 |      *
 26 |      * @var string
 27 |      */
 28 |     public $href;
 29 | 
 30 |     /**
 31 |      * Tells you if the message is sent or received.
 32 |      * mt: mobile terminated (sent to mobile)
 33 |      * mo: mobile originated (received from mobile)
 34 |      *
 35 |      * @var string
 36 |      */
 37 |     public $direction;
 38 | 
 39 |     /**
 40 |      * The type of message. Values can be: sms, binary, premium, or flash
 41 |      *
 42 |      * @var string
 43 |      */
 44 |     public $type;
 45 | 
 46 |     /**
 47 |      * The sender of the message. This can be a telephone number
 48 |      * (including country code) or an alphanumeric string. In case
 49 |      * of an alphanumeric string, the maximum length is 11 characters.
 50 |      *
 51 |      * @var string
 52 |      */
 53 |     public $originator;
 54 | 
 55 |     /**
 56 |      * The body of the SMS message.
 57 |      *
 58 |      * @var string
 59 |      */
 60 |     public $body;
 61 | 
 62 |     /**
 63 |      * A client reference. Here you can put your own reference,
 64 |      * like your internal reference.
 65 |      *
 66 |      * @var string
 67 |      */
 68 |     public $reference;
 69 | 
 70 |     /**
 71 |      * The amount of seconds that the message is valid.
 72 |      * If a message is not delivered within this time,
 73 |      * the message will be discarded.
 74 |      *
 75 |      * @var int
 76 |      */
 77 |     public $validity;
 78 | 
 79 |     /**
 80 |      * The SMS route that is used to send the message. This is for
 81 |      * advanced users.
 82 |      *
 83 |      * @var int
 84 |      */
 85 |     public $gateway;
 86 | 
 87 |     /**
 88 |      * An associative array with extra information. Is only used when a binary or premium
 89 |      * message is sent.
 90 |      *
 91 |      * @var array
 92 |      */
 93 |     public $typeDetails = [];
 94 | 
 95 |     /**
 96 |      * The datacoding used, can be plain or unicode
 97 |      *
 98 |      * @var string
 99 |      */
100 |     public $datacoding;
101 | 
102 |     /**
103 |      * Indicates the message type. 1 is a normal message, 0 is a flash message.
104 |      *
105 |      * @var int
106 |      */
107 |     public $mclass = 1;
108 | 
109 |     /**
110 |      * The scheduled date and time of the message in RFC3339 format (Y-m-d\TH:i:sP)
111 |      *
112 |      * @var string|null
113 |      */
114 |     public $scheduledDatetime;
115 | 
116 |     /**
117 |      * The date and time of the creation of the message in RFC3339 format (Y-m-d\TH:i:sP)
118 |      * @var string
119 |      */
120 |     public $createdDatetime;
121 | 
122 |     /**
123 |      * An array of recipients
124 |      *
125 |      * @var Recipients
126 |      */
127 |     public $recipients;
128 | 
129 |     /**
130 |      * @deprecated 2.2.0 No longer used by internal code, please switch to {@see self::loadFromStdclass()}
131 |      * 
132 |      * @param mixed $object
133 |      */
134 |     public function loadFromArray($object): MessageResponse
135 |     {
136 |         parent::loadFromArray($object);
137 | 
138 |         $this->recipients = (new Recipients())->loadFromArray($this->recipients);
139 |         $this->typeDetails = get_object_vars($this->typeDetails);
140 | 
141 |         return $this;
142 |     }
143 | 
144 |     public function loadFromStdclass(stdClass $object): self
145 |     {
146 |         parent::loadFromStdclass($object);
147 | 
148 |         $this->recipients = (new Recipients())->loadFromStdclass($this->recipients);
149 |         $this->typeDetails = get_object_vars($this->typeDetails);
150 | 
151 |         return $this;
152 |     }
153 | }
154 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Conversation/Message.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace MessageBird\Objects\Conversation;
  4 | 
  5 | use JsonSerializable;
  6 | use MessageBird\Objects\Base;
  7 | use stdClass;
  8 | 
  9 | /**
 10 |  * Messages that have been sent by, or received from, a customer are
 11 |  * automatically threaded in a conversation. Any messages sent through the API
 12 |  * or received from your customer across any of your configured channels can be
 13 |  * retrieved via the messages resource. Messages are returned from the API in
 14 |  * the order they were created, with newest messages returned first.
 15 |  */
 16 | class Message extends Base implements JsonSerializable
 17 | {
 18 |     /**
 19 |      * A unique ID generated by the MessageBird platform that identifies this
 20 |      * message.
 21 |      *
 22 |      * @var string
 23 |      */
 24 |     public $id;
 25 | 
 26 |     /**
 27 |      * The unique ID that identifies the conversation that this message is a
 28 |      * part of.
 29 |      *
 30 |      * @var string
 31 |      */
 32 |     public $conversationId;
 33 | 
 34 |     /**
 35 |      * The unique ID that identifies the channel that the message is sent or
 36 |      * received on.
 37 |      *
 38 |      * @var string
 39 |      */
 40 |     public $channelId;
 41 | 
 42 |     /**
 43 |      * The direction of the message. Either 'sent' (mobile-terminated) for
 44 |      * outbound messages sent through the API or 'received' (mobile-originated)
 45 |      * for inbound messages from the contact.
 46 |      *
 47 |      * @var string|null
 48 |      */
 49 |     public $direction;
 50 | 
 51 |     /**
 52 |      * The status of the message. Possible values: "pending", "received",
 53 |      * "sent", "delivered", "read", "unsupported", "failed" and
 54 |      * "pending_media".
 55 |      *
 56 |      * @var string
 57 |      */
 58 |     public $status;
 59 | 
 60 |     /**
 61 |      * Type of this message's content. Possible values: "text", "image",
 62 |      * "audio", "video", "file", "location", "hsm", "interactive", "email".
 63 |      *
 64 |      * @var string
 65 |      */
 66 |     public $type;
 67 | 
 68 |     /**
 69 |      * Content of the message. Implementation dependent on this message's type.
 70 |      *
 71 |      * @var Content
 72 |      */
 73 |     public $content;
 74 | 
 75 |     /**
 76 |      * Identifier for the receiver. For example the phone number (MSISDN) for
 77 |      * SMS-based channels.
 78 |      *
 79 |      * @var string
 80 |      */
 81 |     public $to;
 82 | 
 83 |     /**
 84 |      * The date and time when this message was first created in RFC3339 format.
 85 |      *
 86 |      * @var string
 87 |      */
 88 |     public $createdDatetime;
 89 | 
 90 |     /**
 91 |      * The date and time when this message was most recently updated in
 92 |      * RFC3339 format.
 93 |      *
 94 |      * @var string
 95 |      */
 96 |     public $updatedDatetime;
 97 | 
 98 |     /**
 99 |      * @deprecated 2.2.0 No longer used by internal code, please switch to {@see self::loadFromStdclass()}
100 |      * 
101 |      * @param mixed $object
102 |      */
103 |     public function loadFromArray($object): Message
104 |     {
105 |         parent::loadFromArray($object);
106 | 
107 |         $content = new Content();
108 |         $content->loadFromArray($this->content);
109 | 
110 |         $this->content = $content;
111 | 
112 |         return $this;
113 |     }
114 | 
115 |     public function loadFromStdclass(stdClass $object): self
116 |     {
117 |         parent::loadFromStdclass($object);
118 | 
119 |         if (property_exists($object, 'content')) {
120 |             $content = new Content();
121 |             $content->loadFromStdclass($object->content);
122 |             $this->content = $content;
123 |         }
124 | 
125 |         return $this;
126 |     }
127 | 
128 |     /**
129 |      * Serialize only non empty fields.
130 |      */
131 |     public function jsonSerialize(): array
132 |     {
133 |         $json = [];
134 | 
135 |         foreach (get_object_vars($this) as $key => $value) {
136 |             if (!empty($value)) {
137 |                 $json[$key] = $value;
138 |             }
139 |         }
140 | 
141 |         return $json;
142 |     }
143 | }
144 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/SignedRequest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace MessageBird\Objects;
  4 | 
  5 | use MessageBird\Exceptions\ValidationException;
  6 | use MessageBird\RequestValidator;
  7 | 
  8 | /**
  9 |  * Class SignedRequest
 10 |  *
 11 |  * @package MessageBird\Objects
 12 |  *
 13 |  * @link https://developers.messagebird.com/docs/verify-http-requests
 14 |  * @deprecated Use {@link RequestValidator} instead.
 15 |  */
 16 | class SignedRequest extends Base
 17 | {
 18 |     /**
 19 |      * The timestamp passed in the MessageBird-Request-Timestamp header of the request.
 20 |      *
 21 |      * @var string
 22 |      */
 23 |     public $requestTimestamp;
 24 | 
 25 |     /**
 26 |      * The request body.
 27 |      *
 28 |      * @var string
 29 |      */
 30 |     public $body;
 31 | 
 32 |     /**
 33 |      * The query parameters for the request.
 34 |      *
 35 |      * @var array
 36 |      */
 37 |     public $queryParameters = [];
 38 | 
 39 |     /**
 40 |      * The signature passed in the MessageBird-Signature header of the request.
 41 |      *
 42 |      * @var string
 43 |      */
 44 |     public $signature;
 45 | 
 46 |     /**
 47 |      * Create a new SignedRequest from PHP globals.
 48 |      *
 49 |      * @throws ValidationException when a required parameter is missing.
 50 |      * @deprecated Use {@link RequestValidator::validateRequestFromGlobals()} instead.
 51 |      */
 52 |     public static function createFromGlobals(): SignedRequest
 53 |     {
 54 |         $body = file_get_contents('php://input');
 55 |         $queryParameters = $_GET;
 56 |         $requestTimestamp = isset($_SERVER['HTTP_MESSAGEBIRD_REQUEST_TIMESTAMP']) ?
 57 |             (int)$_SERVER['HTTP_MESSAGEBIRD_REQUEST_TIMESTAMP'] : null;
 58 |         $signature = $_SERVER['HTTP_MESSAGEBIRD_SIGNATURE'] ?? null;
 59 | 
 60 |         $signedRequest = new self();
 61 |         $signedRequest->loadFromArray(compact('body', 'queryParameters', 'requestTimestamp', 'signature'));
 62 | 
 63 |         return $signedRequest;
 64 |     }
 65 | 
 66 |     /**
 67 |      * Create a SignedRequest from the provided data.
 68 |      *
 69 |      * @param string|array $query The query string from the request
 70 |      * @param string $signature The base64-encoded signature for the request
 71 |      * @param int $requestTimestamp The UNIX timestamp for the time the request was made
 72 |      * @param string $body The request body
 73 |      * @return SignedRequest
 74 |      * @throws ValidationException when a required parameter is missing.
 75 |      * @deprecated Use {@link RequestValidator::validateSignature()} instead.
 76 |      */
 77 |     public static function create($query, string $signature, int $requestTimestamp, string $body): SignedRequest
 78 |     {
 79 |         if (is_string($query)) {
 80 |             $queryParameters = [];
 81 |             parse_str($query, $queryParameters);
 82 |         } else {
 83 |             $queryParameters = $query;
 84 |         }
 85 | 
 86 |         $signedRequest = new self();
 87 |         $signedRequest->loadFromArray(compact('body', 'queryParameters', 'requestTimestamp', 'signature'));
 88 | 
 89 |         return $signedRequest;
 90 |     }
 91 | 
 92 |     /**
 93 |      * {@inheritdoc}
 94 |      * @throws ValidationException when a required parameter is missing.
 95 |      */
 96 |     public function loadFromArray($object): self
 97 |     {
 98 |         if (!isset($object['requestTimestamp']) || !\is_int($object['requestTimestamp'])) {
 99 |             throw new ValidationException('The "requestTimestamp" value is missing or invalid.');
100 |         }
101 | 
102 |         if (!isset($object['signature']) || !\is_string($object['signature'])) {
103 |             throw new ValidationException('The "signature" parameter is missing.');
104 |         }
105 | 
106 |         if (!isset($object['queryParameters']) || !\is_array($object['queryParameters'])) {
107 |             throw new ValidationException('The "queryParameters" parameter is missing or invalid.');
108 |         }
109 | 
110 |         if (!isset($object['body']) || !\is_string($object['body'])) {
111 |             throw new ValidationException('The "body" parameter is missing.');
112 |         }
113 | 
114 |         return parent::loadFromArray($object);
115 |     }
116 | }
117 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Lookup.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace MessageBird\Objects;
  4 | 
  5 | use stdClass;
  6 | 
  7 | /**
  8 |  * Class Lookup
  9 |  *
 10 |  * @package MessageBird\Objects
 11 |  */
 12 | class Lookup extends Base
 13 | {
 14 |     public const TYPE_FIXED_LINE = "fixed line";
 15 |     public const TYPE_MOBILE = "mobile";
 16 |     public const TYPE_FIXED_LINE_OR_MOBILE = "fixed line or mobile";
 17 |     public const TYPE_TOLL_FREE = "toll free";
 18 |     public const TYPE_PREMIUM_RATE = "premium rate";
 19 |     public const TYPE_SHARED_COST = "shared cost";
 20 |     public const TYPE_VOIP = "voip";
 21 |     public const TYPE_PERSONAL_NUMBER = "personal number";
 22 |     public const TYPE_PAGER = "pager";
 23 |     public const TYPE_UNIVERSAL_ACCESS_NUMBER = "universal access number";
 24 |     public const TYPE_VOICE_MAIL = "voice mail";
 25 |     public const TYPE_UNKNOWN = "unknown";
 26 | 
 27 |     /**
 28 |      * The URL of the created object.
 29 |      *
 30 |      * @var string
 31 |      */
 32 |     protected $href;
 33 |     /**
 34 |      * The country code for this number in ISO 3166-1 alpha-2 format.
 35 |      *
 36 |      * @var string
 37 |      */
 38 |     protected $countryCode;
 39 | 
 40 |     /**
 41 |      * The country calling code for this number.
 42 |      *
 43 |      * @var integer
 44 |      */
 45 |     protected $countryPrefix;
 46 | 
 47 |     /**
 48 |      * The phone number in E.164 format without the prefixed plus-sign.
 49 |      *
 50 |      * @var integer
 51 |      */
 52 |     protected $phoneNumber;
 53 | 
 54 |     /**
 55 |      * The type of number. This can be fixed line, mobile, fixed line or mobile, toll free, premium rate, shared cost, voip, personal number, pager, universal access number, voice mail or unknown*
 56 |      * @var string
 57 |      */
 58 |     protected $type;
 59 | 
 60 |     /**
 61 |      * An object containing references to this phone number in several formats.
 62 |      *
 63 |      * @var stdClass
 64 |      *
 65 |      * e164: The phone number in E.164 format.
 66 |      * international: The phone number in international format.
 67 |      * national: The phone number in national/local format.
 68 |      * rfc3966: The phone number in RFC3966 format.
 69 |      */
 70 |     protected $formats;
 71 | 
 72 |     /**
 73 |      * The most recent HLR object. If no such HLR objects exists, this array won't be returned.
 74 |      *
 75 |      * @var stdClass
 76 |      *
 77 |      * id(string): An unique random ID which is created on the MessageBird platform.
 78 |      * network(int): The MCCMNC code of the network provider.
 79 |      * reference(string): A client reference.
 80 |      * status(string): The status of the HLR request. Possible values: sent, absent, active, unknown, and failed.
 81 |      * createdDatetime(datetime): The date and time of the creation of the message in RFC3339 format (Y-m-d\TH:i:sP).
 82 |      * statusDatetime(datetime): The datum time of the last status in RFC3339 format (Y-m-d\TH:i:sP).
 83 |      */
 84 |     protected $hlr;
 85 | 
 86 |     public function getHref(): ?string
 87 |     {
 88 |         return $this->href;
 89 |     }
 90 | 
 91 |     public function getCountryCode(): ?string
 92 |     {
 93 |         return $this->countryCode;
 94 |     }
 95 | 
 96 |     public function getCountryPrefix(): ?int
 97 |     {
 98 |         return $this->countryPrefix;
 99 |     }
100 | 
101 |     public function getPhoneNumber(): ?int
102 |     {
103 |         return $this->phoneNumber;
104 |     }
105 | 
106 |     public function getType(): ?string
107 |     {
108 |         return $this->type;
109 |     }
110 | 
111 |     public function getFormats(): ?stdClass
112 |     {
113 |         return $this->formats;
114 |     }
115 | 
116 |     public function getHLR(): ?stdClass
117 |     {
118 |         return $this->hlr;
119 |     }
120 | 
121 |     /**
122 |      * @deprecated 2.2.0 No longer used by internal code, please switch to {@see self::loadFromStdclass()}
123 |      *
124 |      * @param mixed $object
125 |      *
126 |      * @return $this
127 |      */
128 |     public function loadFromArray($object): self
129 |     {
130 |         unset($this->hlr);
131 |         return parent::loadFromArray($object);
132 |     }
133 | 
134 |     public function loadFromStdclass(stdClass $object): self
135 |     {
136 |         unset($this->hlr);
137 |         return parent::loadFromStdclass($object);
138 |     }
139 | }
140 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/VoiceMessage.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace MessageBird\Objects;
  4 | 
  5 | /**
  6 |  * Class VoiceMessage
  7 |  *
  8 |  * @package MessageBird\Objects
  9 |  */
 10 | class VoiceMessage extends Base
 11 | {
 12 |     /**
 13 |      * The originator of the voice message.
 14 |      *
 15 |      * Should be a valid MSISDN (telephone number including country code)
 16 |      * @var string/int
 17 |      */
 18 |     public $originator;
 19 |     /**
 20 |      * The body of the voice message.
 21 |      *
 22 |      * @var string
 23 |      */
 24 |     public $body;
 25 |     /**
 26 |      * A client reference. Here you can put your own reference,
 27 |      * like your internal reference.
 28 |      *
 29 |      * @var string
 30 |      */
 31 |     public $reference;
 32 |     /**
 33 |      * The language in which the message needs to be read to the recipient.
 34 |      * Possible values are: nl-nl, de-de, en-gb, en-us, fr-fr
 35 |      *
 36 |      * @var string
 37 |      */
 38 |     public $language = 'en-gb';
 39 |     /**
 40 |      * The voice in which the messages needs to be read to the recipient
 41 |      * Possible values are: male, female
 42 |      *
 43 |      * @var string
 44 |      */
 45 |     public $voice = 'female';
 46 |     /**
 47 |      * How many times needs the message to be repeated?
 48 |      *
 49 |      * @var int
 50 |      */
 51 |     public $repeat = 1;
 52 |     /**
 53 |      * What to do when a machine picks up the phone?
 54 |      * Possible values are:
 55 |      *  - continue: do not check, just play the message
 56 |      *  - delay: if a machine answers, wait until the machine stops talking
 57 |      *  - hangup: hangup when a machine answers
 58 |      *
 59 |      * @var string
 60 |      */
 61 |     public $ifMachine = 'continue';
 62 |     /**
 63 |      * The time (in milliseconds) to analyze if a machine has picked up the phone. Used in combination with the delay
 64 |      * and hangup values of the ifMachine attribute. Minimum: 400, maximum: 10000.
 65 |      *
 66 |      * @var int
 67 |      */
 68 |     public $machineTimeout = 7000;
 69 |     /**
 70 |      * The scheduled date and time of the message in RFC3339 format (Y-m-d\TH:i:sP)
 71 |      *
 72 |      * @var string
 73 |      */
 74 |     public $scheduledDatetime;
 75 |     /**
 76 |      * An array of recipients
 77 |      *
 78 |      * @var array
 79 |      */
 80 |     public $recipients = [];
 81 |     /**
 82 |      * The URL to send status delivery reports for the voice message to
 83 |      *
 84 |      * @var string
 85 |      */
 86 |     public $reportUrl;
 87 |     /**
 88 |      * An unique random ID which is created on the MessageBird
 89 |      * platform and is returned upon creation of the object.
 90 |      *
 91 |      * @var string
 92 |      */
 93 |     protected $id;
 94 |     /**
 95 |      * The URL of the created object.
 96 |      *
 97 |      * @var string
 98 |      */
 99 |     protected $href;
100 |     /**
101 |      * The date and time of the creation of the message in RFC3339 format (Y-m-d\TH:i:sP)
102 |      * @var string
103 |      */
104 |     protected $createdDatetime;
105 | 
106 |     /**
107 |      * Get the created id
108 |      *
109 |      * @return mixed
110 |      */
111 |     public function getId()
112 |     {
113 |         return $this->id;
114 |     }
115 | 
116 |     /**
117 |      * Get the created href
118 |      */
119 |     public function getHref(): string
120 |     {
121 |         return $this->href;
122 |     }
123 | 
124 |     /**
125 |      * Get the date and time the resource was created
126 |      */
127 |     public function getCreatedDatetime(): string
128 |     {
129 |         return $this->createdDatetime;
130 |     }
131 | 
132 |     /**
133 |      * @deprecated 2.2.0 No longer used by internal code, please switch to {@see self::loadFromStdclass()}
134 |      * 
135 |      * @param mixed $object
136 |      *
137 |      * @return $this|void
138 |      */
139 |     public function loadFromArray($object): self
140 |     {
141 |         parent::loadFromArray($object);
142 | 
143 |         if (!empty($this->recipients->items)) {
144 |             foreach ($this->recipients->items as &$item) {
145 |                 $recipient = new Recipient();
146 |                 $recipient->loadFromArray($item);
147 | 
148 |                 $item = $recipient;
149 |             }
150 |         }
151 | 
152 |         return $this;
153 |     }
154 | }
155 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Contact.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace MessageBird\Objects;
  4 | 
  5 | use stdClass;
  6 | 
  7 | /**
  8 |  * Class Contact
  9 |  *
 10 |  * @package MessageBird\Objects
 11 |  */
 12 | class Contact extends Base
 13 | {
 14 |     /**
 15 |      * The phone number of contact.
 16 |      *
 17 |      * @var int
 18 |      */
 19 |     public $msisdn;
 20 |     /**
 21 |      * The first name of the contact.
 22 |      *
 23 |      * @var string
 24 |      */
 25 |     public $firstName;
 26 |     /**
 27 |      * The last name of the contact.
 28 |      *
 29 |      * @var string
 30 |      */
 31 |     public $lastName;
 32 |     /**
 33 |      * @var string
 34 |      */
 35 |     public $custom1;
 36 |     /**
 37 |      * @var string
 38 |      */
 39 |     public $custom2;
 40 |     /**
 41 |      * @var string
 42 |      */
 43 |     public $custom3;
 44 |     /**
 45 |      * @var string
 46 |      */
 47 |     public $custom4;
 48 |     /**
 49 |      * An unique random ID which is created on the MessageBird
 50 |      * platform and is returned upon creation of the object.
 51 |      *
 52 |      * @var string
 53 |      */
 54 |     protected $id;
 55 |     /**
 56 |      * The URL of the created object.
 57 |      *
 58 |      * @var string
 59 |      */
 60 |     protected $href;
 61 |     /**
 62 |      * Custom fields of the contact.
 63 |      *
 64 |      * @var stdClass
 65 |      */
 66 |     protected $customDetails = [];
 67 |     /**
 68 |      * The hash of the group this contact belongs to.
 69 |      *
 70 |      * @var ?stdClass
 71 |      */
 72 |     protected $groups = null;
 73 | 
 74 |     /**
 75 |      * The hash with messages sent to contact.
 76 |      *
 77 |      * @var ?stdClass
 78 |      */
 79 |     protected $messages = null;
 80 | 
 81 |     /**
 82 |      * The date and time of the creation of the contact in RFC3339 format (Y-m-d\TH:i:sP)
 83 |      *
 84 |      * @var string
 85 |      */
 86 |     protected $createdDatetime;
 87 | 
 88 |     /**
 89 |      * The date and time of the updated of the contact in RFC3339 format (Y-m-d\TH:i:sP)
 90 |      *
 91 |      * @var string|null
 92 |      */
 93 |     protected $updatedDatetime;
 94 | 
 95 |     public function getId(): string
 96 |     {
 97 |         return $this->id;
 98 |     }
 99 | 
100 |     public function getHref(): string
101 |     {
102 |         return $this->href;
103 |     }
104 | 
105 |     public function getGroups(): stdClass
106 |     {
107 |         return $this->groups;
108 |     }
109 | 
110 |     public function getMessages(): stdClass
111 |     {
112 |         return $this->messages;
113 |     }
114 | 
115 |     public function getCreatedDatetime(): string
116 |     {
117 |         return $this->createdDatetime;
118 |     }
119 | 
120 |     public function getUpdatedDatetime(): ?string
121 |     {
122 |         return $this->updatedDatetime;
123 |     }
124 | 
125 |     public function getCustomDetails(): stdClass
126 |     {
127 |         return $this->customDetails;
128 |     }
129 | 
130 |     /**
131 |      * @deprecated 2.2.0 No longer used by internal code, please switch to {@see self::loadFromStdclass()}
132 |      * 
133 |      * @param mixed $object
134 |      */
135 |     public function loadFromArray($object): self
136 |     {
137 |         unset($this->custom1, $this->custom2, $this->custom3, $this->custom4);
138 |         
139 |         return parent::loadFromArray($object);
140 |     }
141 | 
142 |     public function loadFromStdclass(stdClass $object): self
143 |     {
144 |         unset($this->custom1, $this->custom2, $this->custom3, $this->custom4);
145 |         
146 |         return parent::loadFromStdclass($object);
147 |     }
148 | 
149 |     /**
150 |      * @deprecated 2.2.0 No longer used by internal code, please switch to {@see self::loadFromStdclassForGroups()}
151 |      * 
152 |      * @param mixed $object
153 |      *
154 |      * @return $this ->object
155 |      */
156 |     public function loadFromArrayForGroups($object)
157 |     {
158 |         parent::loadFromArray($object);
159 | 
160 |         if (!empty($object->items)) {
161 |             foreach ($object->items as &$item) {
162 |                 $group = new Group();
163 |                 $group->loadFromArray($item);
164 | 
165 |                 $item = $group;
166 |             }
167 |         }
168 |         return $object;
169 |     }
170 | 
171 |     public function loadFromStdclassForGroups(stdClass $object)
172 |     {
173 |         parent::loadFromStdclass($object);
174 | 
175 |         if (!empty($object->items)) {
176 |             foreach ($object->items as &$item) {
177 |                 $group = new Group();
178 |                 $group->loadFromStdclass($item);
179 | 
180 |                 $item = $group;
181 |             }
182 |         }
183 |         return $object;
184 |     }
185 | }
186 | 


--------------------------------------------------------------------------------
/src/MessageBird/Resources/Groups.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace MessageBird\Resources;
  4 | 
  5 | use InvalidArgumentException;
  6 | use MessageBird\Common;
  7 | use MessageBird\Exceptions;
  8 | use MessageBird\Objects;
  9 | 
 10 | /**
 11 |  * Class Groups
 12 |  *
 13 |  * @package MessageBird\Resources
 14 |  */
 15 | class Groups extends Base
 16 | {
 17 |     /**
 18 |      * @var Contacts
 19 |      */
 20 |     private $contactsObject;
 21 | 
 22 |     public function __construct(Common\HttpClient $httpClient)
 23 |     {
 24 |         $this->object = new Objects\Group();
 25 |         $this->setResourceName('groups');
 26 | 
 27 |         $this->contactsObject = new Contacts($httpClient);
 28 | 
 29 |         parent::__construct($httpClient);
 30 |     }
 31 | 
 32 |     /**
 33 |      * @param mixed $object
 34 |      * @param mixed $id
 35 |      *
 36 |      * @return Objects\Balance|Objects\Conversation\Conversation|Objects\Hlr|Objects\Lookup|Objects\Message|Objects\Verify|Objects\VoiceMessage|null ->object
 37 |      *
 38 |      * @throws Exceptions\AuthenticateException
 39 |      * @throws Exceptions\HttpException
 40 |      * @throws Exceptions\RequestException
 41 |      * @throws Exceptions\ServerException
 42 |      * @throws \JsonException
 43 |      *
 44 |      * @internal param array $parameters
 45 |      */
 46 |     public function update($object, $id)
 47 |     {
 48 |         $objVars = get_object_vars($object);
 49 |         $body = [];
 50 |         foreach ($objVars as $key => $value) {
 51 |             if ($value !== null) {
 52 |                 $body[$key] = $value;
 53 |             }
 54 |         }
 55 | 
 56 |         $resourceName = $this->resourceName . ($id ? '/' . $id : null);
 57 |         $body = json_encode($body, \JSON_THROW_ON_ERROR);
 58 | 
 59 |         [, , $body] = $this->httpClient->performHttpRequest(
 60 |             Common\HttpClient::REQUEST_PATCH,
 61 |             $resourceName,
 62 |             false,
 63 |             $body
 64 |         );
 65 |         return $this->processRequest($body);
 66 |     }
 67 | 
 68 |     /**
 69 |      * @param string|null $id
 70 |      * @param array|null $parameters
 71 |      *
 72 |      * @return mixed
 73 |      *
 74 |      * @throws InvalidArgumentException
 75 |      * @throws \JsonException
 76 |      *
 77 |      */
 78 |     public function getContacts(?string $id = null, ?array $parameters = [])
 79 |     {
 80 |         if ($id === null) {
 81 |             throw new InvalidArgumentException('No group id provided.');
 82 |         }
 83 | 
 84 |         $this->contactsObject->setResourceName($this->resourceName . '/' . $id . '/contacts');
 85 |         return $this->contactsObject->getList($parameters);
 86 |     }
 87 | 
 88 |     /**
 89 |      * @param array $contacts
 90 |      * @param string|null $id
 91 |      *
 92 |      * @return mixed
 93 |      * @throws Exceptions\HttpException
 94 |      * @throws InvalidArgumentException
 95 |      *
 96 |      * @throws Exceptions\AuthenticateException
 97 |      * @throws \JsonException
 98 |      */
 99 |     public function addContacts(array $contacts, ?string $id = null)
100 |     {
101 |         if (!\is_array($contacts)) {
102 |             throw new  InvalidArgumentException('No array with contacts provided.');
103 |         }
104 |         if ($id === null) {
105 |             throw new InvalidArgumentException('No group id provided.');
106 |         }
107 | 
108 |         $resourceName = $this->resourceName . ($id ? '/' . $id . '/contacts' : null);
109 |         $contacts = json_encode($contacts, \JSON_THROW_ON_ERROR);
110 |         [$responseStatus, , $responseBody] = $this->httpClient->performHttpRequest(
111 |             Common\HttpClient::REQUEST_PUT,
112 |             $resourceName,
113 |             false,
114 |             $contacts
115 |         );
116 |         if ($responseStatus !== Common\HttpClient::HTTP_NO_CONTENT) {
117 |             return json_decode($responseBody, null, 512, \JSON_THROW_ON_ERROR);
118 |         }
119 |     }
120 | 
121 |     /**
122 |      * @param string|null $contact_id
123 |      * @param string|null $id
124 |      *
125 |      * @return mixed
126 |      * @throws Exceptions\HttpException
127 |      *
128 |      * @throws Exceptions\AuthenticateException
129 |      * @throws \JsonException
130 |      */
131 |     public function removeContact(?string $contact_id = null, ?string $id = null)
132 |     {
133 |         if ($contact_id === null || $id === null) {
134 |             throw new InvalidArgumentException('Null Contact or Group id.');
135 |         }
136 |         $resourceName = $this->resourceName . ($id ? '/' . $id . '/contacts/' . $contact_id : null);
137 | 
138 |         [$responseStatus, , $responseBody] = $this->httpClient->performHttpRequest(
139 |             Common\HttpClient::REQUEST_DELETE,
140 |             $resourceName
141 |         );
142 |         if ($responseStatus !== Common\HttpClient::HTTP_NO_CONTENT) {
143 |             return json_decode($responseBody, null, 512, \JSON_THROW_ON_ERROR);
144 |         }
145 |     }
146 | }
147 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Conversation/Conversation.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace MessageBird\Objects\Conversation;
  4 | 
  5 | use MessageBird\Objects\Base;
  6 | use stdClass;
  7 | 
  8 | /**
  9 |  * A conversation is the view of all messages between you and a customer across
 10 |  * any of your configured channels. Messages from multiple channels are
 11 |  * collected and displayed in a single thread. A conversation status can be
 12 |  * active or archived, but only one active conversation exists for each
 13 |  * customer at a time. If a message is received from a customer with no active
 14 |  * conversations, a new one will be created automatically.
 15 |  */
 16 | class Conversation extends Base
 17 | {
 18 |     public const STATUS_ACTIVE = 'active';
 19 |     public const STATUS_ARCHIVED = 'archived';
 20 | 
 21 |     /**
 22 |      * A unique ID generated by the MessageBird platform that identifies the
 23 |      * conversation.
 24 |      *
 25 |      * @var string
 26 |      */
 27 |     public $id;
 28 | 
 29 |     /**
 30 |      * The URL of this conversation object.
 31 |      *
 32 |      * @var string|null
 33 |      */
 34 |     public $href;
 35 | 
 36 |     /**
 37 |      * The expanded contact for this conversation.
 38 |      *
 39 |      * @var Contact
 40 |      */
 41 |     public $contact;
 42 | 
 43 |     /**
 44 |      * Associative array of Channels that the contact of this conversation can
 45 |      * be reached on.
 46 |      *
 47 |      * @var Channel[]
 48 |      */
 49 |     public $channels;
 50 | 
 51 |     /**
 52 |      * The status of this conversation. This can be either 'active' or
 53 |      * 'archived'.
 54 |      *
 55 |      * @var string
 56 |      */
 57 |     public $status;
 58 | 
 59 |     /**
 60 |      * Object that references the messages and the count belonging to this
 61 |      * conversation.
 62 |      *
 63 |      * @var MessageReference
 64 |      */
 65 |     public $messages;
 66 | 
 67 |     /**
 68 |      * Unique ID that references the last channel used for this conversation.
 69 |      *
 70 |      * @var string
 71 |      */
 72 |     public $lastUsedChannelId;
 73 | 
 74 |     /**
 75 |      * The date and time when the most recent message was added to this
 76 |      * conversation in RFC3339 format.
 77 |      *
 78 |      * @var string
 79 |      */
 80 |     public $lastReceivedDatetime;
 81 | 
 82 |     /**
 83 |      * The date and time when this conversation was first created in RFC3339
 84 |      * format.
 85 |      *
 86 |      * @var string
 87 |      */
 88 |     public $createdDatetime;
 89 | 
 90 |     /**
 91 |      * The date and time when this conversation was most recently updated in
 92 |      * RFC3339 format. This applies only to changes of the Conversation object
 93 |      * itself, not messages, i.e. currently just status changes.
 94 |      *
 95 |      * @var string
 96 |      */
 97 |     public $updatedDatetime;
 98 | 
 99 |     /**
100 |      * @deprecated 2.2.0 No longer used by internal code, please switch to {@see self::loadFromStdclass()}
101 |      * 
102 |      * @param mixed $object
103 |      */
104 |     public function loadFromArray($object): Conversation
105 |     {
106 |         parent::loadFromArray($object);
107 | 
108 |         if (!empty($this->contact)) {
109 |             $newContact = new Contact();
110 |             $newContact->loadFromArray($this->contact);
111 | 
112 |             $this->contact = $newContact;
113 |         }
114 | 
115 |         if (!empty($this->channels)) {
116 |             $channels = [];
117 | 
118 |             foreach ($this->channels as $channel) {
119 |                 $newChannel = new Channel();
120 |                 $newChannel->loadFromArray($channel);
121 | 
122 |                 $channels[] = $newChannel;
123 |             }
124 | 
125 |             $this->channels = $channels;
126 |         }
127 | 
128 |         if (!empty($this->messages)) {
129 |             $messages = new MessageReference();
130 |             $messages->loadFromArray($this->messages);
131 | 
132 |             $this->messages = $messages;
133 |         }
134 | 
135 |         return $this;
136 |     }
137 | 
138 |     public function loadFromStdclass(stdClass $object): self
139 |     {
140 |         parent::loadFromStdclass($object);
141 | 
142 |         if (!empty($object->contact)) {
143 |             $newContact = new Contact();
144 |             $newContact->loadFromStdclass($object->contact);
145 | 
146 |             $this->contact = $newContact;
147 |         }
148 | 
149 |         if (!empty($object->channels)) {
150 |             $channels = [];
151 | 
152 |             foreach ($object->channels as $channel) {
153 |                 $newChannel = new Channel();
154 |                 $newChannel->loadFromStdclass($channel);
155 | 
156 |                 $channels[] = $newChannel;
157 |             }
158 | 
159 |             $this->channels = $channels;
160 |         }
161 | 
162 |         if (!empty($object->messages)) {
163 |             $messages = new MessageReference();
164 |             $messages->loadFromStdclass($object->messages);
165 | 
166 |             $this->messages = $messages;
167 |         }
168 | 
169 |         return $this;
170 |     }
171 | }
172 | 


--------------------------------------------------------------------------------
/src/MessageBird/Objects/Message.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace MessageBird\Objects;
  4 | 
  5 | use stdClass;
  6 | 
  7 | /**
  8 |  * Class Message
  9 |  *
 10 |  * @property int $protocolId
 11 |  * @package MessageBird\Objects
 12 |  */
 13 | class Message extends Base
 14 | {
 15 |     public const TYPE_SMS = 'sms';
 16 |     public const TYPE_BINARY = 'binary';
 17 | 
 18 |     public const DATACODING_UNICODE = 'unicode';
 19 |     public const DATACODING_PLAIN = 'plain';
 20 | 
 21 |     /**
 22 |      * Tells you if the message is sent or received.
 23 |      * mt: mobile terminated (sent to mobile)
 24 |      * mo: mobile originated (received from mobile)
 25 |      *
 26 |      * @var string
 27 |      */
 28 |     public $direction = 'mt';
 29 | 
 30 |     /**
 31 |      * The type of message. Values can be: sms, binary, premium, or flash
 32 |      *
 33 |      * @var string
 34 |      */
 35 |     public $type = self::TYPE_SMS;
 36 | 
 37 |     /**
 38 |      * The sender of the message. This can be a telephone number
 39 |      * (including country code) or an alphanumeric string. In case
 40 |      * of an alphanumeric string, the maximum length is 11 characters.
 41 |      *
 42 |      * @var string
 43 |      */
 44 |     public $originator;
 45 | 
 46 |     /**
 47 |      * The body of the SMS message.
 48 |      *
 49 |      * @var string
 50 |      */
 51 |     public $body;
 52 | 
 53 |     /**
 54 |      * A client reference. Here you can put your own reference,
 55 |      * like your internal reference.
 56 |      *
 57 |      * @var string
 58 |      */
 59 |     public $reference;
 60 | 
 61 |     /**
 62 |      * The amount of seconds that the message is valid.
 63 |      * If a message is not delivered within this time,
 64 |      * the message will be discarded.
 65 |      *
 66 |      * @var int
 67 |      */
 68 |     public $validity;
 69 | 
 70 |     /**
 71 |      * The SMS route that is used to send the message. This is for
 72 |      * advanced users.
 73 |      *
 74 |      * @var int
 75 |      */
 76 |     public $gateway;
 77 | 
 78 |     /**
 79 |      * An associative array with extra information. Is only used when a binary or premium
 80 |      * message is sent.
 81 |      *
 82 |      * @var array
 83 |      */
 84 |     public $typeDetails = [];
 85 | 
 86 |     /**
 87 |      * The datacoding used, can be plain or unicode
 88 |      *
 89 |      * @var string
 90 |      */
 91 |     public $datacoding = self::DATACODING_PLAIN;
 92 | 
 93 |     /**
 94 |      * Indicates the message type. 1 is a normal message, 0 is a flash message.
 95 |      *
 96 |      * @var int
 97 |      */
 98 |     public $mclass = 1;
 99 | 
100 |     /**
101 |      * The scheduled date and time of the message in RFC3339 format (Y-m-d\TH:i:sP)
102 |      *
103 |      * @var string
104 |      */
105 |     public $scheduledDatetime;
106 |     /**
107 |      * An array of recipients
108 |      *
109 |      * @var array
110 |      */
111 |     public $recipients = [];
112 |     /**
113 |      * The URL to send status delivery reports for the message to
114 |      *
115 |      * @var string
116 |      */
117 |     public $reportUrl;
118 |     /**
119 |      * The date and time of the creation of the message in RFC3339 format (Y-m-d\TH:i:sP)
120 |      * @var string
121 |      */
122 |     protected $createdDatetime;
123 | 
124 |     /**
125 |      * @param mixed $header
126 |      * @param mixed $body
127 |      */
128 |     public function setBinarySms($header, $body): void
129 |     {
130 |         $this->typeDetails['udh'] = $header;
131 |         $this->body = $body;
132 |         $this->type = self::TYPE_BINARY;
133 |     }
134 | 
135 |     /**
136 |      * @param mixed $bool
137 |      */
138 |     public function setFlash($bool): void
139 |     {
140 |         if ($bool === true) {
141 |             $this->mclass = 0;
142 |         } else {
143 |             $this->mclass = 1;
144 |         }
145 |     }
146 | 
147 |     /**
148 |      * Get the $createdDatetime value
149 |      *     */
150 |     public function getCreatedDatetime(): string
151 |     {
152 |         return $this->createdDatetime;
153 |     }
154 | 
155 |     /**
156 |      * @deprecated 2.2.0 No longer used by internal code, please switch to {@see self::loadFromStdclass()}
157 |      * 
158 |      * @param mixed $object
159 |      * 
160 |      * @return self
161 |      */
162 |     public function loadFromArray($object): self
163 |     {
164 |         parent::loadFromArray($object);
165 | 
166 |         if (!empty($this->recipients->items)) {
167 |             foreach ($this->recipients->items as &$item) {
168 |                 $recipient = new Recipient();
169 |                 $recipient->loadFromArray($item);
170 | 
171 |                 $item = $recipient;
172 |             }
173 |         }
174 | 
175 |         return $this;
176 |     }
177 | 
178 |     /**
179 |      * @param stdClass $object 
180 |      * @return self 
181 |      */
182 |     public function loadFromStdclass(stdClass $object): self
183 |     {
184 |         parent::loadFromStdclass($object);
185 | 
186 |         if (!empty($this->recipients->items)) {
187 |             foreach ($this->recipients->items as &$item) {
188 |                 $recipient = new Recipient();
189 |                 $recipient->loadFromStdclass($item);
190 | 
191 |                 $item = $recipient;
192 |             }
193 |         }
194 | 
195 |         return $this;
196 |     }
197 | }
198 | 


--------------------------------------------------------------------------------
/src/MessageBird/Resources/Voice/Recordings.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace MessageBird\Resources\Voice;
  4 | 
  5 | use MessageBird\Common;
  6 | use MessageBird\Common\HttpClient;
  7 | use MessageBird\Exceptions;
  8 | use MessageBird\Objects;
  9 | 
 10 | /**
 11 |  * Class Recordings
 12 |  *
 13 |  * @package MessageBird\Resources\Voice
 14 |  */
 15 | class Recordings
 16 | {
 17 |     /**
 18 |      * @var HttpClient
 19 |      */
 20 |     protected $httpClient;
 21 | 
 22 |     /**
 23 |      * @var Objects\Voice\Recording
 24 |      */
 25 |     protected $object;
 26 | 
 27 |     public function __construct(HttpClient $httpClient)
 28 |     {
 29 |         $this->httpClient = $httpClient;
 30 |         $this->object = new Objects\Voice\Recording();
 31 |     }
 32 | 
 33 |     public function getObject(): Objects\Voice\Recording
 34 |     {
 35 |         return $this->object;
 36 |     }
 37 | 
 38 |     /**
 39 |      * @deprecated
 40 |      * 
 41 |      * @param mixed $object
 42 |      */
 43 |     public function setObject($object): void
 44 |     {
 45 |         $this->object = $object;
 46 |     }
 47 | 
 48 |     /**
 49 |      * @return Objects\BaseList|Objects\Voice\Recording
 50 |      * @throws Exceptions\AuthenticateException
 51 |      * @throws Exceptions\HttpException
 52 |      * @throws \JsonException
 53 |      */
 54 |     public function getList(string $callId, string $legId, array $parameters = [])
 55 |     {
 56 |         [$status, , $body] = $this->httpClient->performHttpRequest(
 57 |             HttpClient::REQUEST_GET,
 58 |             "calls/$callId/legs/$legId/recordings",
 59 |             $parameters
 60 |         );
 61 | 
 62 |         if ($status === 200) {
 63 |             $body = json_decode($body, null, 512, \JSON_THROW_ON_ERROR);
 64 | 
 65 |             $items = $body->data;
 66 |             unset($body->data);
 67 | 
 68 |             $baseList = new Objects\BaseList();
 69 |             $baseList->loadFromStdclass($body);
 70 | 
 71 |             $objectName = $this->object;
 72 | 
 73 |             foreach ($items as $item) {
 74 |                 /** @psalm-suppress UndefinedClass */
 75 |                 $object = new $objectName($this->httpClient);
 76 | 
 77 |                 $itemObject = $object->loadFromStdclass($item);
 78 |                 $baseList->items[] = $itemObject;
 79 |             }
 80 |             return $baseList;
 81 |         }
 82 | 
 83 |         return $this->processRequest($body);
 84 |     }
 85 | 
 86 |     /**
 87 |      * @throws Exceptions\AuthenticateException
 88 |      * @throws Exceptions\BalanceException
 89 |      * @throws Exceptions\RequestException
 90 |      * @throws Exceptions\ServerException
 91 |      */
 92 |     public function processRequest(?string $body): Objects\Voice\Recording
 93 |     {
 94 |         try {
 95 |             $body = @json_decode($body, null, 512, \JSON_THROW_ON_ERROR);
 96 |         } catch (\JsonException $e) {
 97 |             throw new Exceptions\ServerException('Got an invalid JSON response from the server.');
 98 |         }
 99 | 
100 |         if ($body === null) {
101 |             throw new Exceptions\ServerException('Got an invalid JSON response from the server.');
102 |         }
103 | 
104 |         if (empty($body->errors)) {
105 |             return $this->object->loadFromStdclass($body->data[0]);
106 |         }
107 | 
108 |         $responseError = new Common\ResponseError($body);
109 |         throw new Exceptions\RequestException($responseError->getErrorString());
110 |     }
111 | 
112 |     /**
113 |      * @throws Exceptions\AuthenticateException
114 |      * @throws Exceptions\BalanceException
115 |      * @throws Exceptions\HttpException
116 |      * @throws Exceptions\RequestException
117 |      * @throws Exceptions\ServerException
118 |      */
119 |     public function read(string $callId, string $legId, string $recordingId): Objects\Voice\Recording
120 |     {
121 |         [, , $body] = $this->httpClient->performHttpRequest(
122 |             HttpClient::REQUEST_GET,
123 |             "calls/$callId/legs/$legId/recordings/$recordingId"
124 |         );
125 | 
126 |         return $this->processRequest($body);
127 |     }
128 | 
129 |     /**
130 |      * @throws Exceptions\AuthenticateException
131 |      * @throws Exceptions\BalanceException
132 |      * @throws Exceptions\HttpException
133 |      * @throws Exceptions\RequestException
134 |      * @throws Exceptions\ServerException
135 |      */
136 |     public function delete(string $callId, string $legId, string $recordingId): Objects\Voice\Recording
137 |     {
138 |         [, , $body] = $this->httpClient->performHttpRequest(
139 |             HttpClient::REQUEST_DELETE,
140 |             "calls/$callId/legs/$legId/recordings/$recordingId"
141 |         );
142 |         return $this->processRequest($body);
143 |     }
144 | 
145 |     /**
146 |      * @return mixed
147 |      * @throws Exceptions\AuthenticateException
148 |      * @throws Exceptions\BalanceException
149 |      * @throws Exceptions\HttpException
150 |      * @throws Exceptions\RequestException
151 |      * @throws Exceptions\ServerException
152 |      */
153 |     public function download(string $callId, string $legId, string $recordingId)
154 |     {
155 |         [$status, , $body] = $this->httpClient->performHttpRequest(
156 |             HttpClient::REQUEST_GET,
157 |             "calls/$callId/legs/$legId/recordings/$recordingId.wav"
158 |         );
159 | 
160 |         if ($status !== 200) {
161 |             return $this->processRequest($body);
162 |         }
163 | 
164 |         return $body;
165 |     }
166 | }
167 | 


--------------------------------------------------------------------------------