PHPackages                             taylornetwork/laravel-nexmo - 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. taylornetwork/laravel-nexmo

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

taylornetwork/laravel-nexmo
===========================

032PHPCI failing

Since Apr 15Pushed 4y ago1 watchersCompare

[ Source](https://github.com/taylornetwork/laravel-nexmo)[ Packagist](https://packagist.org/packages/taylornetwork/laravel-nexmo)[ RSS](/packages/taylornetwork-laravel-nexmo/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (2)Used By (0)

Laravel Nexmo
=============

[](#laravel-nexmo)

*Currently a work in progress so nothing is even close to guaranteed to work and will periodically fail*

Package Status and Goals
------------------------

[](#package-status-and-goals)

- Build NCCOs
- Implement a very simple IVR builder
- Handle answering voice calls
- Route calls to correct IVR menu
- Handle incoming SMS
- Handle outgoing SMS
- Very simple real time SMS chat (being partially redone)
- Handle input from IVR steps properly

Install
-------

[](#install)

Using composer

```
$ composer require taylornetwork/laravel-nexmo
```

### Migrate Tables

[](#migrate-tables)

```
$ php artisan migrate
```

### Publish Assets

[](#publish-assets)

```
$ php artisan vendor:publish --provider="TaylorNetwork\\LaravelNexmo\\NexmoServiceProvider"
```

Will publish config, migrations and js (vue) components.

```
config/
    + ncco.php
database/
    migrations/
        + 2020_04_03_000000_create_calls_table.php
        + 2020_04_03_000001_create_ivrs_table.php
        + 2020_04_03_000002_create_ivr_steps_table.php
        + 2020_04_07_000003_create_sms_table.php
resources/
    vendor/
        taylornetwork/
            laravel-nexmo/
                components/
                    Ivr/
		        + IvrBuilder.vue
			+ IvrMenu.vue
			+ IvrApp.vue
		    Sms/ (not up to date)
		        + Messenger.vue
			+ ComposeSms.vue
                + laravel-nexmo.js

```

If you're going to be using the included vue components, see [Vue Components](#vue-components).

### Add your Vonage (Nexmo) information

[](#add-your-vonage-nexmo-information)

In your `.env` add the following lines

```
NEXMO_KEY=(Your API Key)
NEXMO_SECRET=(Your API Secret)
NEXMO_NUMBER=(Your Number)

```

### Setup your Vonage (Nexmo) Application

[](#setup-your-vonage-nexmo-application)

You will need to login to your linked application and set your webhooks.

Run `php artisan route:list` should add the following routes:

```
+---------------------------------+--------------------------------------------------------------------------------+
| URI                             | Action                                                                         |
+---------------------------------+--------------------------------------------------------------------------------+
| api/nexmo/call/answer           | TaylorNetwork\LaravelNexmo\Controllers\API\CallController@answer               |
| api/nexmo/call/ivr/{ivr}/answer | TaylorNetwork\LaravelNexmo\Controllers\API\CallController@answerWithIvr        |
| api/nexmo/event/update          | TaylorNetwork\LaravelNexmo\Controllers\API\EventController@handleEventUpdate   |
| api/nexmo/sms/inbound           | TaylorNetwork\LaravelNexmo\Controllers\API\SmsController@handleInboundMessage  |
| api/nexmo/sms/outbound          | TaylorNetwork\LaravelNexmo\Controllers\API\SmsController@handleOutboundMessage |
| api/nexmo/sms/{sms}/send        | TaylorNetwork\LaravelNexmo\Controllers\API\SmsController@send                  |

```

Assign your webhooks to the corressponding URLs.

### Prepare for Incoming Calls

[](#prepare-for-incoming-calls)

You'll need to either (A) create a new IVR menu or (B) override the `answer` method.

#### Create a new IVR menu

[](#create-a-new-ivr-menu)

Currently no easy way to do this other than adding the entries manually.

#### Override answer method

[](#override-answer-method)

By default the package will look for `App\Http\Controllers\Api\CallController`

This is customizable by publishing config.

```
namespace App\Http\Controllers\Api;

use Illuminate\Routing\Controller;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;

class CallController extends Controller
{
	public function answer(Request $request): JsonResponse
	{
		// Must respond with a JSON response.
	}
}
```

Usage
-----

[](#usage)

### NccoBuilder Class

[](#nccobuilder-class)

Can be called using the `NccoBuilder` facade or by creating a new instance.

#### Action Methods

[](#action-methods)

All the NCCO actions are their own method. [See NCCO Reference](https://developer.nexmo.com/voice/voice-api/ncco-reference)Each action method will have a required parameter that will match the required parameter in the NCCO reference. All other options can be added in the second optional array parameter.

Action methods always return the `NccoBuilder` instance, so you can chain any additional methods.

For example:

```
// Default talk action
$builder->talk('Hello!');

// Talk with different voice
$builder->talk('Hi there!', [ 'voiceName' => 'Joey' ]);

// Connect to another phone
$builder->connect([ 'type' => 'phone', 'number' => '19998887777' ]);

// Start recording
$builder->record();
```

#### Additonal Methods

[](#additonal-methods)

**addAction(string $action, array $options = \[\])**

Will add the action provided with the given options.

All the action methods call this method.

```
$builder->addAction('talk', [ 'text' => 'Hello!' ]);
```

**append(array $data)**

Appends to the end of the NCCO stack.

**prepend(array $data)**

Prepends to the beginning of the NCCO stack.

**getNcco()** and **ncco()**

Returns the NCCO array.

**getJsonNcco()** and **json()**

Returns the NCCO as JSON.

**buildResponse(int $httpStatus = 200)**

Builds and returns an `Illuminate\Http\JsonResponse` with the NCCO and provided HTTP status code.

**respond(int $httpStatus = 200)**

Returns the built response from `buildResponse()`

### Call Model

[](#call-model)

The `TaylorNetwork\LaravelNexmo\Models\Call` model handles the incoming calls and their statuses and prices.

### Ivr Model

[](#ivr-model)

The `TaylorNetwork\LaravelNexmo\Models\Ivr` model handles what the caller hears and what happens when they call in.

Each `Ivr` model has many `IvrSteps` which handle everything.

You can build the IVR menu by using the `build()` or `respond()` method.

**build()**

Will build the entire NCCO for the menu and return the NCCO as an array.

**respond()**

Will convert the built menu from the `build()` method and convert it to an `Illuminate\Http\JsonResponse`

In your controller you can do something like:

```
public function incomingIvr(Ivr $ivr, Request $request)
{
	return $ivr->respond();
}
```

### IvrStep Model

[](#ivrstep-model)

The `TaylorNetwork\LaravelNexmo\Models\IvrStep` model has the action, options and order of it in the corresponding IVR menu.

### Sms Model

[](#sms-model)

The `TaylorNetwork\LaravelNexmo\Models\Sms` model handles all incoming and outgoing SMS messages, including actually sending the messages.

**send()**

Calling this method will send the message if it's hasn't been sent yet, as long as it's an outgoing message.

### Vue Components

[](#vue-components)

#### Setup

[](#setup)

If you're going to be using the included Vue components you'll need to make sure you have all the required dependencies.

```
$ npm install --save vue vue-template-compiler axios pusher-js v-jsoneditor
```

Or import into your `package.json`

```
{
 "dependencies": {
    "vue": "^2.6.11",
    "vue-template-compiler": "^2.6.11",
    "axios": "^0.19.2",
    "pusher-js": "^5.1.1",
    "v-jsoneditor": "^1.2.3"
  }
}
```

Set your Pusher app key in `laravel-nexmo.js`

```
// laravel-nexmo.js

window.pusherInstance = new Pusher('your-pusher-app-key', {
    cluster: 'us2',
    forceTLS: true,
    encrypted: true,
});
```

Require `laravel-nexmo.js` in your `app.js` file **after** `window.Vue = require('vue');` and **before** creating a new Vue instance.

```
// app.js

window.Vue = require('vue');

// This assumes your app.js file is at resources/js
require('../vendor/taylornetwork/laravel-nexmo/laravel-nexmo');

const app = new Vue({
    el: '#app',
});
```

#### IvrApp

[](#ivrapp)

The `IvrApp` component will allow you to create and edit IVR menus and steps

```

```

Where `$ivr` is an instance of `TaylorNetwork\LaravelNexmo\Models\Ivr`

#### ComposeSms

[](#composesms)

The `ComposeSms` component is an easy starting point to send an SMS to a number using the nexmo number you've previously set up.

```

```

#### Messenger

[](#messenger)

The `Messenger` component is a very basic chat app using Pusher.

```

```

License
-------

[](#license)

MIT

###  Health Score

19

—

LowBetter than 10% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity7

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity36

Early-stage or recently created project

 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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/83340094473f0bf5b2cf062bf394df221a52a30aa0e21cd0a77302977d6393ce?d=identicon)[samueljtaylor](/maintainers/samueljtaylor)

---

Top Contributors

[![samyrataylor](https://avatars.githubusercontent.com/u/15961687?v=4)](https://github.com/samyrataylor "samyrataylor (31 commits)")

---

Tags

ivrlaravelmessengerncconexmopackagepushersmsvonage

### Embed Badge

![Health badge](/badges/taylornetwork-laravel-nexmo/health.svg)

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

###  Alternatives

[tijsverkoyen/css-to-inline-styles

CssToInlineStyles is a class that enables you to convert HTML-pages/files into HTML-pages/files with inline styles. This is very useful when you're sending emails.

5.8k505.3M227](/packages/tijsverkoyen-css-to-inline-styles)[minishlink/web-push

Web Push library for PHP

1.9k12.0M53](/packages/minishlink-web-push)[laravel-notification-channels/twilio

Provides Twilio notification channel for Laravel

2587.7M12](/packages/laravel-notification-channels-twilio)[spatie/url-signer

Generate a url with an expiration date and signature to prevent unauthorized access

4422.3M16](/packages/spatie-url-signer)[mattketmo/email-checker

Throwaway email detection library

2742.0M5](/packages/mattketmo-email-checker)[laravel-notification-channels/discord

Laravel notification driver for Discord.

2371.3M11](/packages/laravel-notification-channels-discord)

PHPackages © 2026

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