lonnylot/telnyx-php-sdk

Telnex PHP SDK

dev-master 2019-12-10 11:04 UTC

README

这是一个用于 Telnyx API v2 的 SDK,链接:Telnyx API v2

注意 由于 v2 API 仍在开发中,一些 v1 端点将存在于 \Lonnylot\Telnyx\Legacy 命名空间中。

安装

Composer

您可以通过 Composer 安装绑定。运行以下命令:

composer require lonnylot/telnyx-php-sdk dev-master

要使用绑定,请使用 Composer 的自动加载:

require_once('vendor/autoload.php');

依赖

该库需要 CrudSugar 库。

入门指南

创建此库是为了您可以与 Telnyx API 进行交互。

目录

  1. 设置客户端
  2. 可用资源
  3. 可用端点
  4. 使用端点

可用资源

资源命名如下:

  1. index - Telnyx "List"
  2. show - Telnyx "Retrieve"
  3. update - Telnyx "Update"
  4. delete - Telnyx "Delete"
  5. store - Telnyx "Create"

可用端点

  1. messagingProfile
  2. numberOrder
  3. numberSearch
  4. phoneNumber
  5. phoneNumberMessaging
  6. phoneNumberVoice

设置客户端

非 Laravel

$client = \Lonnylot\Telnyx\Client::getInstance('telnyx');
$client->setApiKey('<your key>');

Laravel

要使用 Laravel,您需要在 app/config/services.php 中设置您的 Telnyx API 密钥。

[
  'telnyx' => [
    'api_key' => env('TELNYX_API_KEY', ''),
  ]
]

现在您可以在 Laravel 应用程序中注入 \Lonnylot\Telnyx\Client 依赖,并且它将准备好使用。

使用端点

要使用端点,您只需从客户端调用端点,然后跟上传入的资源即可。

注意 请注意在 可用资源 部分的资源映射。

$client->numberSearch->index(['filter' => ['limit' => 3, 'features' => ['sms', 'mms']]]);