README

这是用于使用 Citcall API 的 PHP 客户端库。要使用它，您需要一个 Citcall 账户，并且您的 IP 已在 citcall 系统中过滤。有关更多信息，请参阅 citcall 文档。这目前是一个测试版。

安装

使用 Composer 安装

要将 PHP 客户端库安装到您的项目中，我们建议使用 Composer。

composer require citcall/api

您不需要克隆此存储库即可在您的项目中使用此库。使用 Composer 从 Packagist 安装它。

如果您对 Composer 不熟悉，以下是一些您可能觉得有用的资源：

• Composer 入门页面 来自 Composer 项目的文档。
• Composer 入门指南 来自 ScotchBox 的朋友们。

从 GitHub 安装源代码

要安装源代码

$ git clone git://github.com/citcall/sample-php.git

并在您的脚本中包含它

require_once '/path/to/src/Citcall.php';

用法

如果您使用 Composer，请确保自动加载器已包含在您的项目引导文件中

require_once "vendor/autoload.php";

使用您的 API 密钥创建一个 citcall

$citcall = new Citcall\Citcall(APIKEY);

示例

Miscall OTP

要使用 Citcall 的 Miscall 异步 API 进行异步通话，请调用 $citcall->miscall() 方法。

可以直接调用 API，使用简单的参数数组，键与 API 参数 匹配。

$motp = $citcall->motp([
	'msisdn' => MSISDN,
	'gateway' => GATEWAY
]);

如果您想稍后进行验证，请使用此示例。

$motp = $citcall->motp([
	'msisdn' => MSISDN,
	'gateway' => GATEWAY,
	'valid_time' => TIME_VALID, //optional - valid time in seconds
	'limit_try' => LIMIT_TRY //optional - maximum attempt
	'callback_url' => CALLBACK_URL //Webhook URL where delivery status for the result will be posted (Overwrites your default account callback URL).
]);

可以访问异步_miscal 的数组属性以访问 API 响应数据。

print_r($motp);

回调 Miscall OTP

您可以在我们的 仪表板 API 菜单中配置您账户的默认回调 URL。您还可以通过在 API 请求中指定不同的 callback_url 值来覆盖默认回调 URL。

请参阅此 示例 以使用回调。

短信

要使用 Citcall 的短信 API 发送短信，请调用 $citcall->sms() 方法。

可以直接调用 API，使用简单的参数数组，键与 API 参数 匹配。

$sms = $citcall->sms([
	'senderid' => 'citcall',
	'msisdn' => MSISDN,
	'text' => 'Test message from the Citcall PHP',
	'callback_url' => CALLBACK_URL //Webhook URL where delivery status for the result will be posted (Overwrites your default account callback URL).
]);

可以访问短信的数组属性以访问 API 响应数据。

print_r($sms);

回调短信

您可以在我们的 仪表板 API 菜单中配置您账户的默认回调 URL。您还可以通过在 API 请求中指定不同的 callback_url 值来覆盖默认回调 URL。

请参阅此 示例 以使用回调。

SMSOTP

要使用 Citcall 的 SMSOTP API 发送带有 OTP 文本的短信，请调用 $citcall->smsotp() 方法。

可以直接调用 API，使用简单的参数数组，键与 API 参数 匹配。

$smsotp = $citcall->smsotp([
	'senderid' => 'citcall',
	'msisdn' => MSISDN,
	'text' => 'Test message OTP from the Citcall PHP',
	'callback_url' => CALLBACK_URL //Webhook URL where delivery status for the result will be posted (Overwrites your default account callback URL).
]);

可以访问短信的数组属性以访问 API 响应数据。

print_r($smsotp);

回调 SMSOTP

您可以在我们的 仪表板 API 菜单中配置您账户的默认回调 URL。您还可以通过在 API 请求中指定不同的 callback_url 值来覆盖默认回调 URL。

请参阅此 示例 以使用回调。

验证OTP代码

要使用Citcall的验证API来验证OTP，调用$citcall->verify()方法。

可以直接调用API，使用一个简单的参数数组，键与API参数匹配。

$verify = $citcall->verify([
	'msisdn' => MSISDN,
	'trxid' => TRXID,
	'token' => TOKEN
]);

可以通过verify_motp数组的属性来访问API响应数据。

print_r($verify);

贡献

1. 查找未解决的问题或为功能请求或错误打开新的问题
2. 在Github上派生存储库以开始对master分支（或从中分支）进行更改
3. 编写一个测试来显示错误已被修复或功能按预期工作
4. 发送一个pull请求，并在我们合并它之前打扰我们