PHPackages                             irteel/irteelsms - 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. [API Development](/categories/api)
4. /
5. irteel/irteelsms

ActiveLibrary[API Development](/categories/api)

irteel/irteelsms
================

irteele SMS API is build for irteel SMS - Bulk SMS Application For Marketing

2.0.0(4y ago)18MITPHPPHP >=5.6.0

Since May 22Pushed 4y agoCompare

[ Source](https://github.com/irteel/irteelsms)[ Packagist](https://packagist.org/packages/irteel/irteelsms)[ RSS](/packages/irteel-irteelsms/feed)WikiDiscussions 3.0.0 Synced 1mo ago

READMEChangelog (2)DependenciesVersions (6)Used By (0)

[![Latest Stable Version](https://camo.githubusercontent.com/af746254bd9d4553b7875820ed20933853fb2fe54fbc18186fcc08478fdbac07/68747470733a2f2f706f7365722e707567782e6f72672f69727465656c2f69727465656c736d732f762f737461626c65)](https://packagist.org/packages/irteel/irteelsms?format=flat-square)[![License](https://camo.githubusercontent.com/fc82495b062504b483233ac6ab8db71efb5fda0a8376dbd45c02e695b85d7d68/68747470733a2f2f706f7365722e707567782e6f72672f69727465656c2f69727465656c736d732f6c6963656e7365)](https://packagist.org/packages/irteel/irteelsms?format=flat-square)[![GitHub issues](https://camo.githubusercontent.com/e306818a4c7e84a7485c064c69642003dbe6e23037acf6403673f4707ee4c429/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f69727465656c2f69727465656c736d732e7376673f7374796c653d666c61742d737175617265)](https://github.com/irteel/irteelsms/issues)[![GitHub stars](https://camo.githubusercontent.com/5859eb2e4062d38c6495b255fe2874b6d875e6d08f53d12655452f9b22a17880/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f69727465656c2f69727465656c736d733f7374796c653d666c61742d737175617265)](https://github.com/irteel/irteelsms/stargazers)

IRTEEL SMS API
==============

[](#irteel-sms-api)

IRTEEL SMS API is build for IRTEEL SMS - Bulk SMS Application For Marketing

### Prerequisites

[](#prerequisites)

To run IRTEEL SMS API you have recipient install IRTEEL SMS Application on your server. For more details please visit: [IRTEEL SMS](https://my.irteelsms.com/developers/docs)

```
php >=5.6
IRTEEL SMS - Bulk SMS Application For Markting

```

### Installing

[](#installing)

Via Composer

```
composer require irteel/irteelsms

```

And Via Bash

```
git clone https://github.com/irteel/irteelsms.git

```

Usage
-----

[](#usage)

### Step 1:

[](#step-1)

If install IRTEEL SMS API using Git Clone then load your IRTEEL SMS API Class file and Use namespace.

```
require_once 'src/Api/IRTEELSMSAPI.php';
use IRTEELSMS\IRTEELSMSAPI;
```

If install IRTEEL SMS API using Composer then Require/Include autoload.php file in the index.php of your project or whatever file you need recipient use **IRTEEL SMS API** classes:.

```
require 'vendor/autoload.php';
use IRTEELSMS\IRTEELSMSAPI;
```

### Step 2: set your API\_KEY from

[](#step-2-set-your-api_key-from-httpsmyirteelsmscomdevelopers)

```
$token = '3|39VVNH7w6pTaNEUgnTzpcX1iDsmnulcqFyMBv3TR';
```

### Step 3:

[](#step-3)

Change the sender\_id number below. It can be a valid phone number or a String

```
$sender_id = 'irteelSMS';
```

### Step 4:

[](#step-4)

the number we are sending recipient - Any phone number

```
$recipient = '237695601314';
```

For multiple number please use Comma (,) after every single number.

```
$recipient = '237695601314,8801721000000,880167000000,01913000000';
```

You can insert maximum 100 numbers using comma in single api request.

You have recipient must include Country code at beginning of the phone number.

### Step 5:

[](#step-5)

Set url to <api/v3> is mandatory. is mandatory on your install url

```
$url = 'https://my.irteelsms.com/api/v3';
```

// SMS Body

```
$message = 'test message sender_id IRTEEL SMS V3';
```

```
The sms type (Plain,Voice,MMS,Wathsapp)
// Plain text SMS
$type = 'plain'; //For Plain text message
```

// Schedule SMS

```
$schedule_time='2021-12-20 07:00'; //Time like this format: y-m/d h:mm
```

// Create Plain/text SMS Body for request

```
$message_body = array(

    'recipient' => $recipient,
    'sender_id' => $sender_id,
    'message' => $message,
	    'type' => 'plain',
);
```

// Create Voice SMS Body for request

```
$message_body = array(

    'recipient' => $recipient,
    'sender_id' => $sender_id,
    'message' => $message,
    'type' => 'voice',
);
```

// Create MMS SMS Body for request

```
$message_body = array(

    'recipient' => $recipient,
    'sender_id' => $sender_id,
    'message' => $message, //optional
    'type' => 'mms',
    'media_url'='https://via.placeholder.com/150.jpg'
);
```

// Create Whathsapp SMS Body for request

```
$message_body = array(

    'recipient' => $recipient,
    'sender_id' => $sender_id,
    'message' => $message,
    'type' => 'Whathsapp',
);
```

// Create Schedule SMS Body for request

```
$message_body = array(
    'recipient' => $recipient,
    'sender_id' => $sender_id,
    'message' => $message,
	'type' => $type,
    'schedule_time' => $schedule_time
);
```

### Step 6:

[](#step-6)

Instantiate a new IRTEEL SMS instance send sms request

```
$client = new IRTEELSMS($url,$message_body,$token);
```

Send SMS
--------

[](#send-sms)

Finally send your message through IRTEEL SMS API

```
$response = $client->sms_send();
```

### Step 6:

[](#step-6-1)

Instantiate a new IRTEEL SMS instance get report request

```
$client = new IRTEELSMS($url,'',$token);
```

Get Delivery Reports
--------------------

[](#get-delivery-reports)

Get your all message

```
$view_all_message=$client->sms_views();
```

Get Balance
-----------

[](#get-balance)

Get your account balance

```
$get_balance=$client->sms_balance();
```

Response
--------

[](#response)

IRTEEL SMS API return response with `json` format, like:

```
{"code":"ok","message":"Successfully Send"}
```

Status Code
-----------

[](#status-code)

StatusMessage`ok`Successfully Send`100`Bad gateway requested`101`Wrong action`102`Authentication failed`103`Invalid phone number`104`Phone coverage not active`105`Insufficient balance`106`Invalid Sender ID`107`Invalid SMS Type`108`SMS Gateway not active`109`Invalid Schedule Time`110`Media url required`111`SMS contain spam word. Wait for approvalAuthors
-------

[](#authors)

- **ing: Cyrille Brice Bidongo Bekono** - *Initial work* - [irteel](https://github.com/irteel/irteelsms)

###  Health Score

23

—

LowBetter than 27% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity50

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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 ~167 days

Total

3

Last Release

1479d ago

Major Versions

1.0.0 → 2.0.02021-07-24

2.0.0 → 3.0.0.x-dev2022-04-22

PHP version history (2 changes)1.0.0PHP >=5.3.0

2.0.0PHP >=5.6.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/5b970ec932ed356b3998863e23d3b7f2a670ce1f398626c558cc42d639d12f45?d=identicon)[cyrillebekono](/maintainers/cyrillebekono)

---

Top Contributors

[![cyrillebekono](https://avatars.githubusercontent.com/u/56788623?v=4)](https://github.com/cyrillebekono "cyrillebekono (38 commits)")

### Embed Badge

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

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

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M271](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M454](/packages/google-gax)

PHPackages © 2026

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