cecula / messaging-api
用于消费Cecula消息API的库。
v1.0.2
2024-09-10 07:07 UTC
Requires
- php: >=7.4
- guzzlehttp/guzzle: ^7.9
- monolog/monolog: ^3.7
This package is not auto-updated.
Last update: 2024-09-24 07:31:03 UTC
README
Cecula API客户端是一个简单的客户端,用于将您的PHP应用程序连接到Cecula消息平台,通过A2P通道或您的托管SIM发送短信。
方法
- sendSms(array $data) 向单个或多个收件人发送短信。
数据数组键
- recipients (array): 收件人手机号码数组。
- text (string): 消息内容。
- sender (string): 预注册的发送者名称。
示例
$data = [
'sender' => 'SENDER', // Note: this has to be pre-registered and approved
'recipients' => ['2348XXXXXXXXX', '2348XXXXXXXXX'],
'text' => 'Happy for another day',
];
响应:消息投递状态。sendBulkMessage(array $recipients, $message) 向多个收件人发送短信。
参数:$recipients (array): 电话号码列表。$message (string): 消息内容。响应:批量消息投递状态。getBalance() 获取发送短信的可用余额。
响应:Cecula平台上的当前短信余额。
如何使用
使用composer将Cecula API客户端导入您的应用程序。
composer require cecula/messaging-api
将库导入应用程序后,确保所有依赖项都已安装,请运行
composer install
然后您就可以开始了。
获取您的Cecula API密钥
要获取您的Cecula API密钥,请登录到Cecula消息平台。如果您还没有账户,您现在就可以创建一个。
登录到您的账户后,导航到设置菜单,那应该是您看到的第一项。复制实时或沙盒API密钥。
测试库
获取您的API密钥后,您现在可以测试运行该库。
在过程式PHP脚本中
<?php
use Cecula\MessagingApi\Messaging;
require_once __DIR__.'/vendor/autoload.php';
$messagingClient = new Messaging([
'apiKey' => 'paste-your-api-key-here'
]);
echo $messagingClient->getBalance();
$smsParams = [
'sender' => 'SENDER', // Note: this has to be pre-registered and approved
'recipients' => ['2348XXXXXXXXX'],
'text' => 'Happy for another day',
];
echo $messagingClient->sendSms($smsParams);
在类文件内部
如果您使用Laravel等框架,您可能会用到这些
<?php
use Cecula\MessagingApi\Messaging;
class ClassName
{
public function doSomething()
{
$messagingClient = new Messaging([
'apiKey' => 'paste-your-api-key-here'
]);
echo $messagingClient->getBalance();
$smsParams = [
'sender' => 'SENDER', // Note: this has to be pre-registered and approved
'recipients' => ['2348XXXXXXXXX'],
'text' => 'Happy for another day',
];
echo $messagingClient->sendSms($smsParams);
}
}
明白了!现在将其应用到您的应用程序中,构建消息功能。
如果您遇到困难,请发送邮件至lab@cecula.com - 我们会帮助您回到代码的世界。
干杯!!!