PHPackages                             esendex/sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [HTTP & Networking](/categories/http)
4. /
5. esendex/sdk

ActiveLibrary[HTTP & Networking](/categories/http)

esendex/sdk
===========

Send SMS from your application using the Esendex API

v3.0.0(5y ago)22967.1k↓25.4%18[8 issues](https://github.com/esendex/esendex-php-sdk/issues)[8 PRs](https://github.com/esendex/esendex-php-sdk/pulls)4BSD-3-ClausePHPPHP >=7.3

Since Mar 11Pushed 1y ago48 watchersCompare

[ Source](https://github.com/esendex/esendex-php-sdk)[ Packagist](https://packagist.org/packages/esendex/sdk)[ Docs](http://developers.esendex.com)[ RSS](/packages/esendex-sdk/feed)WikiDiscussions master Synced 1w ago

READMEChangelog (1)Dependencies (3)Versions (20)Used By (4)

Esendex PHP Client
==================

[](#esendex-php-client)

[![Build Status](https://camo.githubusercontent.com/68f0db052d8279fcc255168272ac0dc6cecd64ea95ff862885c66276f26aae90/68747470733a2f2f7472617669732d63692e6f72672f6573656e6465782f6573656e6465782d7068702d73646b2e737667)](https://travis-ci.org/esendex/esendex-php-sdk) [![Latest Stable Version](https://camo.githubusercontent.com/8db4a503dd350286220f564e5eb5acd524747246f7c484efa75129e8266d19ac/68747470733a2f2f706f7365722e707567782e6f72672f6573656e6465782f73646b2f762f737461626c652e706e67)](https://packagist.org/packages/esendex/sdk) [![Latest Unstable Version](https://camo.githubusercontent.com/988b702425b6903d7a5491394edbb5b8c0f25aa61f8e745f1838b5eab487c9f4/68747470733a2f2f706f7365722e707567782e6f72672f6573656e6465782f73646b2f762f756e737461626c652e706e67)](https://packagist.org/packages/esendex/sdk) [![License](https://camo.githubusercontent.com/0e4ba5f4e514e0dbc93708bfdab3a8a8e94feb5d753d188d278cd697648998dd/68747470733a2f2f706f7365722e707567782e6f72672f6573656e6465782f73646b2f6c6963656e73652e706e67)](https://packagist.org/packages/esendex/sdk)

Installation
------------

[](#installation)

### Requirements

[](#requirements)

- PHP >= 8.3
- ext-curl enabled

The **esendex-php-sdk** is available to install through several methods as well as from source.

#### Composer

[](#composer)

```
{
    "require": {
        "esendex/sdk": "3.*.*"
    }
}
```

Composer is not included within the repository, so you will need to retrieve it using the following command:

```
curl -sS https://getcomposer.org/installer | php
```

For installation on other platforms see [getcomposer.org](https://getcomposer.org)

We're in the default [`Packagist`](http://packagist.org/packages/esendex/sdk) repository so just run

```
$ php composer.phar require esendex/sdk:3.*.*
```

or add the package above to your *composer.json*

Then just include Composer's generated *autoload.php* somewhere in your code;

```
require_once 'path/to/vendor/autoload.php';
```

#### GZIP

[](#gzip)

Download the current version [here](http://downloads.esendex.com.s3-website-eu-west-1.amazonaws.com/esendex-php-sdk/latest.sdk)

Our autoloader may be included somewhere in your application;

```
require_once 'path/to/downloaded/sdk/src/Esendex/AutoLoad.php';
```

Getting Started
---------------

[](#getting-started)

#### Sending SMS

[](#sending-sms)

```
$message = new \Esendex\Model\DispatchMessage(
    "WebApp", // Send from
    "01234567890", // Send to any valid number
    "My Web App is SMS enabled!",
    \Esendex\Model\Message::SmsType
);
$authentication = new \Esendex\Authentication\LoginAuthentication(
    "EX000000", // Your Esendex Account Reference
    "user@example.com", // Your login email address
    "password" // Your password
);
$service = new \Esendex\DispatchService($authentication);
$result = $service->send($message);

print $result->id();
print $result->uri();
```

#### Retrieving Inbox Messages

[](#retrieving-inbox-messages)

```
$authentication = new \Esendex\Authentication\LoginAuthentication(
    "EX000000", // Your Esendex Account Reference
    "user@example.com", // Your login email address
    "password" // Your password
);
$service = new \Esendex\InboxService($authentication);

$result = $service->latest();

print "Total Inbox Messages: {$result->totalCount()}";
print "Fetched: {$result->count()}";
foreach ($result as $message) {
    print "Message from: {$message->originator()}, {$message->summary()}";
}
```

#### Track Message Status

[](#track-message-status)

```
$authentication = new \Esendex\Authentication\LoginAuthentication(
    "EX000000", // Your Esendex account reference
    "user@example.com", // Your login email
    "password" // Your password
);
$headerService = new \Esendex\MessageHeaderService($authentication);
$message = $headerService->message("messageId");
print_r($message->status());
```

#### Retrieving Full Message Body

[](#retrieving-full-message-body)

```
$messageId = "unique-id-of-message";
$authentication = new \Esendex\Authentication\LoginAuthentication(
    "EX000000", // Your Esendex Account Reference
    "user@example.com", // Your login email address
    "password" // Your password
);
$service = new \Esendex\MessageBodyService($authentication);

$result = $service->getMessageBodyById($messageId);

print $result;
```

Would you like to know more?
----------------------------

[](#would-you-like-to-know-more)

Full REST API documentation can be found @ [developers.esendex.com](http://developers.esendex.com/)

Testing
-------

[](#testing)

#### Unit Tests

[](#unit-tests)

You will need to install composer in order to acquire the pre-requisites. This can be achieved by the following command:

```
$ curl -sS https://getcomposer.org/installer | php
```

To retrieve said pre-requisites execute the following:

```
$ composer.phar install
```

A suite of tests can be found in the `test` directory. To run them use the [phing](http://www.phing.info) build utility. e.g.

```
$ php vendor/bin/phing
```

#### Credentials Test

[](#credentials-test)

You can check your account credentials using a phing task we have provided. First, ensure dependencies have been installed with composer:

```
$ composer.phar install
```

Run the `check-access` script:

```
$ vendor/bin/phing check-access
Buildfile: /home/developer/esendex-php-sdk/build.xml

EsendexSDK > check-access:

Esendex Username ? user@example.com
Esendex Password ? secret
Account Reference? EX000000

    Account credentials OK!

BUILD FINISHED

Total time: 10.0000 seconds
```

Issues
------

[](#issues)

We hope you don't run into any issues but if you should please make use of the issue tracker on [github](https://github.com/esendex/esendex-php-sdk/issues) or send an email to

Feedback
--------

[](#feedback)

Let us know what you think [@esendex](http://twitter.com/esendex)

###  Health Score

47

—

FairBetter than 93% of packages

Maintenance27

Infrequent updates — may be unmaintained

Popularity50

Moderate usage in the ecosystem

Community33

Small or concentrated contributor base

Maturity67

Established project with proven stability

 Bus Factor1

Top contributor holds 52.2% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~170 days

Recently: every ~404 days

Total

18

Last Release

1938d ago

Major Versions

v1.3.0 → v2.0.02017-01-03

v2.1.1 → v3.0.02021-02-17

PHP version history (2 changes)v1.0.0PHP >=5.3

v3.0.0PHP >=7.3

### Community

Maintainers

![](https://www.gravatar.com/avatar/eed5a84791ffbf0593c4a421f35df8f963724993a8b78cf154f2ccb5e5d2b184?d=identicon)[esendex](/maintainers/esendex)

---

Top Contributors

[![jimgolfgti](https://avatars.githubusercontent.com/u/1206573?v=4)](https://github.com/jimgolfgti "jimgolfgti (35 commits)")[![zazoomauro](https://avatars.githubusercontent.com/u/580627?v=4)](https://github.com/zazoomauro "zazoomauro (5 commits)")[![StewartHCommify](https://avatars.githubusercontent.com/u/156438823?v=4)](https://github.com/StewartHCommify "StewartHCommify (5 commits)")[![johnj33](https://avatars.githubusercontent.com/u/3042745?v=4)](https://github.com/johnj33 "johnj33 (4 commits)")[![jackthorley](https://avatars.githubusercontent.com/u/6706510?v=4)](https://github.com/jackthorley "jackthorley (4 commits)")[![mwalton-esendex](https://avatars.githubusercontent.com/u/32637922?v=4)](https://github.com/mwalton-esendex "mwalton-esendex (4 commits)")[![EsendexDev](https://avatars.githubusercontent.com/u/1257918?v=4)](https://github.com/EsendexDev "EsendexDev (2 commits)")[![aaronjamesford](https://avatars.githubusercontent.com/u/994315?v=4)](https://github.com/aaronjamesford "aaronjamesford (1 commits)")[![jonathanrelf](https://avatars.githubusercontent.com/u/584662?v=4)](https://github.com/jonathanrelf "jonathanrelf (1 commits)")[![moretonb](https://avatars.githubusercontent.com/u/1859601?v=4)](https://github.com/moretonb "moretonb (1 commits)")[![andrewseward](https://avatars.githubusercontent.com/u/655436?v=4)](https://github.com/andrewseward "andrewseward (1 commits)")[![olitomlinson](https://avatars.githubusercontent.com/u/4224880?v=4)](https://github.com/olitomlinson "olitomlinson (1 commits)")[![SLStinson](https://avatars.githubusercontent.com/u/9193810?v=4)](https://github.com/SLStinson "SLStinson (1 commits)")[![Codesleuth](https://avatars.githubusercontent.com/u/5011956?v=4)](https://github.com/Codesleuth "Codesleuth (1 commits)")[![javier-commify](https://avatars.githubusercontent.com/u/52206183?v=4)](https://github.com/javier-commify "javier-commify (1 commits)")

---

Tags

apirestsmsrestfulrequests

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/esendex-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/esendex-sdk/health.svg)](https://phpackages.com/packages/esendex-sdk)
```

###  Alternatives

[nategood/httpful

A Readable, Chainable, REST friendly, PHP HTTP Client

1.8k17.5M274](/packages/nategood-httpful)[ismaeltoe/osms

PHP library wrapper of the Orange SMS API.

4540.5k](/packages/ismaeltoe-osms)[voku/httpful

A Readable, Chainable, REST friendly, PHP HTTP Client

16185.0k1](/packages/voku-httpful)[tbbc/rest-util-bundle

Bundle for integrating tbbc/rest-util lib in a Symfony application.

30207.1k1](/packages/tbbc-rest-util-bundle)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)