README

Cecula Sync API 客户端是一个简单的库，可以为您的应用程序提供托管模拟账户管理功能。您可以通过调用相应的方法来访问所有端点功能，例如发起调用、发送短信等。

安装

假设您已经使用 composer。要将 Cecula Sync API 客户端安装到项目中，只需在终端中运行以下命令。

composer require cecula/sync-api-client

获取您的 API 密钥

• 登录到 Cecula Sync 平台
• 导航到 账户 > 设置 选择 API 密钥 标签，如果您还没有密钥，请生成一个新的密钥
• 复制密钥

创建您的配置文件

• 在终端运行以下命令。将 /path/to/project 替换为您的项目目录

cd /path/to/project
cp vendor/cecula/sync-api-client/.ceculasync.json.example .ceculasync.json

• 打开 .ceculasync.json 文件，并将您的 API 密钥粘贴到相应的字段中。

就这样！让我们快速开始行动。

快速开始

由于我们使用 composer，我假设您的项目中已经自动加载了类。如果您的入口脚本中至少做了类似以下操作，Cecula Sync API 客户端将自动加载。

require_once __DIR__."/vendor/autoload.php";

*** 如果您使用的是框架，那么这已经为您完成了。

调用

use CeculaSyncApiClient\SyncCall;


$testMobile = ""; // Enter your mobile number here


$syncCall = new SyncCall();

echo "Send Missed Call: ".PHP_EOL;
var_dump($syncCall->dial($testMobile));

echo "Call Status: ".PHP_EOL;
var_dump($syncCall->getCallStatus("2020012676"));

echo "Call Auto-Response Message: ".PHP_EOL;
var_dump($syncCall->saveCallAutoResponseText(""));

echo "New Missed Calls: ".PHP_EOL;
var_dump($syncCall->getNewMissedCalls());

短信

use CeculaSyncApiClient\SyncSms;

$syncSms = new SyncSms();


echo "Send SMS: ".PHP_EOL;
var_dump($syncSms->sendSMS("Hello Sync", [$testMobile]));

echo "Sent SMS Status: ".PHP_EOL;
var_dump($syncSms->getSentMessageStatus("36545"));

echo "Get Unread SMS: ".PHP_EOL;
var_dump($syncSms->getUnreadSMS());

echo "Save Auto-Response SMS: ".PHP_EOL;
var_dump($syncSms->setSMSAutoResponseText("Thank you. I'll revert ASAP"));

账户管理

use CeculaSyncApiClient\SyncAccount;

$syncAccount = new SyncAccount();

echo "Get Cecula Balance: ".PHP_EOL;
var_dump($syncAccount->getCeculaBalance());

echo "Get Subscription Status: ".PHP_EOL;
var_dump($syncAccount->getSubscriptionStatus());

echo "Get SIM Status: ".PHP_EOL;
var_dump($syncAccount->getSimStatus());

echo "Refresh SIM: ".PHP_EOL;
var_dump($syncAccount->refreshSIM());

有关更多详细信息，请参阅 Cecula Sync API 参考。