vonage php sdk core
4.10.7
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.
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.
composer require vonage/clientNote 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:
If you're using Composer, make sure the autoloader is included in your project's bootstrap file:
require_once "vendor/autoload.php";Create a client with your API key and secret:
$client = new VonageClient(new VonageClientCredentialsBasic(API_KEY, API_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 VonageClient instance.
$client = new VonageClient(
new VonageClientCredentialsBasic(API_KEY, API_SECRET),
[
'base_api_url' => 'https://example.com'
]
);For APIs that would usually hit rest.nexmo.com, supplying a base_rest_url as an option to the constructor will change those requests.
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.
$text = new VonageSMSMessageSMS(VONAGE_TO, VONAGE_FROM, 'Test message using PHP client library');
$text->setClientRef('test-message');The message object is passed to the send method:
$response = $client->sms()->send($text);Once sent, the message object can be used to access the response data.
$data = $response->current();
echo "Sent message to " . $data->getTo() . ". Balance is now " . $data->getRemainingBalance() . PHP_EOL;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.
$data = $response->current();
$data->getRemainingBalance();
foreach($response as $index => $data){
$data->getRemainingBalance();
}The send example also has full working examples.
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:
$sms = new VonageSMSMessageSMS('123', '456', 'is this gsm7?');
if (VonageSMSMessageSMS::isGsm7($text)) {
$sms->setType('text');
} else {
$sms->setType('unicode');
}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:
try {
$inbound = VonageSMSWebhookFactory::createFromGlobals();
error_log($inbound->getText());
} catch (InvalidArgumentException $e) {
error_log('invalid 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:
md5hash1md5sha1sha256sha512Both 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:
$client = new VonageClient(new VonageClientCredentialsSignatureSecret(API_KEY, SIGNATURE_SECRET, 'sha256'));Using this client, your SMS API messages will be sent as signed messages.
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.
$signature = new VonageClientSignature($_GET, SIGNATURE_SECRET, 'sha256');
// is it valid? Will be true or false
$isValid = $signature->check($_GET['sig']);Using your signature secret and the other supplied parameters, the signature can be calculated and checked against the incoming signature value.
The Messages API is used to send a variety of outbound messages. The following platforms are currently supported:
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 VonageMessagesChannel. The reason each type is separated
out this way is that the platform and message type requires different parameters in the API call.
The VonageMessagesClient 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:
First, we need to create a new WhatsAppText object like so:
$whatsAppText = new VonageMessagesChannelWhatsAppWhatsAppText(
FROM_NUMBER,
TO_NUMBER,
'this is a WA text from vonage'
);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:
$client->messages()->send($whatsAppText);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.
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 VonageMessagesMessageObjects namespace). One of these is an image - so
here is an example of how to send a Viber Image:
$imageObject = VonageMessagesMessageObjectsImageObject(
'https://picsum.photos/200/300',
'image caption'
);
$viberImage = new VonageMessagesChannelViberViberImage(
FROM_NUMBER,
TO_NUMBER,
$imageObject
);
$client->messages()->send($viberImage);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:
$request = new VonageVerifyRequest('14845551212', 'My App');
$response = $client->verify()->start($request);
echo "Started verification with an id of: " . $response->getRequestId();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.
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:
$client->verify()->trigger('00e6c3377e5348cdaf567e1417c707a5');
$client->verify()->cancel('00e6c3377e5348cdaf567e1417c707a5');In the same way, checking a verification requires the PIN the user provided, and the request ID:
try {
$client->verify()->check('00e6c3377e5348cdaf567e1417c707a5', '1234');
echo "Verification was successful (status: " . $verification->getStatus() . ")n";
} catch (Exception $e) {
echo "Verification failed with status " . $e->getCode()
. " and error text "" . $e->getMessage() . ""n";
}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:
$client->verify()->search('00e6c3377e5348cdaf567e1417c707a5');
echo "Codes checked for verification: " . $verification->getRequestId() . PHP_EOL;
foreach($verification->getChecks() as $check){
echo $check->getDate()->format('d-m-y') . ' ' . $check->getStatus() . PHP_EOL;
}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:
$request = new VonageVerifyRequestPSD2('14845551212', 'My App');
$response = $client->verify()->requestPSD2($request);
echo "Started verification with an id of: " . $response['request_id'];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.
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:
$client = new VonageClient(
new VonageClientCredentialsBasic(API_KEY, API_SECRET),
);
$smsRequest = new VonageVerify2RequestSMSRequest('TO_NUMBER');
$client->verify2()->startVerification($smsRequest);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.
$client = new VonageClient(
new VonageClientCredentialsBasic(API_KEY, API_SECRET),
);
$smsRequest = new VonageVerify2RequestSMSRequest('TO_NUMBER', 'my-verification');
$voiceWorkflow = new VonageVerify2VerifyObjectsVerificationWorkflow(VonageVerify2VerifyObjectsVerificationWorkflow::WORKFLOW_VOICE, 'TO_NUMBER');
$smsRequest->addWorkflow($voiceWorkflow);
$client->verify2()->startVerification($smsRequest);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:
SMSRequestWhatsAppRequestWhatsAppInterativeRequestEmailRequestVoiceRequestSilentAuthRequestFor 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.
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.
$code = '1234';
try {
$client->verify2()->check($code);
} catch (Exception $e) {
var_dump($e->getMessage())
}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:
VerifyEventVerifyStatusUpdateVerifySilentAuthUpdate// From a request object
$verificationEvent = VonageVerify2WebhookFactory::createFromRequest($request);
var_dump($verificationEvent->getStatus());
// From an array
$payload = $request->getBody()->getContents()
$verificationEvent = VonageVerify2WebhookFactory::createFromArray($payload);
var_dump($verificationEvent->getStatus());You can cancel a request should you need to, before the end user has taken any action.
$requestId = 'c11236f4-00bf-4b89-84ba-88b25df97315';
$client->verify2()->cancel($requestId);All $client->voice() methods require the client to be constructed with a VonageClientCredentialsKeypair, or a
VonageClientCredentialsContainer that includes the Keypair credentials:
$basic = new VonageClientCredentialsBasic(VONAGE_API_KEY, VONAGE_API_SECRET);
$keypair = new VonageClientCredentialsKeypair(
file_get_contents(VONAGE_APPLICATION_PRIVATE_KEY_PATH),
VONAGE_APPLICATION_ID
);
$client = new VonageClient(new VonageClientCredentialsContainer($basic, $keypair));You can start a call using an OutboundCall object:
$outboundCall = new VonageVoiceOutboundCall(
new VonageVoiceEndpointPhone('14843331234'),
new VonageVoiceEndpointPhone('14843335555')
);
$outboundCall
->setAnswerWebhook(
new VonageVoiceWebhook('https://example.com/webhooks/answer')
)
->setEventWebhook(
new VonageVoiceWebhook('https://example.com/webhooks/event')
)
;
$response = $client->voice()->createOutboundCall($outboundCall);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 VonageVoiceOutboundCall's constructor, and the system will select a number
at random for you.
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
There are two available methods for this API: checkSimSwap and checkSimSwapDate.
Here is an example of using both:
$credentials = new VonageClientCredentialsGnp(
'0777888888',
file_get_contents('./private.key'),
'0dadaeb4-7c79-4d39-b4b0-5a6cc08bf537'
);
$client = new VonageClient($credentials);
$swapResult = $client->simswap()->checkSimSwap('07999999999', 500);
if ($swapResult) {
echo "Warning: SIM Swapped recently"
} else {
echo "SIM OK"
};
// Finding the swap date
echo $client->simswap()->checkSimSwapDate('07999999999');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
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:class VerificationController extends MyFrameworkAbsractController
{
$credentials = new VonageClientCredentialsGnp(
'077380777111',
file_get_contents('../private.key'),
'0dadaeb4-7c79-4d39-b4b0-5a6cc08bf537'
)
$client = new VonageClient($credentials);
$verifyUrl = $client->numberVerification()->buildFrontEndUrl(
'07777777777',
'https://myapp.com/auth/numberVerify'
);
return $this->render('verify.html.twig', [
'verifyLink' => $verifyUrl
]);
}code.
The method returns a boolean from the API. Here is an example:$code = $request->get('code');
$result = $client->numberVerification()->verifyNumber(
'09947777777',
$code
);
if ($result) {
Auth::login($request->user())
}
return redirect('login');
}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
$credentials = new VonageClientCredentialsKeypair(file_get_contents('./path-to-my-key.key', 'my-app-id'));
$client = new VonageClient($credentials);
$filter = new VonageConversationFilterListConversationFilter();
$filter->setStartDate('2018-01-01 10:00:00');
$filter->setEndDate('2019-01-01 10:00:00')
$conversations = $client->conversations()->listConversations($filter)
var_dump($conversations);$credentials = new VonageClientCredentialsKeypair(file_get_contents('./path-to-my-key.key', 'my-app-id'));
$client = new VonageClient($credentials);
$conversation = new CreateConversationRequest('customer_chat', 'Customer Chat', 'https://example.com/image.png');
$conversation->setTtl(60);
$conversationNumber = new ConversationNumber('447700900000');
$conversationCallback = new ConversationCallback('https://example.com/eventcallback');
$conversationCallback->setEventMask('member:invited, member:joined');
$conversationCallback->setApplicationId('afa393df-2c46-475b-b2d6-92da4ea05481');
$conversationCallback->setNccoUrl('https://example.com/ncco');
$conversation->setNumber($conversationNumber);
$conversation->setConversationCallback($conversationCallback);
$response = $this->conversationsClient->createConversation($conversation);
var_dump($response);$credentials = new VonageClientCredentialsKeypair(file_get_contents('./path-to-my-key.key', 'my-app-id'));
$client = new VonageClient($credentials);
$filter = new ListUserConversationsFilter();
$filter->setState('INVITED');
$filter->setIncludeCustomData(true);
$filter->setOrderBy('created');
$filter->setStartDate('2018-01-01 10:00:00');
$filter->setEndDate('2018-01-01 12:00:00');
$filter->setPageSize(5);
$filter->setOrder('asc');
$response = $this->conversationsClient->listUserConversationsByUserId('CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a');
foreach ($response as $member) {
$members[] = $member;
}
var_dump($members);$channel = Channel::createChannel(Channel::CHANNEL_TYPE_APP);
$channel->addUserFromTypes([
'sms',
'phone'
]);
$channel->addUserToField('USR-82e028d9-9999-4f1e-8188-604b2d3471ec');
$createMemberRequest = new CreateMemberRequest(
'invited',
$channel,
'USR-82e028d9-5201-4f1e-8188-604b2d3471ec',
'my_user_name',
);
$createMemberRequest->setAudioPossible(true);
$createMemberRequest->setAudioEnabled(true);
$createMemberRequest->setAudioEarmuffed(false);
$createMemberRequest->setAudioMuted(false);
$createMemberRequest->setKnockingId('4f1e-8188');
$createMemberRequest->setMemberIdInviting('MEM-63f61863-4a51-4f6b-86e1-46edebio0391');
$createMemberRequest->setFrom('value');
$response = $this->conversationsClient->createMember(
$createMemberRequest,
'CON-63f61863-4a51-4f6b-86e1-46edebio0391'
);
var_dump($response);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:
$outboundCall = new VonageVoiceOutboundCall(
new VonageVoiceEndpointPhone('14843331234'),
new VonageVoiceEndpointPhone('14843335555')
);
$ncco = new NCCO();
// ADD ACTIONS TO THE NCCO OBJECT HERE
$outboundCall->setNCCO($ncco);
$response = $client->voice()->createOutboundCall($outboundCall);$outboundCall = new VonageVoiceOutboundCall(
new VonageVoiceEndpointPhone('14843331234'),
new VonageVoiceEndpointPhone('14843335555')
);
$ncco = new NCCO();
$ncco->addAction(VonageVoiceNCCOActionRecord::factory([
'eventUrl' => 'https://example.com/webhooks/event'
]);
$outboundCall->setNCCO($ncco);
$response = $client->voice()->createOutboundCall($outboundCall);Your webhook url will receive a payload like this:
{
"start_time": "2020-10-29T14:30:24Z",
"recording_url": "https://api.nexmo.com/v1/files/<recording-id>",
"size": 27918,
"recording_uuid": "<recording-id>",
"end_time": "2020-10-29T14:30:31Z",
"conversation_uuid": "<conversation-id>",
"timestamp": "2020-10-29T14:30:31.619Z"
}
You can then fetch and store the recording like this:
$recordingId = '<recording-id>';
$recordingUrl = 'https://api.nexmo.com/v1/files/' . $recordingId;
$data = $client->get($recordingUrl);
file_put_contents($recordingId.'.mp3', $data->getBody());
$outboundCall = new VonageVoiceOutboundCall(
new VonageVoiceEndpointPhone('14843331234'),
new VonageVoiceEndpointPhone('14843335555')
);
$ncco = new NCCO();
$ncco->addAction(new VonageVoiceNCCOActionTalk('This is a text to speech call from Vonage'));
$outboundCall->setNCCO($ncco);
$response = $client->voice()->createOutboundCall($outboundCall);$outboundCall = new VonageVoiceOutboundCall(
new VonageVoiceEndpointPhone('14843331234'),
new VonageVoiceEndpointPhone('14843335555')
);
$ncco = new NCCO();
$ncco->addAction(new VonageVoiceNCCOActionStream('https://example.com/sounds/my-audio.mp3'));
$outboundCall->setNCCO($ncco);
$response = $client->voice()->createOutboundCall($outboundCall);Supports keypad entry as well as voice. NB. the input action must follow an action with bargeIn set to true
$outboundCall = new VonageVoiceOutboundCall(
new VonageVoiceEndpointPhone('14843331234'),
new VonageVoiceEndpointPhone('14843335555')
);
$ncco = new NCCO();
$ncco->addAction(VonageVoiceNCCOActionTalk::factory('Please record your name.',[
'bargeIn' => true,
]));
$ncco->addAction(VonageVoiceNCCOActionInput::factory([
'eventUrl' => 'https://example.com/webhooks/event',
'type' => [
'speech',
],
'speech' => [
'endOnSilence' => true,
],
]));
$outboundCall->setNCCO($ncco);
$response = $client->voice()->createOutboundCall($outboundCall);The webhook URL will receive a payload containing the input from the user with relative confidence ratings for speech input.
$outboundCall = new VonageVoiceOutboundCall(
new VonageVoiceEndpointPhone('14843331234'),
new VonageVoiceEndpointPhone('14843335555')
);
$ncco = new NCCO();
$ncco->addAction(new VonageVoiceNCCOActionTalk('We are just testing the notify function, you do not need to do anything.'));
$ncco->addAction(new VonageVoiceNCCOActionNotify([
'foo' => 'bar',
], new VonageVoiceWebhook('https://example.com/webhooks/notify')));
$outboundCall->setNCCO($ncco);
$response = $client->voice()->createOutboundCall($outboundCall);The webhook URL will receive a payload as specified in the request.
You can fetch a call using a VonageCallCall object, or the call's UUID as a string:
$call = $client->voice()->get('3fd4d839-493e-4485-b2a5-ace527aacff3');
echo $call->getDirection();You can also search for calls using a Filter.
$filter = new VonageVoiceFilterVoiceFilter();
$filter->setStatus('completed');
foreach($client->search($filter) as $call){
echo $call->getDirection();
}Application are configuration containers. You can create one using an array structure:
$application = new VonageApplicationApplication();
$application->fromArray([
'name' => 'test application',
'keys' => [
'public_key' => '-----BEGIN PUBLIC KEY-----nMIIBIjANBgkqhkiG9w0BAQEFAAOCAnKOxjsU4pf/sMFi9N0jqcSLcjxu33Gnd/vynKnlw9SENi+UZR44GdjGdmfm1ntL1eA7IBh2HNnkYXnAwYzKJoa4eO3n0kYWekeIZawIwe/g9faFgkev+1xsOnOUNhPx2LhuLmgwWSRS4L5W851Xe3fnUQIDAQABn-----END PUBLIC KEY-----n'
],
'capabilities' => [
'voice' => [
'webhooks' => [
'answer_url' => [
'address' => 'https://example.com/webhooks/answer',
'http_method' => 'GET',
],
'event_url' => [
'address' => 'https://example.com/webhooks/event',
'http_method' => 'POST',
],
]
],
'messages' => [
'webhooks' => [
'inbound_url' => [
'address' => 'https://example.com/webhooks/inbound',
'http_method' => 'POST'
],
'status_url' => [
'address' => 'https://example.com/webhooks/status',
'http_method' => 'POST'
]
]
],
'rtc' => [
'webhooks' => [
'event_url' => [
'address' => 'https://example.com/webhooks/event',
'http_method' => 'POST',
],
]
],
'vbc' => []
]
]);
$client->applications()->create($application);You can also pass the client an application object:
$a = new VonageApplicationApplication();
$a->setName('PHP Client Example');
$a->getVoiceConfig()->setWebhook('answer_url', 'https://example.com/webhooks/answer', 'GET');
$a->getVoiceConfig()->setWebhook('event_url', 'https://example.com/webhooks/event', 'POST');
$a->getMessagesConfig()->setWebhook('status_url', 'https://example.com/webhooks/status', 'POST');
$a->getMessagesConfig()->setWebhook('inbound_url', 'https://example.com/webhooks/inbound', 'POST');
$a->getRtcConfig()->setWebhook('event_url', 'https://example.com/webhooks/event', 'POST');
$a->disableVbc();
$client->applications()->create($a);You can iterate over all your applications:
foreach($client->applications()->getAll() as $application){
echo $application->getName() . PHP_EOL;
}Or you can fetch an application using a string UUID, or an application object.
$application = $client->applications()->get('1a20a124-1775-412b-b623-e6985f4aace0');Once you have an application object, you can modify and save it.
$application = $client->applications()->get('1a20a124-1775-412b-b623-e6985f4aace0');
$application->setName('Updated Application');
$client->applications()->update($application);You can list the numbers owned by your account and optionally include filtering:
search_pattern:
0 - the number begins with pattern1 - the number includes pattern2 - the number ends with pattern$filter = new VonageNumbersFilterOwnedNumbers();
$filter
->setPattern(234)
->setSearchPattern(VonageNumbersFilterOwnedNumbers::SEARCH_PATTERN_CONTAINS)
;
$response = $client->numbers()->searchOwned(null, $filter);has_application:
true - The number is attached to an applicationfalse - The number is not attached to an application$filter = new VonageNumbersFilterOwnedNumbers();
$filter->setHasApplication(true);
$response = $client->numbers()->searchOwned($filter);application_id:
$filter = new VonageNumbersFilterOwnedNumbers();
$filter->setApplicationId("66c04cea-68b2-45e4-9061-3fd847d627b8");
$response = $client->numbers()->searchOwned($filter);You can search for numbers available to purchase in a specific country:
$numbers = $client->numbers()->searchAvailable('US');By default, this will only return the first 10 results. You can add an additional VonageNumbersFilterAvailableNumbers
filter to narrow down your search.
To purchase a number, you can pass in a value returned from number search:
$numbers = $client->numbers()->searchAvailable('US');
$number = $numbers->current();
$client->numbers()->purchase($number->getMsisdn(), $number->getCountry());Or you can specify the number and country manually:
$client->numbers()->purchase('14155550100', 'US');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.
$number = $client->numbers()->get(VONAGE_NUMBER);
$number
->setAppId('1a20a124-1775-412b-b623-e6985f4aace0')
->setVoiceDestination('447700900002', 'tel')
->setWebhook(
VonageNumberNumber::WEBHOOK_VOICE_STATUS,
'https://example.com/webhooks/status'
)
->setWebhook(
VonageNumberNumber::WEBHOOK_MESSAGE,
'https://example.com/webhooks/inbound-sms'
)
;
$client->numbers()->update($number);
echo "Number updated" . PHP_EOL;To cancel a number, provide the msisdn:
$client->numbers()->cancel('447700900002');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:
$secretsCollection = $client->account()->listSecrets(API_KEY);
/** @var VonageAccountSecret $secret */
foreach($secretsCollection->getSecrets() as $secret) {
echo "ID: " . $secret->getId() . " (created " . $secret->getCreatedAt() .")n";
}You can create a new secret (the created dates will help you know which is which):
$client->account()->createSecret(API_KEY, 'awes0meNewSekret!!;');And delete the old secret (any application still using these credentials will stop working):
try {
$response = $client->account()->deleteSecret(API_KEY, 'd0f40c7e-91f2-4fe0-8bc6-8942587b622c');
} catch(VonageClientExceptionRequest $e) {
echo $e->getMessage();
}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):
$results = $client->account()->getPrefixPricing('1');
foreach ($results as $price) {
echo $price->getCountryCode().PHP_EOL;
echo $price->getCountryName().PHP_EOL;
foreach ($price->getNetworks() as $network) {
echo $network->getName() .' :: '.$network->getCode().' :: '.$network->getPrefixPrice().PHP_EOL;
}
echo "----------------".PHP_EOL;
}Check how much credit remains on your account:
$response = $client->account()->getBalance();
echo round($response->getBalance(), 2) . " EURn";Inspect the current settings on the account:
$response = $client->account()->getConfig();
print_r($response->toArray());Update the default callback URLs for incoming SMS messages and delivery receipts:
$response = $client->account()->updateConfig([
"sms_callback_url" => "http://example.com/webhooks/incoming-sms",
"dr_callback_url" => "http://example.com/webhooks/delivery-receipt"
]);
print_r($response->toArray());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:
$credentials = new VonageClientCredentialsGnp(
'tel:+447700900000',
fopen('./my-private-key'),
'my-application-id'
);
$client = new VonageClient($credentials);
if ($client->simswap()->checkSimSwap('07700009999', 240)) {
echo 'Warning: SIM Swap Check Failed'
} else {
echo 'SIM Swap Check Pass'
}And here is how you retrieve the swap date:
$credentials = new VonageClientCredentialsGnp(
'tel:+447700900000',
fopen('./my-private-key'),
'my-application-id'
);
$client = new VonageClient($credentials);
$date = $client->simswap()->checkSimSwapDate('07700009999')
echo $date;The Number Insights API allows a user to check that a number is valid and to find out more about how to use it.
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:
try {
$insights = $client->insights()->basic(PHONE_NUMBER);
echo $insights->getNationalFormatNumber();
} catch (Exception $e) {
// for the Vonage-specific exceptions, try the `getEntity()` method for more diagnostic information
}The data is returned in the $insights variable in the example above.
To get advanced insights, use the async feature and supply a URL for the webhook to be sent to:
try {
$client->insights()->advancedAsync(PHONE_NUMBER, 'http://example.com/webhooks/number-insights');
} catch (Exception $e) {
// for the Vonage-specific exceptions, try the `getEntity()` method for more diagnostic information
}Check out the documentation for what to expect in the incoming webhook containing the data you requested.
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.
$client = new VonageClient(new VonageClientCredentialsBasic(API_KEY, API_SECRET));
$apiKey = '34kokdf';
$subaccounts = $client->subaccount()->getSubaccounts($apiKey);
var_dump($subaccounts);$client = new VonageClient(new VonageClientCredentialsBasic(API_KEY, API_SECRET));
$apiKey = 'acc6111f';
$payload = [
'name' => 'sub name',
'secret' => 's5r3fds',
'use_primary_account_balance' => false
];
$account = new Account();
$account->fromArray($payload);
$response = $client->subaccount()->createSubaccount($apiKey, $account);
var_dump($response);$client = new VonageClient(new VonageClientCredentialsBasic(API_KEY, API_SECRET));
$apiKey = 'acc6111f';
$subaccountKey = 'bbe6222f';
$response = $client->subaccount()->getSubaccount($apiKey, $subaccountKey);
var_dump($response);$client = new VonageClient(new VonageClientCredentialsBasic(API_KEY, API_SECRET));
$apiKey = 'acc6111f';
$subaccountKey = 'bbe6222f';
$payload = [
'suspended' => true,
'use_primary_account_balance' => false,
'name' => 'Subaccount department B'
];
$account = new Account();
$account->fromArray($payload);
$response = $client->subaccount()->updateSubaccount($apiKey, $subaccountKey, $account)
var_dump($response);$client = new VonageClient(new VonageClientCredentialsBasic(API_KEY, API_SECRET));
$apiKey = 'acc6111f';
$filter = new VonageSubaccountFilterSubaccount(['subaccount' => '35wsf5'])
$transfers = $client->subaccount()->getCreditTransfers($apiKey);
var_dump($transfers);$client = new VonageClient(new VonageClientCredentialsBasic(API_KEY, API_SECRET));
$apiKey = 'acc6111f';
$transferRequest = (new TransferCreditRequest($apiKey))
->setFrom('acc6111f')
->setTo('s5r3fds')
->setAmount('123.45')
->setReference('this is a credit transfer');
$response = $this->subaccountClient->makeCreditTransfer($transferRequest);$client = new VonageClient(new VonageClientCredentialsBasic(API_KEY, API_SECRET));
$apiKey = 'acc6111f';
$filter = new VonageSubaccountFilterSubaccount(['end_date' => '2022-10-02']);
$transfers = $client->subaccount()->getBalanceTransfers($apiKey, $filter);$client = new VonageClient(new VonageClientCredentialsBasic(API_KEY, API_SECRET));
$apiKey = 'acc6111f';
$transferRequest = (new TransferBalanceRequest($apiKey))
->setFrom('acc6111f')
->setTo('s5r3fds')
->setAmount('123.45')
->setReference('this is a credit transfer');
$response = $client->subaccount()->makeBalanceTransfer($transferRequest);
var_dump($response);$client = new VonageClient(new VonageClientCredentialsBasic(API_KEY, API_SECRET));
$apiKey = 'acc6111f';
$numberTransferRequest = (new NumberTransferRequest($apiKey))
->setFrom('acc6111f')
->setTo('s5r3fds')
->setNumber('4477705478484')
->setCountry('GB');
$response = $client->subaccount()->makeNumberTransfer($numberTransferRequest);
var_dump($response);| API | API Release Status | Supported? |
|---|---|---|
| Account API | General Availability | |
| Alerts API | General Availability | |
| Application API | General Availability | |
| Audit API | Beta | |
| Conversation API | Beta | |
| Dispatch API | Beta | |
| External Accounts API | Beta | |
| Media API | Beta | |
| Meetings API | General Availability | |
| Messages API | General Availability | |
| Number Insight API | General Availability | |
| Number Management API | General Availability | |
| Pricing API | General Availability | |
| ProActive Connect API | Beta | |
| Redact API | General Availability | |
| Reports API | Beta | |
| SMS API | General Availability | |
| Subaccounts API | General Availability | |
| Verify API | General Availability | |
| Verify API (Version 2) | General Availability | |
| Voice API | General Availability |
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 VonageClient constructor, called show_deprecations. Enabling this
option will show all deprecation notices.
$client = new VonageClient(
new VonageClientCredentialsBasic(API_KEY, API_SECRET),
[
'show_deprecations' => true
]
);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 certificateSome users have issues making requests due to the following error:
Fatal error: Uncaught exception 'GuzzleHttpExceptionRequestException' with message 'cURL error 60: SSL certificate problem: unable to get local issuer certificate (see http://curl.haxx.se/libcurl/c/libcurl-errors.html)'
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:
# Linux/MacOS
curl.cainfo = "/etc/pki/tls/cacert.pem"
# Windows
curl.cainfo = "C:phpextrassslcacert.pem"
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:
$adapter_client = new HttpAdapterGuzzle6Client(new GuzzleHttpClient(['timeout' => 5]));
$vonage_client = new VonageClient(new VonageClientCredentialsBasic($api_key, $api_secret), [], $adapter_client);When things go wrong, you'll receive an Exception. The Vonage exception classes VonageClientExceptionRequest and VonageClientExceptionServer 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.
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.
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.
$client = new VonageClient(new VonageClientCredentialsBasic('abcd1234', 's3cr3tk3y'), ['debug' => true]);
$logger = new MonologLogger('test');
$logger->pushHandler(new MonologHandlerStreamHandler(__DIR__ . '/log.txt', MonologLogger::DEBUG));
$client->getFactory()->set(PSRLogLoggerInterface::class, $logger);ENABLING DEBUGGING LOGGING HAS THE POTENTIAL FOR LOGGING SENSITIVE INFORMATION, DO NOT ENABLE IN PRODUCTION
This library has a full test suite designed to be run with PHPUnit.
To run, use composer:
composer test
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):
ulimit -n 10240
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.
