Angelfon API Rest 包装器

v1.1.3 2018-03-02 12:46 UTC

This package is not auto-updated.

Last update: 2024-09-22 07:33:01 UTC


README

Packagist Packagist

使用 Angelfon PHP SDK,您可以轻松生成电话呼叫,只需几个步骤。

安装

您可以使用 composer 或直接从存储库安装 angelfon-php

使用 Composer

angelfon-php 在 Packagist 上可用,地址为 angelfon/sdk

composer require angelfon/sdk

配置

您需要有一个 Angelfon 账户 来使用这个库。您可以在 Angelfon Plus 上录制和检查您的音频,并在您的电话中指定您想要的音频 ID。

通过发送邮件到 fernando@angelfon.com 请求您的客户凭证。

我们建议在您的应用程序环境中添加与您的账户相关的变量

ANGELFON_USERNAME=my@email.com
ANGELFON_PASSWORD=mypass
ANGELFON_CLIENT_ID=404
ANGELFON_CLIENT_SECRET=u8R3ZVmesIbpaEx3F3nupP4D3SSJ9N3QSQSBYuoX

这样就不需要在实例化 Rest 客户端时指定您的凭证

$client = new Angelfon\SDK\Rest\Client();

否则

$client = new Angelfon\SDK\Rest\Client('my@email.com', 'mypass', 404, 'u8R3ZVmesIbpaEx3F3nupP4D3SSJ9N3QSQSBYuoX');

快速指南

发送短信

// Envía un SMS usando Angelfon REST API y PHP
<?php

use Angelfon\SDK\Rest\Client;

$client = new Client();
$sms = $client->sms->create(
  '912345678', // Envía el SMS a éste número
  array(
    'body' => 'Hola que tal!'
  )
);

print $sms->id;

拨打电话

<?php

use Angelfon\SDK\Rest\Client;

$client = new Client();

// Envía un audio almacenado en tu cuenta Angelfon
$call = $client->calls->create(
  '912345678', // Destinatario
  array(
    'type' => 1, //Llamada unidireccional que requiere 'audioId1'
    'recipientName' => 'Destinatario de ejemplo',
    'audioId1' => 123
  )
);

print $call->id;

您也可以同时将电话发送给多个接收者

<?php

use Angelfon\SDK\Rest\Client;

$client = new Client();

// Envía un texto como llamada
$call = $client->calls->create(
  array(
    'destinatario 1' => '912345678',
    'destinatario 2' => '987654321',
  ),
  array(
    'type' => 6, //Llamada unidireccional que requiere 'tts1'
    'tts1' => 'Esta llamada es un texto hablado'
  ) 
);

print $call->batchId;

您可以使用辅助方法来创建选项

<?php

use Angelfon\SDK\Rest\Client;
use Angelfon\SDK\Rest\Api\V099\User\CallOptions;

$client = new Client();

// Genera opciones de la llamada
$options = CallOptions::createWithSingleTts('Esta otra llamada también es un texto hablado');

// $options = CallOptions::createFree(123);
// $options = CallOptions::createWithSingleAudio(123);
// $options = CallOptions::createWithAnswer(123);
// $options = CallOptions::createWithAudioAndTts(123, 'primer tts', 124, 'segundo tts', 125);

// Especifica la hora a la cual realizar la llamada
$options->setCallAt('2018-07-27 18:00:00');

// Usa Caller ID para mostrar tu número registrado en Angelfon al realizar la llamada
$options->setCallerId(true);

// O define desde que número se realizará la llamada
// $options->setCallFrom('911223344')

// Envía la llamada
$calls = $client->calls->create(
  array(
    'destinatario 1' => '912345678',
    'destinatario 2' => '987654321',
  ),
  $options
);

print $calls->batchId;

有关调用辅助方法的更多信息,请参阅此处

获取通话

<?php

$client = new Angelfon\SDK\Rest\Client();

// Genera opciones de lectura de la llamada
$options = CallOptions::read();

$options->setRecipient('912345678'); // Mostrar solo llamadas realizadas a este número
$options->setBatchId('ff9891b45733305b275026ba4218eaf2'); // Mostrar sólo llamadas en este Batch

$calls = $this->client->calls->read($options);

print $calls[0]->id;

文档

您可以在 此处 找到 Angelfon API REST 的文档。

您可以在 此处 找到此 SDK 的文档。

先决条件

  • PHP >= 5.3
  • PHP JSON 扩展

支持

如果您需要安装或使用此库的帮助,请联系我们!