toneflix-code/kudi-sms-php

KudiSMS的PHP包装器。

1.0.4 2024-02-05 13:18 UTC

This package is auto-updated.

Last update: 2024-09-06 01:52:51 UTC


README

Test & Lint Latest Stable Version Total Downloads Latest Unstable Version License PHP Version Require codecov

KudiSMS 文档

KudiSMS PHP是KudiSMS的PHP包装库。

快速开始

安装

composer require toneflix-code/kudi-sms-php

配置环境

用法

初始化

为了初始化,只需调用创建一个SmsSender类的新实例。

use ToneflixCode\KudiSmsPhp\SmsSender;

$instance = new SmsSender();

如果无法使用环境变量,您可以将您的发送者IDAPI密钥作为参数传递给实例。

use ToneflixCode\KudiSmsPhp\SmsSender;

$instance = new SmsSender('SenderID', 'APIKey');

发送OTP

调用带有接收者、otp、appnamecode和templatecode作为参数的sendOtp方法。

$instance->sendOtp(
    recipient: '0807...', 
    otp: string, 
    appnamecode: string, 
    templatecode: string
);

发送到单个号码

调用带有号码和消息作为参数的send方法。

$instance->send(
    recipient: '0807...', 
    message: string
);

发送到多个号码

调用带有号码数组和消息作为参数的sendBulk方法。

$instance->sendBulk(
    recipients: ['0807...', '0903...'], 
    message: string
);

企业短信

要使用企业端点发送,请在调用sendsendBulk方法之前调用链式coporate方法。

$instance->coporate()->send(
    recipient: '0807...', 
    message: string
);

初始化语音消息

为了初始化,只需调用创建一个VoiceSender类的新实例。

use ToneflixCode\KudiSmsPhp\VoiceSender;

$instance = new VoiceSender();

如果无法使用环境变量,您可以将您的Caller IDAPI密钥作为参数传递给实例。

use ToneflixCode\KudiSmsPhp\SmsSender;

$instance = new SmsSender('CallerId', 'APIKey');

发送语音消息

调用带有号码和有效音频文件URL作为参数的send方法。

$instance->send(
    to: '0807...', 
    url: string
);

发送语音到文本消息

调用带有号码和消息作为参数的tts方法。

$instance->tts(
    to: '0807...', 
    message: string
);

测试

$ composer test

所有测试都在tests目录中可用,大多数都是跳过的,因为该服务不是免费的,您也可以编写自己的测试。

贡献者

许可证

MIT许可证(MIT)。有关更多信息,请参阅许可证文件