README

这是Xoxzo Cloud API的PHP客户端库。您可以发送短信或打电话并播放MP3文件。

示例代码

发送短信

use xoxzo\cloudphp\XoxzoClient;

$sid = <Your Xoxzo SID>;
$auth_token = <Your Xoxzo AUTH TOKEN>
$recipient = '+818012345678';
$sender = '818012345678';
$message = 'Hello form Xoxzo PHP lib';

$xc = new XoxzoClient($sid,$auth_token);
$resp = $xc->send_sms($message, $recipient,$sender);
if ($resp->errors != null){
  print "Error status: $resp->errors\n";
  return;
}

$msgid = $resp->messages[0]->msgid;
$resp = $xc->get_sms_delivery_status($msgid);
var_dump($resp);

说明

• 首先，您需要创建XoxzoClient()对象。在初始化此对象时，您必须提供xoxzo sid和auth_token。在注册xoxzo账户并访问xoxzo仪表板后，您可以获取sid和auth_token。

• 然后您可以调用send_sms()方法。您需要提供三个参数。

  • message：您要发送的短信文本。
  • recipient：短信接收者的电话号码。此号码必须以日本国家代码"+81"开头，并遵循E.164格式。
  • sender：此号码将在接收者设备上显示。

• 此方法将返回XoxzoResponse对象。如果XoxzoResponse.errors == null，则XoxzoResponse->messages[0]->msgid是您可以传递给`get_sms_delivery_status()`调用的消息ID。

• 您可以通过get_sms_delivery_status()方法检查短信投递状态。您将提供您要检查的短信的消息ID。

播放MP3

use xoxzo\cloudphp\XoxzoClient;

$sid = <Your Xoxzo SID>;
$auth_token = <Your Xoxzo AUTH TOKEN>;
$recipient = '+818012345678';
$recording_url = 'http://exmaple.com/exmaple.mp3';
$caller = '8108012345678';

$xc = new XoxzoClient($sid, $auth_token);

$resp = $xc->call_simple_playback($caller, $recipient, $recording_url);

if ($resp->errors != null){
  print "Error status: $resp->errors\n";
  return;
}

$callid = $resp->messages[0]->callid;
$resp = $xc->get_simple_playback_status($callid);
var_dump($resp);

说明

• 您可以通过调用call_simple_playback()方法来播放MP3文件。您需要提供三个参数。

  • caller：此号码将在接收者设备上显示。
  • recording_url：MP3文件URL。
  • recipient：短信接收者的电话号码。此号码必须以日本国家代码"+81"开头，并遵循E.164格式。

• 此方法将返回XoxzoResponse对象。如果XoxzoResponse.errors == null，则XoxzoResponse->messages[0]->callid是您可以传递给`get_simple_playback_status()`调用的调用ID。

• 您可以通过get_simple_playback_status()方法检查调用状态。您将提供您要检查的电话调用的调用ID。

播放TTS

use xoxzo\cloudphp\XoxzoClient;

$sid = <Your Xoxzo SID>;
$auth_token = <Your Xoxzo AUTH TOKEN>;
$recipient = '+818012345678';
$tts_message = 'Hello';
$tts_lang = 'en';
$caller = '8108012345678';

$xc = new XoxzoClient($sid, $auth_token);

$resp = $xc->call_tts_playback($caller, $recipient, $tts_message, $tts_lang);

if ($resp->errors != null){
  print "Error status: $resp->errors\n";
  return;
}

$callid = $resp->messages[0]->callid;
$resp = $xc->get_simple_playback_status($callid);
var_dump($resp);

说明

• 您可以通过调用call_tts_playback()方法来播放TTS消息。您需要提供四个参数。

  • caller：此号码将在接收者设备上显示。
  • tts_message：您要播放的TTS文本消息。
  • tts_lang：TTS调用的语言代码。
  • recipient：短信接收者的电话号码。此号码必须以日本国家代码"+81"开头，并遵循E.164格式。

• 此方法将返回XoxzoResponse对象。如果XoxzoResponse.errors == null，则XoxzoResponse->messages[0]->callid是您可以传递给`get_simple_playback_status()`调用的调用ID。

• 您可以通过get_simple_playback_status()方法检查调用状态。您将提供您要检查的电话调用的调用ID。

DIN（拨入号码）

订阅DIN

$resp = $xc->get_din_list();
$a_din_uid = $resp->messages[0]->din_uid;
$resp = $xc->subscribe_din($a_din_uid);

说明

1. 要订阅DIN，您必须使用get_din_list()方法找到可用的未订阅DIN。

2. 然后您可以通过指定din唯一ID来通过subscribe_din()方法订阅DIN。

设置操作URL

$sample_acrion_url = "http://example.com/dummy_url";
$resp = $xc->set_action_url($a_din_uid, $sample_acrion_url);

说明

1. 一旦您订阅了DIN，您可以将操作URL设置为DIN。在DIN被调用时，将调用此URL。该URL将通过http GET方法调用，带有调用者和接收者参数。

获取订阅列表

$resp = $this->xc->get_subscription_list();

说明

要获取当前订阅的列表，您可以调用上述方法。

取消订阅DIN

$resp = $this->xc->unsubscribe_din($a_din_uid);

说明

当您不再使用DIN时，您可以通过指定din唯一ID来取消订阅DIN。