twilio-php SDK Documentation

The library automatically handles pagination for collections like calls and messages. You can interact with these collections in three ways:

1. read(): Eagerly fetches all records matching your criteria and returns them as a list.
2. stream(): Returns an iterator that lazily retrieves pages of records as you iterate, which is more memory-efficient for large datasets.
3. page(): Allows manual pagination by retrieving a single page of results. You can then use nextPage() on the returned page object to get the subsequent page.

You can control the number of records returned using limit and the size of each page using pageSize.

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

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

$limit = 5;
$pageSize = 2;

// Read - fetches all messages eagerly and returns as a list
$messageList = $client->messages->read([], $limit);
foreach ($messageList as $msg) {
    print($msg->sid);
}

// Stream - returns an iterator of 'pageSize' messages at a time and lazily retrieves pages until 'limit' messages
$messageStream = $client->messages->stream([], $limit, $pageSize);
foreach ($messageStream as $msg) {
    print($msg->sid);
}

// Page - get the a single page by passing pageSize, pageToken and pageNumber
$messagePage = $client->messages->page([], $pageSize);
$nextPageData = $messagePage->nextPage();  // this will return data of next page
foreach ($messagePage as $msg) {
    print($msg->sid);
}

To create a custom HTTP client, extend Twilio\\/Http\\/CurlClient and override the request method. This allows you to intercept the request parameters and apply custom logic, such as setting CURLOPT_PROXY or CURLOPT_CAINFO.

When implementing request, you should:

1. Use $this->options(...) to retrieve the standard request parameters.
2. Initialize cURL and apply the options.
3. Apply your custom logic (e.g., proxy settings).
4. Execute the request and parse the response into a Twilio\\/Http\\/Response object containing the status code, body, and headers.

use Twilio\/Http\\/CurlClient;
use Twilio\/Http\\/Response;

class MyRequestClass extends CurlClient
{
    protected $http = null;
    protected $proxy = null;

    public function __
{...}

    public function request(
        $method,
        $url,
        $params = array(), $data = array(), $headers = array(), $user = null, $password = null, $timeout = null): Response
    {
        // Implementation logic here
    }
}

If you cannot use a package manager, you can download the full source from GitHub and unzip it into your project directory. To use it, you must manually require the bundled autoload.php file located within the SDK directory.

<?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!"
    ]
);

The library throws specific exceptions that you should catch to prevent application crashes:

• Twilio\Exceptions\ConfigurationException: Thrown during client initialization (e.g., invalid credentials).
• Twilio\Exceptions\EnvironmentException: Thrown if required system dependencies (like curl) are missing.
• Twilio\Exceptions\TwilioException: The most common exception, thrown when an API request fails.
• Twilio\Exceptions\TwimlException: Thrown when generated TwiML does not conform to API expectations.

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

use Twilio\Exceptions\TwilioException;
use Twilio\Rest\Client;

$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;