jccdbytes/sms-kit

一个用于通过API发送短信的简单库。

维护者

详细信息

github.com/jccd-dev/sms-kit

主页

源代码

问题

安装: 1

依赖: 0

建议者: 0

安全性: 0

星标: 0

关注者: 1

分支: 0

开放问题: 0

1.0.0 2023-09-28 04:12 UTC

Requires

Requires (Dev)

MIT ba47c3eb8a59c5b066ecbcbf4cec28bcf5c6159d

phphttpapilibrarysmsonewaysmssms-library

This package is auto-updated.

Last update: 2024-09-28 06:43:09 UTC

README

发送短信的简单库包

SMS Kit 是一个简单的PHP库，用于通过API发送短信。该库提供了一种简单易用的接口，用于通过您选择的短信网关向收件人发送短信。目前支持的API是 onewaysms

安装

    composer require jccdbytes/sms-kit

使用方法

设置配置

SMS Kit 允许您通过两种方式配置API凭证：

  1. 环境变量 默认情况下，SMS Kit 会查找项目中的 .env 文件中的配置值。您可以设置以下环境变量
  • 'SMS_API_USERNAME' : 您的API用户名
  • 'SMS_API_PASSWORD' : 您的API密码
  • 'SMS_SENDER' : 您的姓名或应用程序名称
  • 'GW_URL' : 短信网关的URL。

示例 .env 配置

    SMS_API_USERNAME=your_api_username
    SMS_API_PASSWORD=your_api_password
    SMS_SENDER=sender_name
    GW_URL=gateway_url
  1. 方法调用 或者，您可以通过在代码中调用以下方法来编程方式配置 SMS Kit：
  • '$apiUsername' : 您的API用户名
  • '$apiPassword' : 您的API密码
  • '$sender' : 您的姓名或应用程序名称
  • '$gwUrl' : 短信网关的URL。
    use Jccdbytes\SmsKit\SMS;
    $sms = new SMS();

    $sms->setConfig($apiUsername, $apiPassword, $sender, $gwUrl)

----或----

    $sms = new \Jccdbytes\SmsKit\SMS();

    $sms->setConfig($apiUsername, $apiPassword, $sender, $gwUrl)
其他配置
  1. 配置短信的语言类型。默认设置为数字 1 = 正常文本。您可以在 onewaysms 文档中找到与其等效语言类型的数字。
  • setLanguageType 方法只接受整数值（1, 2）
    $sms->setLanguageType(1);

发送短信

配置完成后，您可以使用 SMS Kit 向收件人发送短信。以下是一个示例

号码格式以 09 开头，后面跟 9 位数字，例如：09123456789

或

使用国家代码加 10 位数字（菲律宾使用 63）示例：639234567891

    $response = $sms->gw_send_sms('recipient_number', 'Your message');

返回类型是一个包含两个元素的关联数组。

  • message : 从库返回的消息
  • code : 0 和 1，其中 1 表示短信发送成功，0 表示短信未发送。未成功发送的短信也会返回一条消息及其API代码响应：您可以在 onewaysms 文档 PDF 中检查API响应代码的含义。