Download the PHP package vonage/client-core without Composer

Client Library for PHP

This library requires a minimum PHP version of 8.1

This is the PHP client library for use Vonage's API. To use this, you'll need a Vonage account. Sign up for free here.

• Installation
• Usage
• Examples
• Test Suite
• Contributing

Installation

To use the client library you'll need to have created a Vonage account.

To install the PHP client library to your project, we recommend using Composer.

Note that this actually points to a wrapper library that includes an HTTP client -and- this core library. You can install this library directly from Composer if you wish, with the ability to choose the HTTP client your project uses.

You don't need to clone this repository to use this library in your own projects. Use Composer to install it from Packagist.

If you're new to Composer, here are some resources that you may find useful:

• Composer's Getting Started page from Composer project's documentation.
• A Beginner's Guide to Composer from the good people at ScotchBox.

Usage

If you're using Composer, make sure the autoloader is included in your project's bootstrap file:

Create a client with your API key and secret:

For testing purposes you may want to change the URL that vonage/client makes requests to from api.vonage.com to something else. You can do this by providing an array containing base_api_url as the second parameter when creating a Vonage\Client instance.

For APIs that would usually hit rest.nexmo.com, supplying a base_rest_url as an option to the constructor will change those requests.

Examples

Sending a Message via the SMS API

To use Vonage's SMS API to send an SMS message, call the $client->sms()->send() method.

A message object is used to create the SMS messages. Each message type can be constructed with the required parameters, and a fluent interface provides access to optional parameters.

The message object is passed to the send method:

Once sent, the message object can be used to access the response data.

Since each SMS message can be split into multiple messages, the response contains an object for each message that was generated. You can check to see how many messages were generated using the standard count() function in PHP. If you want to get the first message, you can use the current() method on the response.

The send example also has full working examples.

Detecting Encoding Type

You can use a static isGsm7() method within the SMS Client code to determine whether to send the message using GSM-7 encoding or Unicode. Here is an example:

Receiving a Message

Inbound messages are sent to your application as a webhook. The Client library provides a way to create an inbound message object from a webhook:

Signing a Message

You may also like to read the documentation about message signing.

The SMS API supports the ability to sign messages by generating and adding a signature using a "Signature Secret" rather than your API secret. The algorithms supported are:

• md5hash1
• md5
• sha1
• sha256
• sha512

Both your application and Vonage need to agree on which algorithm is used. In the dashboard, visit your account settings page and under "API Settings" you can select the algorithm to use. This is also the location where you will find your "Signature Secret" (it's different from the API secret).

Create a client using these credentials, and the algorithm to use, for example:

Using this client, your SMS API messages will be sent as signed messages.

Verifying an Incoming Message Signature

You may also like to read the documentation about message signing.

If you have message signing enabled for incoming messages, the SMS webhook will include the fields sig, nonce and timestamp. To verify the signature is from Vonage, you create a Signature object using the incoming data, your signature secret and the signature method. Then use the check() method with the actual signature that was received (usually _GET['sig']) to make sure, that it is correct.

Using your signature secret and the other supplied parameters, the signature can be calculated and checked against the incoming signature value.

Sending a Message via. the Messages API

The Messages API is used to send a variety of outbound messages. The following platforms are currently supported:

• SMS
• MMS
• WhatsApp
• Messenger
• Viber

Each one of these platforms has a different category of message you can send (for example, with WhatsApp you can send text, an image, audio, video, a file or a template but for Viber you can only send a text or an image). You can find all the sendable message types under the namespace \Vonage\Messages\Channel. The reason each type is separated out this way is that the platform and message type requires different parameters in the API call.

The \Vonage\Messages\Client is configured in a similar way to the SMS API Client. The difference is that the authentication can be either a JSON Web Token (JWT) or Basic Authentication. You can find more info on how to set up your Client's credentials under the 'Usage' section of this ReadMe.

Here some examples:

Sending a WhatsApp Text

First, we need to create a new WhatsAppText object like so:

The Messages API Client has one method, send() where you can send any of the message types provided. So, to send this message, the following code will do that, assuming you have already set up your Vonage client correctly:

Your response will be a JSON payload if the error range is with 200, or will throw a relevant APIException if it's within 400/500.

Send a Viber Image

Some Channel objects require more arguments in order to be created. You can see the rough mapping of these requirements by comparing the constructor arguments vs. the API Documentation. Some of these messages take custom reusable objects (that are under the \Vonage\Messages\MessageObjects namespace). One of these is an image - so here is an example of how to send a Viber Image:

Verify Examples (v1)

Starting a Verification

Vonage's Verify API makes it easy to prove that a user has provided their own phone number during signup, or implement second factor authentication during sign in.

You can start a verification process using code like this:

Once the user inputs the pin code they received, call the check() method (see below) with the request ID and the PIN to confirm the PIN is correct.

Controlling a Verification

To cancel an in-progress verification, or to trigger the next attempt to send the confirmation code, you can pass either an existing verification object to the client library, or simply use a request ID:

Checking a Verification

In the same way, checking a verification requires the PIN the user provided, and the request ID:

Searching For a Verification

You can check the status of a verification, or access the results of past verifications using a request ID. The verification object will then provide a rich interface:

Payment Verification

Vonage's Verify API has SCA (Secure Customer Authentication) support, required by the PSD2 (Payment Services Directive) and used by applications that need to get confirmation from customers for payments. It includes the payee and the amount in the message.

Start the verification for a payment like this:

Once the user inputs the pin code they received, call the /check endpoint with the request ID and the pin to confirm the pin is correct.

Verify Examples (v2)

Starting a Verification

Vonage's Verify v2 relies more on asynchronous workflows via. webhooks, and more customisable Verification workflows to the developer. To start a verification, you'll need the API client, which is under the namespace verify2.

Making a Verify request needs a 'base' channel of communication to deliver the mode of verification. You can customise these interactions by adding different 'workflows'. For each type of workflow, there is a Verify2 class you can create that will handle the initial workflow for you. For example:

The SMSRequest object will resolve defaults for you, and will create a default workflow object to use SMS. You can, however, add multiple workflows that operate with fall-back logic. For example, if you wanted to create a Verification that tries to get a PIN code off the user via. SMS, but in case there is a problem with SMS delivery you wish to add a Voice fallback: you can add it.

This adds the voice workflow to the original SMS request. The verification request will try and resolve the process in the order that it is given (starting with the default for the type of request).

The base request types are as follows:

• SMSRequest
• WhatsAppRequest
• WhatsAppInterativeRequest
• EmailRequest
• VoiceRequest
• SilentAuthRequest

For adding workflows, you can see the available valid workflows as constants within the VerificationWorkflow object. For a better developer experience, you can't create an invalid workflow due to the validation that happens on the object.

Check a submitted code

To submit a code, you'll need to surround the method in a try/catch due to the nature of the API. If the code is correct, the method will return a true boolean. If it fails, it will throw the relevant Exception from the API that will need to be caught.

Webhooks

As events happen during a verification workflow, events and updates will fired as webhooks. Incoming server requests that conform to PSR-7 standards can be hydrated into a webhook value object for nicer interactions. You can also hydrate them from a raw array. If successful, you will receive a value object back for the type of event/update. Possible webhooks are:

• VerifyEvent
• VerifyStatusUpdate
• VerifySilentAuthUpdate

Cancelling a request in-flight

You can cancel a request should you need to, before the end user has taken any action.

Making a Call

All $client->voice() methods require the client to be constructed with a Vonage\Client\Credentials\Keypair, or a Vonage\Client\Credentials\Container that includes the Keypair credentials:

You can start a call using an OutboundCall object:

If you would like to have the system randomly pick a FROM number from the numbers linked to an application, you can leave off the second parameter to \Vonage\Voice\OutboundCall's constructor, and the system will select a number at random for you.

Using the SimSwap API

SimSwap uses CAMARA standards in order to determine how long a SIM has been inside a cellular device. This means the auth mechanism is slightly more complex than other APIs. You will need:

To have your own Subscriber Number that has been registered with the Vonage Global Network Platform. Your Dashboard Application ID Your Private Key

Usage

There are two available methods for this API: checkSimSwap and checkSimSwapDate.

Here is an example of using both:

Using the Number Verification API

Number Verification uses CAMARA API standards and is used to determine whether a request is valid. Unlike other SDKs, the SDK is split between the start of the process and the end of the process.

You will need:

To have your own Subscriber Number that has been registered with the Vonage Global Network Platform. Your Dashboard Application ID Your Private Key, downloaded from the Vonage Dashboard

Usage

1. Your backend needs to serve a custom URL that will be used to fire off the verification request. To do this, use the buildFrontEndUrl() method on the client. When calling this, you'll need to supply the route your application is expected to receive a callback from containing a unique code. You will need to have an authorised phone number in an authorised territory for this to work. Here is dummy example:

2. Your backend then needs to be able to configured to consume the incoming webhook. The SDK will take care care of handling the Auth methods required to do this, once you have extracted the code. The method returns a boolean from the API. Here is an example:

Using the Conversations API

This API is used for in-app messaging and is contains a wide range of features and concepts. For more information, take a look at the API Documentation

Retrieve a list of Conversations with Filter

Create a Conversation

List Members in a Conversation

Create a Member in a Conversation

`

Building a call with NCCO Actions

Create an Event

Full parameter lists for NCCO Actions can be found in the Voice API Docs.

Each of these examples uses the following structure to add actions to a call:

Record a call

Your webhook url will receive a payload like this:

You can then fetch and store the recording like this:

Send a text to voice call

Stream an audio file on a call

Collect user input from a call

Supports keypad entry as well as voice. NB. the input action must follow an action with bargeIn set to true

The webhook URL will receive a payload containing the input from the user with relative confidence ratings for speech input.

Send a notification to a webhook url

The webhook URL will receive a payload as specified in the request.

Fetching a Call

You can fetch a call using a Vonage\Call\Call object, or the call's UUID as a string:

You can also search for calls using a Filter.

Creating an Application

Application are configuration containers. You can create one using an array structure:

You can also pass the client an application object:

Fetching Applications

You can iterate over all your applications:

Or you can fetch an application using a string UUID, or an application object.

Updating an Application

Once you have an application object, you can modify and save it.

List Your Numbers

You can list the numbers owned by your account and optionally include filtering:

search_pattern:

• 0 - the number begins with pattern
• 1 - the number includes pattern
• 2 - the number ends with pattern

has_application:

• true - The number is attached to an application
• false - The number is not attached to an application

application_id:

• Supply an application ID to get all the numbers associated with the requesting application

Search Available Numbers

You can search for numbers available to purchase in a specific country:

By default, this will only return the first 10 results. You can add an additional \Vonage\Numbers\Filter\AvailableNumbers filter to narrow down your search.

Purchase a Number

To purchase a number, you can pass in a value returned from number search:

Or you can specify the number and country manually:

Update a Number

To update a number, use numbers()->update and pass in the configuration options you want to change. To clear a setting, pass in an empty value.

Cancel a Number

To cancel a number, provide the msisdn:

Managing Secrets

An API is provided to allow you to rotate your API secrets. You can create a new secret (up to a maximum of two secrets) and delete the existing one once all applications have been updated.

To get a list of the secrets:

You can create a new secret (the created dates will help you know which is which):

And delete the old secret (any application still using these credentials will stop working):

Pricing

Prefix Pricing

If you know the prefix of a country you want to call, you can use the prefix-pricing endpoint to find out costs to call that number. Each prefix can return multiple countries (e.g. 1 returns US, CA and UM):

Check your Balance

Check how much credit remains on your account:

View and Change Account Configuration

Inspect the current settings on the account:

Update the default callback URLs for incoming SMS messages and delivery receipts:

Use SimSwap to Check the Status and Date of a SIM in a handset

In order to use Vonage's Network APIs you'll need to be enabled within the Vonage Network Registry

Once you have a registered MSNDIN, you will be able to use SimSwap.

SimSwap uses the Global Network Platform authentication mechanism, so the authorisation flow looks a little different from other API Clients. Under the hood, the SDK will handle multiple calls for you to configure a CAMARA standard access token.

Here's an example of checking if a SIM has been recently been swapped:

And here is how you retrieve the swap date:

Get Information About a Number

The Number Insights API allows a user to check that a number is valid and to find out more about how to use it.

Basic and Standard Usage

You can use either the basic() or standard() methods (an advanced() method is available, but it is recommended to use the async option to get advanced info), like this:

The data is returned in the $insights variable in the example above.

Advanced Usage

To get advanced insights, use the async feature and supply a URL for the webhook to be sent to:

Check out the documentation for what to expect in the incoming webhook containing the data you requested.

Subaccount Examples

This API is used to create and configure subaccounts related to your primary account and transfer credit, balances and bought numbers between accounts. The subaccounts API is disabled by default. If you want to use subaccounts, contact support to have the API enabled on your account.

Get a list of Subaccounts

Create a Subaccount

Get a Subaccount

Update a Subaccount

Get a list of Credit Transfers

Transfer Credit between accounts

Get a list of Balance Transfers

Transfer Balance between accounts

Transfer a Phone Number between accounts

Supported APIs

Troubleshooting

Checking for Deprecated Features

Over time, the Vonage APIs evolve and add new features, change how existing features work, and deprecate and remove older methods and features. To help developers know when deprecation changes are being made, the SDK will trigger an E_USER_DEPRECATION warning. These warnings will not stop the execution of code, but can be an annoyance in production environments.

To help with this, by default these notices are suppressed. In development, you can enable these warnings by passing an additional configuration option to the \Vonage\Client constructor, called show_deprecations. Enabling this option will show all deprecation notices.

If you notice an excessive amount of deprecation notices in production environments, make sure the configuration option is absent, or at least set to false.

unable to get local issuer certificate

Some users have issues making requests due to the following error:

This is due to some PHP installations not shipping with a list of trusted CA certificates. This is a system configuration problem, and not specific to either cURL or Vonage.

IMPORTANT: In the next paragraph we provide a link to a CA certificate bundle. Vonage do not guarantee the safety of this bundle, and you should review it yourself before installing any CA bundle on your machine.

To resolve this issue, download a list of trusted CA certificates (e.g. the curl bundle) and copy it on to your machine. Once this is done, edit php.ini and set the curl.cainfo parameter:

Pass custom HTTP client

We allow use of any HTTPlug adapter or PSR-18 compatible HTTP client, so you can create a client with alternative configuration if you need it, for example to take account of a local proxy, or deal with something else specific to your setup.

Here's an example that reduces the default timeout to 5 seconds to avoid long delays if you have no route to our servers:

Accessing Response Data

When things go wrong, you'll receive an Exception. The Vonage exception classes Vonage\Client\Exception\Request and Vonage\Client\Exception\Server support an additional getEntity() method which you can use in addition to getCode() and getMessage() to find out more about what went wrong. The entity returned will typically be an object related to the operation, or the response object from the API call.

Composer installation fails due to Guzzle Adapter

If you have a conflicting package installation that cannot co-exist with our recommended guzzlehttp/guzzle package, then you may install the package vonage/client-core along with any package satisfying the php-http/client-implementation requirement.

See the Packagist page for client-implementation for options.

Enabling Request/Response Logging

Our client library has support for logging the request and response for debugging via PSR-3 compatible logging mechanisms. If the debug option is passed into the client and a PSR-3 compatible logger is set in our client's service factory, we will use the logger for debugging purposes.

ENABLING DEBUGGING LOGGING HAS THE POTENTIAL FOR LOGGING SENSITIVE INFORMATION, DO NOT ENABLE IN PRODUCTION

Test Suite

This library has a full test suite designed to be run with PHPUnit.

To run, use composer:

Please note: this test suite is large, and may require a considerable amount of memory to run. If you encounter the "too many files open" error in MacOS or Linux, there is a hack to increase the amount of file pointers permitted. Increase the amount of files that can be open by entering the following on the command line (10240 is the maximum amount of pointers MacOS will open currently):

Contributing

This library is actively developed, and we love to hear from you! Please feel free to create an issue or open a pull request with your questions, comments, suggestions and feedback.