PHPackages                             yeboahnanaosei/fayasms - 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. [Mail & Notifications](/categories/mail)
4. /
5. yeboahnanaosei/fayasms

ActiveLibrary[Mail & Notifications](/categories/mail)

yeboahnanaosei/fayasms
======================

FayaSMS provides an easy way to communicate with the FayaSMS API

v1.0.5(6y ago)11512[1 issues](https://github.com/yeboahnanaosei/fayasms/issues)MITPHPPHP ^7.0

Since Jun 24Pushed 5y agoCompare

[ Source](https://github.com/yeboahnanaosei/fayasms)[ Packagist](https://packagist.org/packages/yeboahnanaosei/fayasms)[ Docs](https://github.com/yeboahnanaosei/fayasms)[ RSS](/packages/yeboahnanaosei-fayasms/feed)WikiDiscussions master Synced yesterday

READMEChangelogDependenciesVersions (7)Used By (0)

FayaSMS is a library that provides a simple interface to the [FayaSMS](https://www.fayasms.com "Go to FayaSMS's website")
=========================================================================================================================

[](#fayasms-is-a-library-that-provides-a-simple-interface-to-the-fayasms)

This library allows you to interact with the FayaSMS API seamlessly in your PHP application. The API from [FayaSMS](https://www.fayasms.com "Go to FayaSMS's website") exposes endpoints that allow you to do several things like:

- Sending SMS (single or bulk)
- Checking your balance
- Get an estimate on how much an sms will cost
- Request a sender ID
- Get a list of all your sender IDs
- Retrieve messages (a single message or all your sent messages)

**This library allows you to perform all the above mentioned actions**. Lets take them one by one

> NB: Please note that you need to have a registered app with [FayaSMS](https://www.fayasms.com "Go to FayaSMS's website") in order to use their API. Head over to [their website](https://www.fayasms.com "Go to FayaSMS's website") to create your account and register an app.

- #### Contents

    [](#contents)

    - [Installation](#Installation)
    - [Usage:](#Usage)
        - [Sending single message](#Sending-single-message)
        - [Sending bulk messages](#Sending-bulk-messages)
        - [Getting an estimate](#Getting-an-estimate)
        - [Retrieving all messages](#Retrieving-messages)
        - [Retrieving single message](#Retrieving-single-message)
        - [Checking your balance](#Checking-your-balance)
        - [Retrieving your sender IDs](#Retrieving-your-sender-IDs)
        - [Requesting a new sender ID](#Requesting-a-new-sender-ID)
    - [Contributing](#Contributing)

Installation:
-------------

[](#installation)

Easily installable via composer. Just run this command in your terminal at the root of your project. Visit [Composer](https://www.getcomposer.org "Go to composer's website") to see how to use and install composer on your machine.

```
composer require yeboahnanaosei/fayasms
```

###### [Back to top](#Contents)

[](#back-to-top)

Usage:
------

[](#usage)

### Sending single message:

[](#sending-single-message)

(To send a single message all you need is your appKey, appSecret and senderID. Of course you need a recipient and a message)

```