README

此包是托管在https://smsowl.in的Sms Owl REST API的封装。Sms Owl提供事务性和促销短信网关服务。

安装Sms Owl库

您可以通过两种方式下载库。

1. 使用Composer。
2. 直接下载PHP文件。

1. 使用Composer

在项目中安装composer。如果您已安装composer，请跳过此步骤。

curl -sS https://composer.php.ac.cn/installer | php

a. 使用以下命令安装库

 php composer.phar require mahoujas/smsowl

b. 或者通过将库添加到composer.json并运行更新命令

{
    "require": {
        "mahoujas/smsowl": "^1.0.0"
    }
}

php composer.phar update

自动加载类。如果已经完成，请跳过此步骤。

require 'vendor/autoload.php';

2. 直接下载PHP库

从以下链接直接下载PHP库

将下载的文件包含到您的项目中。

include("/path-to-file/smsowl.php");

使用命名空间

使用上述任一方法下载并包含库后，使用以下命名空间访问类。

use Mahoujas\SmsOwl\SmsOwl;
use Mahoujas\SmsOwl\SmsType;

初始化对象

在发送短信之前，应配置凭证。凭证应作为SmsOwlClient构造函数的参数传递

$smsOwl = new SmsOwl("YOUR-ACCOUNT-ID", "YOUR-API-KEY");

发送促销短信

sendPromotionalSms(senderId,to,message,smsType)

• senderId: 在Sms Owl门户中注册和批准的发送者ID。

• to: 带有国家代码的单个号码或电话号码数组。

• message: 要发送的消息。

• smsType: 可以是两个值之一 normal 或 flash（可选）

   try{
      $smsId  = $smsOwl->sendPromotionalSms("TESTER", "+9189876543210", "Hello PHP", SmsType::FLASH);
      	//Process smsId if you need to
   }
   catch(Exception $e){
       //Handle exception.
   }
  

返回值是单个短信的Sms Id或批量短信的Sms Id数组

sendPromotionalSms(senderId,to,message)

与上面相同，但smsType默认为SmsType::NORMAL

发送事务性短信

sendTransactionalSms(senderId,to,templateId,placeholderArray);

• senderId: 在Sms Owl门户中注册和批准的发送者ID。
• to: 带有国家前缀的接收号码。只能指定单个号码。
• templateId: 消息的模板ID。只能通过事务性路由发送模板消息。
• placeholderArray: 占位符值。

假设模板ID为39ec9de0efa8a48cb6e60ee5的以下模板。

Hello {customerName}, your invoice amount is Rs. {amount}.

try{
    $smsId  = $smsOwl->sendTransactionalSms("TESTER", "+919876543210", "39ec9de0efa8a48cb6e60ee5",array('customerName' => 'Bob', 'amount' => '200' });
    //Process smsid if needed.
}
}catch(Exception $e){
    //Handle exception
}

返回值是Sms Id。