PHPackages hipcall/telnyx-php - 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. [API Development](/categories/api) 4. / 5. hipcall/telnyx-php ActiveLibrary[API Development](/categories/api) hipcall/telnyx-php ================== Telnyx PHP Library from Hipcall v0.1.1(2y ago)11361[3 issues](https://github.com/hipcall/telnyx-php/issues)[1 PRs](https://github.com/hipcall/telnyx-php/pulls)MITPHPPHP >=8.1.0 Since Feb 1Pushed 2y ago1 watchersCompare [ Source](https://github.com/hipcall/telnyx-php)[ Packagist](https://packagist.org/packages/hipcall/telnyx-php)[ Docs](https://www.hipcall.com/)[ RSS](/packages/hipcall-telnyx-php/feed)WikiDiscussions main Synced today READMEChangelog (2)Dependencies (5)Versions (3)Used By (0) Telnyx PHP SDK from Hipcall =========================== [](#telnyx-php-sdk-from-hipcall) We (\[Hipcall\])\[\] need to extend Telnyx PHP SDK for some reason. If you are Telnyx user please use their official [PHP SDK](https://packagist.org/packages/telnyx/telnyx-php). The Telnyx PHP library provides convenient access to the Telnyx API from applications written in PHP. It includes a pre-defined set of classes for API resources that initialize themselves dynamically from API responses. The library also provides other features. For example: - Easy configuration path for fast setup and use. - Helpers for pagination. - Built-in mechanisms for the serialization of parameters according to the expectations of Telnyx's API. You can sign up for a Telnyx account at [telnyx.com](https://telnyx.com). Requirements ------------ [](#requirements) PHP 8.1.0 and later. Composer -------- [](#composer) You can install the bindings via [Composer](http://getcomposer.org/). Run the following command: ``` $ composer require telnyx/telnyx-php ``` Manual Installation ------------------- [](#manual-installation) If you do not wish to use Composer, you can download the [latest release](https://github.com/team-telnyx/telnyx-php/releases). Then, to use the bindings, include the `init.php` file. ``` require_once('/path/to/telnyx-php/init.php'); ``` Dependencies ------------ [](#dependencies) Some PHP extensions are required: - [`curl`](https://secure.php.net/manual/en/book.curl.php), although you can use your own non-cURL client if you prefer - [`json`](https://secure.php.net/manual/en/book.json.php) - [`mbstring`](https://secure.php.net/manual/en/book.mbstring.php) (Multibyte String) Composer will handle these dependencies. If you install manually, you'll want to make sure that these extensions are available. Getting Started --------------- [](#getting-started) Basic example: ``` \Telnyx\Telnyx::setApiKey('YOUR_API_KEY_HERE'); // Get a list of messaging profiles $result = \Telnyx\MessagingProfile::all(); // Output list of messaging profiles print_r($result); ``` Documentation ------------- [](#documentation) Please see for up-to-date documentation. Custom Request Timeouts ----------------------- [](#custom-request-timeouts) To modify request timeouts (connect or total, in seconds) you'll need to tell the API client to use a CurlClient other than its default. You'll set the timeouts in that CurlClient. ``` // set up your tweaked Curl client $curl = new \Telnyx\HttpClient\CurlClient(); $curl->setTimeout(10); // default is Telnyx\HttpClient\CurlClient::DEFAULT_TIMEOUT $curl->setConnectTimeout(5); // default is Telnyx\HttpClient\CurlClient::DEFAULT_CONNECT_TIMEOUT echo $curl->getTimeout(); // 10 echo $curl->getConnectTimeout(); // 5 // tell Telnyx to use the tweaked client \Telnyx\ApiRequestor::setHttpClient($curl); // use the Telnyx API client as you normally would ``` Custom cURL Options (proxies) ----------------------------- [](#custom-curl-options-proxies) Need to set a proxy for your requests? Pass in the requisite `CURLOPT_*` array to the CurlClient constructor, using the same syntax as `curl_stopt_array()`. This will set the default cURL options for each HTTP request made by the SDK, though many more common options (e.g. timeouts; see above on how to set those) will be overridden by the client even if set here. ``` // set up your tweaked Curl client $curl = new \Telnyx\HttpClient\CurlClient([CURLOPT_PROXY => 'proxy.local:80']); // tell Telnyx to use the tweaked client \Telnyx\ApiRequestor::setHttpClient($curl); ``` Alternately, a callable can be passed to the CurlClient constructor that returns the above array based on request inputs. See `testDefaultOptions()` in `tests/CurlClientTest.php` for an example of this behavior. Note that the callable is called at the beginning of every API request, before the request is sent. Configuring a Logger -------------------- [](#configuring-a-logger) The library does minimal logging, but it can be configured with a [`PSR-3` compatible logger](http://www.php-fig.org/psr/psr-3/) so that messages end up there instead of `error_log`: ``` \Telnyx\Telnyx::setLogger($logger); ``` Accessing Response Data ----------------------- [](#accessing-response-data) You can access the data from the last API response on any object via `getLastResponse()`. ``` $order = \Telnyx\NumberOrder::create(['phone_number' => '+18665552368']); print_r($order->getLastResponse()->headers); ``` SSL / TLS Compatibility issues ------------------------------ [](#ssl--tls-compatibility-issues) Telnyx's API now requires that all connections use TLS 1.2. Some systems (most notably some older CentOS and RHEL versions) are capable of using TLS 1.2 but will use TLS 1.0 or 1.1 by default. The recommended course of action is to upgrade your cURL and OpenSSL packages so that TLS 1.2 is used by default, but if that is not possible, you might be able to solve the issue by setting the `CURLOPT_SSLVERSION` option to either `CURL_SSLVERSION_TLSv1` or `CURL_SSLVERSION_TLSv1_2`: ``` $curl = new \Telnyx\HttpClient\CurlClient([CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1]); \Telnyx\ApiRequestor::setHttpClient($curl); ``` Per-request Configuration ------------------------- [](#per-request-configuration) For apps that need to use multiple keys during the lifetime of a process it's also possible to set a per-request key and/or account: ``` \Telnyx\NumberOrder::all([], [ 'api_key' => 'KEY0123...' ]); \Telnyx\NumberOrder::retrieve("12ade33a-21c0-473b-b055-b3c836e1c292", [ 'api_key' => 'KEY0123...' ]); ``` Automatic Retries ----------------- [](#automatic-retries) The library can be configured to automatically retry requests that fail due to an intermittent network problem: ``` \Telnyx\Telnyx::setMaxNetworkRetries(2); ``` Development ----------- [](#development) Unit tests rely on a mock server so all unit tests are ran through docker. To run all unit tests execute: ``` docker-compose run --rm php composer test ``` Running unit tests with code coverage requires you build the docker container with XDEBUG=1 ``` docker-compose build --build-arg XDEBUG=1 ``` then run the unit tests as ``` docker-compose run --rm php composer test-coverage ``` Plugin Developers ----------------- [](#plugin-developers) Are you writing a plugin that integrates Telnyx and embeds our library? Then please use the `setAppInfo` function to identify your plugin. For example: ``` \Telnyx\Telnyx::setAppInfo("MyCustomPlugin", "1.2.3", "https://customplugin.yoursite.com"); ``` The method should be called once before any request is sent to the API. The second and third parameters are optional. SSL / TLS Configuration Option ------------------------------ [](#ssl--tls-configuration-option) See the "SSL / TLS compatibility issues" paragraph above for full context. If you want to ensure that your plugin can be used on all systems, you should add a configuration option to let your users choose between different values for `CURLOPT_SSLVERSION`: none (default), `CURL_SSLVERSION_TLSv1` and `CURL_SSLVERSION_TLSv1_2`. Acknowledgments --------------- [](#acknowledgments) The contributors and maintainers of Telnyx PHP would like to extend their deep gratitude to the authors of [Stripe PHP](https://github.com/stripe/stripe-php), upon which this project is based. Thank you for developing such elegant, usable, and extensible code and for sharing it with the community. ### Health Score 20 — LowBetter than 13% of packages Maintenance0 Infrequent updates — may be unmaintained Popularity13 Limited adoption so far Community16 Small or concentrated contributor base Maturity46 Maturing project, gaining track record Bus Factor2 2 contributors hold 50%+ of commits 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. ### Release Activity Cadence Every ~166 days Total 2 Last Release 1081d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/82726069?v=4)[Hipcall](/maintainers/hipcall)[@hipcall](https://github.com/hipcall) --- Top Contributors [![weroh](https://avatars.githubusercontent.com/u/50031971?v=4)](https://github.com/weroh "weroh (66 commits)")[![TomHAnderson](https://avatars.githubusercontent.com/u/493920?v=4)](https://github.com/TomHAnderson "TomHAnderson (28 commits)")[![eoghantelnyx](https://avatars.githubusercontent.com/u/29437758?v=4)](https://github.com/eoghantelnyx "eoghantelnyx (25 commits)")[![d-telnyx](https://avatars.githubusercontent.com/u/68876596?v=4)](https://github.com/d-telnyx "d-telnyx (12 commits)")[![onurozgurozkan](https://avatars.githubusercontent.com/u/248897?v=4)](https://github.com/onurozgurozkan "onurozgurozkan (6 commits)")[![ZebulanStanphill](https://avatars.githubusercontent.com/u/19592990?v=4)](https://github.com/ZebulanStanphill "ZebulanStanphill (1 commits)")[![mikeburrelljr](https://avatars.githubusercontent.com/u/270162?v=4)](https://github.com/mikeburrelljr "mikeburrelljr (1 commits)")[![rhysnhall](https://avatars.githubusercontent.com/u/25257505?v=4)](https://github.com/rhysnhall "rhysnhall (1 commits)")[![sdwru](https://avatars.githubusercontent.com/u/40401953?v=4)](https://github.com/sdwru "sdwru (1 commits)")[![ADandyGuyInSpace](https://avatars.githubusercontent.com/u/61507189?v=4)](https://github.com/ADandyGuyInSpace "ADandyGuyInSpace (1 commits)") --- Tags apihipcalltelnyxapitelnyxhipcall ### Code Quality TestsPHPUnit Code StylePHP CS Fixer ### Embed Badge ![Health badge](/badges/hipcall-telnyx-php/health.svg) ``` [![Health](https://phpackages.com/badges/hipcall-telnyx-php/health.svg)](https://phpackages.com/packages/hipcall-telnyx-php) ``` ### Alternatives [telnyx/telnyx-php Official Telnyx PHP SDK — APIs for Voice, SMS, MMS, WhatsApp, Fax, SIP Trunking, Wireless IoT, Call Control, and more. Build global communications on Telnyx's private carrier-grade network. 35789.4k2](/packages/telnyx-telnyx-php)[m165437/laravel-blueprint-docs API Blueprint Renderer for Laravel 22879.8k](/packages/m165437-laravel-blueprint-docs) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)