• Stars
    star
    1,447
  • Rank 31,252 (Top 0.7 %)
  • Language
    PHP
  • License
    MIT License
  • Created over 14 years ago
  • Updated 8 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A PHP library for communicating with the Twilio REST API and generating TwiML.

twilio-php

Tests Quality Gate Status Packagist Packagist Learn with TwilioQuest

Documentation

The documentation for the Twilio API can be found here.

The PHP library documentation can be found here.

Versions

twilio-php uses a modified version of Semantic Versioning for all changes. See this document for details.

Supported PHP Versions

This library supports the following PHP implementations:

  • PHP 7.2
  • PHP 7.3
  • PHP 7.4
  • PHP 8.0
  • PHP 8.1

Installation

You can install twilio-php via composer or by downloading the source.

Via Composer

twilio-php is available on Packagist as the twilio/sdk package:

composer require twilio/sdk

Test your installation

Here is an example of using the SDK to send a text message:

// Send an SMS using Twilio's REST API and PHP
<?php
// Required if your environment does not handle autoloading
require __DIR__ . '/vendor/autoload.php';

// Your Account SID and Auth Token from console.twilio.com
$sid = "ACXXXXXX";
$token = "YYYYYY";
$client = new Twilio\Rest\Client($sid, $token);

// Use the Client to make requests to the Twilio REST API
$client->messages->create(
    // The number you'd like to send the message to
    '+15558675309',
    [
        // A Twilio phone number you purchased at https://console.twilio.com
        'from' => '+15017250604',
        // The body of the text message you'd like to send
        'body' => "Hey Jenny! Good luck on the bar exam!"
    ]
);

Without Composer

While we recommend using a package manager to track the dependencies in your application, it is possible to download and use the PHP SDK manually. You can download the full source of the PHP SDK from GitHub, and browse the repo if you would like. To use the SDK in your application, unzip the SDK download file in the same directory as your PHP code. In your code, you can then require the autoload file bundled with the SDK.

<?php
// Require the bundled autoload file - the path may need to change
// based on where you downloaded and unzipped the SDK
require __DIR__ . '/twilio-php-main/src/Twilio/autoload.php';

// Your Account SID and Auth Token from console.twilio.com
$sid = "ACXXXXXX";
$token = "YYYYYY";
$client = new Twilio\Rest\Client($sid, $token);

// Use the Client to make requests to the Twilio REST API
$client->messages->create(
    // The number you'd like to send the message to
    '+15558675309',
    [
        // A Twilio phone number you purchased at https://console.twilio.com
        'from' => '+15017250604',
        // The body of the text message you'd like to send
        'body' => "Hey Jenny! Good luck on the bar exam!"
    ]
);

Usage

Make a Call

<?php
$sid = "ACXXXXXX";
$token = "YYYYYY";

$client = new Twilio\Rest\Client($sid, $token);

// Read TwiML at this URL when a call connects (hold music)
$call = $client->calls->create(
    '8881231234',
    // Call this number
    '9991231234',
    // From a valid Twilio number
    [
        'url' => 'https://twimlets.com/holdmusic?Bucket=com.twilio.music.ambient'
    ]
);

Warning It's okay to hardcode your credentials when testing locally, but you should use environment variables to keep them secret before committing any code or deploying to production. Check out How to Set Environment Variables for more information.

Get an existing Call

<?php
require_once '/path/to/vendor/autoload.php';

$sid = "ACXXXXXX";
$token = "YYYYYY";
$client = new Twilio\Rest\Client($sid, $token);

// Get an object using its SID. If you do not have a SID,
// check out the list resource examples on this page
$call = $client->calls("CA42ed11f93dc08b952027ffbc406d0868")->fetch();
print $call->to;

Iterate through records

The library automatically handles paging for you. Collections, such as calls and messages, have read and stream methods that page under the hood. With both read and stream, you can specify the number of records you want to receive (limit) and the maximum size you want each page fetch to be (pageSize). The library will then handle the task for you.

read eagerly fetches all records and returns them as a list, whereas stream returns an iterator and lazily retrieves pages of records as you iterate over the collection. You can also page manually using the page method.

For more information about these methods, view the auto-generated library docs.

Use the read method

<?php
require_once '/path/to/vendor/autoload.php';

$sid = "ACXXXXXX";
$token = "YYYYYY";
$client = new Twilio\Rest\Client($sid, $token);

// Loop over the list of calls and print a property from each one
foreach ($client->calls->read() as $call) {
    print $call->direction;
}

Specify Region and/or Edge

To take advantage of Twilio's Global Infrastructure, specify the target Region and/or Edge for the client:

<?php
$sid = "ACXXXXXX";
$token = "YYYYYY";

$client = new Twilio\Rest\Client($sid, $token, null, 'au1');
$client->setEdge('sydney');

A Client constructor without these parameters will also look for TWILIO_REGION and TWILIO_EDGE variables inside the current environment.

This will result in the hostname transforming from api.twilio.com to api.sydney.au1.twilio.com.

Enable Debug Logging

There are two ways to enable debug logging in the default HTTP client. You can create an environment variable called TWILIO_LOG_LEVEL and set it to debug or you can set the log level to debug:

$sid = "ACXXXXXX";
$token = "YYYYYY";

$client = new Twilio\Rest\Client($sid, $token);
$client->setLogLevel('debug');

Generate TwiML

To control phone calls, your application needs to output TwiML.

Use Twilio\TwiML\(Voice|Messaging|Fax)Response to easily chain said responses.

<?php
$response = new Twilio\TwiML\VoiceResponse();
$response->say('Hello');
$response->play('https://api.twilio.com/cowbell.mp3', ['loop' => 5]);
print $response;

That will output XML that looks like this:

<?xml version="1.0" encoding="utf-8"?>
<Response>
    <Say>Hello</Say>
    <Play loop="5">https://api.twilio.com/cowbell.mp3</Play>
</Response>

Handle exceptions

When something goes wrong during client initialization, in an API request, or when creating TwiML, twilio-php will throw an appropriate exception. You should handle these exceptions to keep your application running and avoid unnecessary crashes.

The Twilio client

For example, it is possible to get an authentication exception when initiating your client, perhaps with the wrong credentials. This can be handled like so:

<?php
require_once('/path/to/twilio-php/Services/Twilio.php');

use Twilio\Exceptions\ConfigurationException;
use Twilio\Rest\Client;

$sid = "ACXXXXXX";
$token = "YYYYYY";

// Attempt to create a new Client, but your credentials may contain a typo
try {
    $client = new Twilio\Rest\Client($sid, $token);
} catch (ConfigurationException $e) {
    // You can `catch` the exception, and perform any recovery method of your choice
    print $e . getCode();
}

$call = $client->account->calls
    ->get("CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX");

print $call->to;

CurlClient

When initializing the curl client, you will see an EnvironmentException if curl is not installed on your system.

<?php
require_once('/path/to/twilio-php/Services/Twilio.php');

use Twilio\Exceptions\TwilioException;
use Twilio\Http\CurlClient;

$sid = "ACXXXXXX";
$token = "YYYYYY";
$client = new Twilio\Rest\Client($sid, $token);

try {
    $client = new CurlClient();

    $client->options(
        'GET',
        'http://api.twilio.com',
        array(),
        array(),
        array(),
        $sid,
        $token
    );
} catch (EnvironmentException $e) {
    print $e . getCode();
}

print $call->to;

TwilioException

TwilioException can be used to handle API errors, as shown below. This is the most common exception type that you will most likely use.

<?php
require_once('/path/to/twilio-php/Services/Twilio.php');

use Twilio\Exceptions\TwilioException;

$sid = "ACXXXXXX";
$token = "YYYYYY";
$client = new Twilio\Rest\Client($sid, $token);

try {
    $call = $client->account->calls
        ->get("CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX");
} catch (TwilioException $e) {
    print $e->getCode();
}

print $call->to;

TwimlException

When building TwiML with twilio-php, if the result does not conform to what the API expects, you will see a TwimlException which you then need to handle like so:

<?php
require_once './vendor/autoload.php';
use Twilio\Twiml;

try {
    $response = new Twiml();
    $dial = $response->dial();
    $dial->conference('Room 1234');
    print $response;
} catch (TwimlException $e) {
    print $e->getCode();
}

Debug API requests

To assist with debugging, the library allows you to access the underlying request and response objects. This capability is built into the default Curl client that ships with the library.

For example, you can retrieve the status code of the last response like so:

<?php
$sid = "ACXXXXXX";
$token = "YYYYYY";

$client = new Twilio\Rest\Client($sid, $token);
$message = $client->messages->create(
    '+15558675309',
    [
        'from' => '+15017250604',
        'body' => "Hey Jenny! Good luck on the bar exam!"
    ]
);

// Print the message's SID
print $message->sid;

// Print details about the last request
print $client->lastRequest->method;
print $client->lastRequest->url;
print $client->lastRequest->auth;
print $client->lastRequest->params;
print $client->lastRequest->headers;
print $client->lastRequest->data;

// Print details about the last response
print $client->lastResponse->statusCode;
print $client->lastResponse->body;

Use a custom HTTP Client

To use a custom HTTP client with this helper library, please see the advanced example of how to do so.

Docker image

The Dockerfile present in this repository and its respective twilio/twilio-php Docker image are currently used by Twilio for testing purposes only.

Getting help

If you need help installing or using the library, please check the Twilio Support Help Center first, and file a support ticket if you don't find an answer to your question.

If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!

More Repositories

1

twilio-video-app-react

A collaboration application built with the twilio-video.js SDK and React.js
TypeScript
1,793
star
2

twilio-python

A Python module for communicating with the Twilio API and generating TwiML.
Python
1,707
star
3

stashboard

An open-source status dashboard running on App Engine
Python
1,594
star
4

twilio-ruby

A Ruby gem for communicating with the Twilio API and generating TwiML
Ruby
1,335
star
5

twilio-node

Node.js helper library
TypeScript
1,304
star
6

OpenVBX

OpenVBX is a web-based open source phone system for business.
PHP
699
star
7

twilio-csharp

Twilio C#/.NET Helper Library for .NET Framework 3.5+ and supported .NET Core versions
C#
636
star
8

BankersBox

redis-like wrapper for javascript storage
CoffeeScript
571
star
9

twilio-video.js

Twilio’s Programmable Video JavaScript SDK
JavaScript
563
star
10

video-quickstart-ios

Twilio Video Quickstart for iOS
Swift
455
star
11

twilio-java

A Java library for communicating with the Twilio REST API and generating TwiML.
Java
440
star
12

video-quickstart-js

A quickstart and code samples for Twilio Video JavaScript SDK. https://www.twilio.com/docs/video
JavaScript
390
star
13

shadow

A HTTP debugging proxy that helps you with your continuous deployments
JavaScript
330
star
14

twilio-go

A Go package for communicating with the Twilio API.
Go
249
star
15

twilio-video-app-ios

A collaboration application built with the Twilio Video iOS SDK
Swift
246
star
16

authy-php

A PHP client for Authy
PHP
245
star
17

twilio-sans-mono

Twilio Sans Mono is a beautiful and extensive open source programming font
Shell
240
star
18

twilio-video-app-android

A collaboration application built with the Twilio Video Android SDK
Kotlin
239
star
19

video-quickstart-android

Twilio Video Quickstart for Android
Java
210
star
20

authy-devise

Authy Devise plugin to add Two-Factor Authentication
Ruby
199
star
21

authy-python

Authy API Client for Python
Python
188
star
22

twilio-salesforce

A Salesforce/Force.com library for communicating with the Twilio REST API and generating TwiML. Need help? Post your questions to http://getsatisfaction.com/twilio or email us at [email protected]
Apex
186
star
23

voice-quickstart-android

Quickstart app for the Voice Android SDK
Java
185
star
24

voice-quickstart-ios

Twilio Voice Quickstart for iOS with Swift
Objective-C
177
star
25

authy-ruby

**Deprecated** Ruby library to access the authy API
Ruby
156
star
26

audioswitch

An Android audio management library for real-time communication apps.
Kotlin
153
star
27

authy-openvpn

Authy Open VPN Two-Factor Authentication
C
152
star
28

twilio-cli

Unleash the power of Twilio from your command prompt
JavaScript
150
star
29

gameday

A collection of Twilio SRE's Gameday Templates
140
star
30

chessms

Play Chess over SMS!
Erlang
112
star
31

TwilioChatJsReactNative

ReactNative app example for Twilio Programmable Chat with working iOS and Android push messages https://www.twilio.com/chat
JavaScript
112
star
32

twilio-oai

The Twilio OpenAPI Specification
Makefile
112
star
33

apkscale

A Gradle plugin to measure the app size impact of Android libraries
Kotlin
94
star
34

OpenVBX-iPhone

OpenVBX for iPhone
Objective-C
92
star
35

twilio-chat-demo-js

Programmable Chat API Demo Application for JavaScript
JavaScript
92
star
36

media-streams

Quick start guides for configuring and consuming Twilio Media Streams
Ruby
90
star
37

twilio-conversations-demo-react

Twilio Conversations Demo Web Application
TypeScript
87
star
38

starter-node

A starter app for node.js developers embarking on their first Twilio quest!
JavaScript
84
star
39

authy-form-helpers

Authy javascripts and css file to help create quick forms for the authy api
CoffeeScript
83
star
40

flex-plugin-builder

Packages related to building a Twilio Flex Plugin
TypeScript
82
star
41

starter-python

A starter app for Python developers embarking on their first Twilio quest!
CSS
76
star
42

sourd.io

sourd.io: temperature, humidity, and rise monitoring for your sourdough starter
C++
72
star
43

authy-java

Java Client for Twilio Authy Two-Factor Authentication (2FA) API
Java
65
star
44

twilio-client.js

Twilio’s Programmable Voice JavaScript SDK
TypeScript
65
star
45

twilio-video-ios

Programmable Video SDK by Twilio
Swift
64
star
46

twilio-chat-demo-android

Chat API Demo Application for Android
Kotlin
63
star
47

terraform-provider-twilio

Terraform Twilio provider
Go
57
star
48

twilio-webchat-react-app

Twilio Webchat React App is an application that demonstrates a website chat widget built with Twilio's Conversations JS SDK, Twilio Paste Design library and Create React App.
TypeScript
55
star
49

twilio-voice-react-native

TypeScript
51
star
50

twilio-webrtc.js

WebRTC-related APIs and shims used by twilio-video.js
JavaScript
49
star
51

rtc-diagnostics

TypeScript
44
star
52

twilio-voice.js

Twilio's JavaScript Voice SDK
TypeScript
44
star
53

flex-ui-sample

Twilio Flex UI Sample
JavaScript
42
star
54

twilio-video-diagnostics-react-app

A diagnostics tool that tests a participant's ability to have a quality video call. Built with the twilio-video.js SDK, RTC Diagnostics SDK, and React.js.
TypeScript
41
star
55

wiztowar

Build WARs from your Dropwizard apps
Java
40
star
56

voice-quickstart-objc

Twilio Voice Quickstart for iOS with Objective-C
Objective-C
38
star
57

hackathons

A collection of tips and tricks for using Twilio at hackathons
37
star
58

sample-code

Auto-generated code samples for the Twilio REST API
Java
36
star
59

draw-with-twilio

Draw with Twilio
JavaScript
35
star
60

twilio-voice-ios

Programmable Voice SDK by Twilio
Swift
34
star
61

twilio-voice-notification-app

Reference app built in ReactJS that demonstrates how to leverage Twilio Programmable Voice and Twilio SDKs to create a voice notification system.
TypeScript
34
star
62

video-quickstart-objc

Twilio Video Quickstart for iOS with Objective-C
Objective-C
33
star
63

twilio-video-processors.js

Twilio Video Processors is a collection of video processing tools which can be used with Twilio Video JavaScript SDK to apply transformations and filters to a video track.
TypeScript
33
star
64

TwilioChatXamarinBindings

Twilio Chat Bindings for Xamarin (Android and iOS) and Sample app with working FCM and APN pushes using those bindings.
C#
32
star
65

twilio-live-interactive-video

An interactive live video app built with Twilio Live and Twilio Video
TypeScript
31
star
66

twilio-video.js-recording-bot

JavaScript
30
star
67

flex-webchat-ui-sample

Twilio Flex Web Chat UI Sample
JavaScript
30
star
68

twilio-chat-demo-ios

Twilio Programmable Chat Demo Application for iOS
Objective-C
28
star
69

ortc-adapter

ORTC to WebRTC Adapter
JavaScript
28
star
70

cloudsec

27
star
71

starter-ruby

A starter app for Ruby developers embarking on their first Twilio quest!
JavaScript
27
star
72

calcite-kudu

Apache Calcite Adapter for Apache Kudu
Java
26
star
73

autopilot-cli

The Twilio Autopilot CLI is now deprecated. Please use the Autopilot Plugin for the Twilio CLI here https://www.twilio.com/docs/autopilot/twilio-autopilot-cli
JavaScript
26
star
74

twilio-oai-generator

Twilio OpenAPI client generator
Java
25
star
75

voice-quickstart-server-python

Python
25
star
76

twilio-video-room-monitor.js

A browser-based tool that displays information and metrics about Twilio Video JavaScript applications
TypeScript
24
star
77

video-shared-arkit-sample

ARKit + Twilio Video Data Tracks demo
Swift
24
star
78

twilio-voice-react-native-app

TypeScript
24
star
79

twilio-boost-build

Build tool for boost libraries on android, ios, linux and osx
Shell
23
star
80

voice-quickstart-server-node

voice quickstart server example in node
JavaScript
23
star
81

wireless-security-camera

Create a Twilio-powered device that keeps watch over dangerous and remote locations and alerts stakeholders of intrusions or safety concerns.
CSS
22
star
82

starter-java

A starter app for Java developers embarking on their first Twilio quest!
CSS
22
star
83

twilio-taskrouter.js

JS SDK v2 for Twilio's TaskRouter skills based routing system.
JavaScript
21
star
84

autopilot-templates

JavaScript
20
star
85

wireless-fleet-tracker

Create a Twilio-powered Fleet Tracker that uses off-the-shelf components to track and log: miles driven, hours of uptime and downtime, locations, average speed, and fuel consumption.
CSS
20
star
86

client-js-1.4-examples

Examples for using the new Client JS 1.4 Audio functionality
JavaScript
19
star
87

voices

Twilio Voices - Contribute programming tutorials to the Twilio blog. Get paid for each post you publish.
19
star
88

wp-click2call

Wordpress Plugin for Click2Call
PHP
19
star
89

authy.net

.NET Library to access the Authy API
C#
19
star
90

starter-php

A starter app for PHP developers embarking on their first Twilio quest!
PHP
19
star
91

Breakout_Arduino_Library

C
18
star
92

howtos

Sample applications that cover common use cases in a variety of languages.
Python
18
star
93

wireless-postman-collection

This repository includes a group of Programmable Wireless HTTP requests for your convenience. You can learn more about Programmable Wireless HTTP request formats in the Programmable Wireless Documentation.
18
star
94

rtc-diagnostics-react-app

TypeScript
18
star
95

linkit-one-sensor-samples

Samples for the LinkIt ONE Starter Kit
C++
17
star
96

cerebro

Python
17
star
97

twilio-flex-token-validator

Flex JWE Token Validator
TypeScript
17
star
98

twilio-conversations-demo-android-kotlin

An application demonstrating use of Twilio Conversations on Android - this is a full working Kotlin application
Kotlin
16
star
99

twilio-verify-ios

Twilio Verify Push SDK helps you verify users by adding a low-friction, secure, cost-effective, "push verification" factor into your own apps. This project provides an SDK to implement Verify Push for your iOS app.
Swift
16
star
100

twilio-chat-console-webapp.js

Web Console example app for Twilio Programmable Chat with working push messages
JavaScript
15
star