PHPackages                             nomado/nomado - 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. nomado/nomado

ActiveLibrary

nomado/nomado
=============

SDK to make requests to the nomado API

1.0.4(4y ago)1102MITPHPPHP >=5.5.0

Since Jan 27Pushed 4y ago2 watchersCompare

[ Source](https://github.com/nomadovoip/nomado-php)[ Packagist](https://packagist.org/packages/nomado/nomado)[ RSS](/packages/nomado-nomado/feed)WikiDiscussions master Synced 3d ago

READMEChangelogDependencies (2)Versions (6)Used By (0)

[![nomado Logo](https://camo.githubusercontent.com/6469df451d40b49255b770a0756d9b727b718544021487726e33e437df749e63/68747470733a2f2f6d792e6e6f6d61646f2e65752f6a6f696e2f7075626c69632f696d616765732f6e6f6d61646f2d6c6f676f2e706e67)](https://camo.githubusercontent.com/6469df451d40b49255b770a0756d9b727b718544021487726e33e437df749e63/68747470733a2f2f6d792e6e6f6d61646f2e65752f6a6f696e2f7075626c69632f696d616765732f6e6f6d61646f2d6c6f676f2e706e67)

PHP SDK for the nomado API
==========================

[](#php-sdk-for-the-nomado-api)

###  [ Website ](https://www.nomado.eu)  |  [ Support ](https://odoo.nomado.eu/page/contact-call-support-nomado)  |  [ Contact ](https://odoo.nomado.eu/page/website.contactus)  |  [ Contributing ](#contributing)

[](#----------website--------------------support--------------------contact--------------------contributing------)

Introduction
------------

[](#introduction)

nomado is a telephony and SMS solution for businesses and private customers. Our goal is to provide super user-friendly tools to meet your growing needs of nomadism.

This package provides a client to access the nomado API.

Table of Contents
-----------------

[](#table-of-contents)

- [Introduction](#introduction)
- [Installation](#installation)
- [Quickstart](#quickstart)
- [Documentation](#documentation)
- [TODO](#todo)
- [Contributing](#contributing)
- [Support](#support)

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

[](#installation)

```
composer require nomado/nomado

```

Quickstart
----------

[](#quickstart)

Below is a quick example for initializing the library and **sending a SMS**.

```
require('vendor/autoload.php');

$credentials = [
    'username' => 'username',
    'password' => 'password'
];

$nomado = new \nomado\Client($credentials);

$response = $nomado->sms->send([
                    'to' => [32123456789],
                    'message' => 'Hello World'
                   ]);

// response object
var_dump($response);
```

Documentation
-------------

[](#documentation)

The `\nomado\Client` class provides the public interfaces to access the nomado API

- `SMS`
- `OTP`
- `Calls`
- `HLR`
- `Account`

### Authentication

[](#authentication)

First, initialize the library with your nomado credentials.

```
$nomado = new \nomado\Client(['username' => 'username',
                              'password' => 'password'
                             ]);
```

Now, you can start sending requests to the API.

### Responses

[](#responses)

Every call will return a `Response` object wrapping the API response code and the data.

```
// Result object:
{
  code: 200,
  reason: "", //in case of error
  data: {}
}
```

### SMS

[](#sms)

**Send**

Send a SMS to one or multiple numbers.

```
$nomado->sms->send([
  'to' => ['3245678901','3245678902'], // e164 formatted numbers
  'message' => 'Bonjour le monde',
  'unicode' => false
]);

// example response object
{
  code: 200,
  data: {
    callerID: 'NOMADO',
    text: 'Bonjour le monde',
    unicode: 0,
    '3245678901': { ... },
    '3245678902': { ... }
  },
  cost: 0.16,
  total_sms: 2,
}
```

If you are sending unicode SMS, don't forget to turn on the `unicode` flag, otherwise encoding problems may occur.

### OTP

[](#otp)

Sending 2FA code via SMS to your users without the hassle.

**Send**

```
$nomado->otp->send([
  'to' => '3245678901', // e164 formatted number
  'template' => 'Your verification code is {{CODE}}.',
  'type' => 'ALPHANUMERIC', // optional, ALPHA, NUMERIC or ALPHANUMERIC (default)
  'length' => 4, // optional, defaults to 4
  'expiry' => 7200 // optional, defaults to 7200 seconds (2 hours)
])
```

In the template, `{{CODE}}` will be replaced by the generated 2FA code.

**Verify**

Let's check the code entered by your user.

```
$nomado->otp->verify([
  'number' => '3245678901', // their phone number,
  'token' => '456789' // their code
])

// expected response object
{
  code: 200,
  data: {
    verify: true
  }
}
```

Once the code has been verified, it becomes invalidated.

### Calls

[](#calls)

**Make**

Makes a call to a telephone line or number. When it answers, makes a second call to a number, bridging both calls together.

```
$nomado->calls->make([
  'cnumber' => '3245678901',
  'snumber' => '3245678902'
]);

// example response object
{
  code: 200
}
```

### HLR

[](#hlr)

Make HLR queries to any mobile number.

**Fetch**

```
$nomado->hlr->fetch({
  'numbers' => ['3245678901','3245678902'], // e164 formatted numbers
});

// example response object
{
  code: 200,
  data: {
    '3245678901': { ... },
    '3245678902': { ... },
    valid_numbers: 2
  },
  cost: 0.05,
}
```

**Validate**

Free query to validate mobile phone numbers and get short information

```
$nomado->hlr->validate({
  'number' => '3245678901', // e164 formatted number
});

// example response object
{
  code: 200,
  data: {
     Status: 'Valid',
     Region: 'BE',
     ...
  }
}
```

### Account

[](#account)

Easy way to check your current balance

**Get balance**

```
$nomado->account->getBalance();

// example response object
{
  code: 200,
  data: {
     balance: '95.740418'
  }
}
```

Contributing
------------

[](#contributing)

You are welcome to contribute in several ways like creating new features, fixing bugs, improving documentation, translating etc... [More information in CONTRIBUTING.md](CONTRIBUTING.md).

Support
-------

[](#support)

We are a small team dedicated to offer you the best support because we want to satisfy you. For any problem or question, feel free to [contact us](https://odoo.nomado.eu/page/contact-call-support-nomado).

Contributors
------------

[](#contributors)

- [Flavien Barsé](https://github.com/flavienb)
- [Aley Rizvi](https://github.com/aleyrizvi)

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity59

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 83.3% 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 ~337 days

Total

4

Last Release

1652d ago

### Community

Maintainers

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

---

Top Contributors

[![flavienb](https://avatars.githubusercontent.com/u/26281844?v=4)](https://github.com/flavienb "flavienb (15 commits)")[![deStrO](https://avatars.githubusercontent.com/u/519112?v=4)](https://github.com/deStrO "deStrO (2 commits)")[![aleyrizvi](https://avatars.githubusercontent.com/u/1640511?v=4)](https://github.com/aleyrizvi "aleyrizvi (1 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

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

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

###  Alternatives

[neuron-core/neuron-ai

The PHP Agentic Framework.

1.8k245.3k21](/packages/neuron-core-neuron-ai)[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[aedart/athenaeum

Athenaeum is a mono repository; a collection of various PHP packages

245.2k](/packages/aedart-athenaeum)

PHPackages © 2026

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