README

WEB2SMS SRL

WEB2SMS Composer

介绍

WEB2SMS PHP库提供了通过WEB2SMS API从任何用PHP语言编写的应用程序中发送短信的简单访问。

兼容性

PHP 5.7.0 - 8.0.8

安装

您可以通过Composer安装此库。运行以下命令

    composer require web2sms/sms

URLs

WEB2SMS平台 : https://www.web2sms.ro/
后付费端点 : https://www.web2sms.ro/send/message/
预付费端点 : https://www.web2sms.ro/prepaid/message/

操作

发送短信

要发送一条/一组短信，

预付费操作URL： /prepaid/message/
后付费操作URL： /send/message/
方法： POST

示例

    ...
    
    require_once('lib/sendSMS.php');
    use Web2sms\sendSMS;

    $sendSMS = new sendSMS();

    $sender->accountType = 'prepaid';                                 // postpaid | prepaid          // Optional
    $sendSMS->apiKey     = 'API_KEY_FROM_THE_PLATFORM';               // ApiKey from Platform        // Mandatory
    $sendSMS->secretKey  = 'SECRET_KEY_FROM_THE_PLATFORM';            // secretKey from Platform     // Mandatory

    // SMS #1
    $sendSMS->messages[]  = [
                        'sender'            => ''          ,          // who send the SMS             // Optional
                        'recipient'         => '07XXXXXXXX',          // who receive the SMS          // Mandatory
                        'body'              => 'This is the actual content of SMS nr one',            // Mandatory
                        'scheduleDatetime'  => 'YYYY-MM-DD 10:20:10', // Date & Time to send SMS      // Optional
                        'validityDatetime'  => null,                  // Date & Time of expire SMS    // Optional
                        'callbackUrl'       => 'DOMAIN/XXX/',         // Full callback URL            // Optional    
                        'userData'          => null,                  // User data                    // Optional
                        'visibleMessage'    => false                  // false / True                 // Optional
                        ];

    ...

    // SMS #N
    $sendSMS->messages[]  = [
                        'sender'            => ''          ,          // who send the SMS             // Optional
                        'recipient'         => '07XXXXXXXX',          // who receive the SMS          // Mandatory
                        'body'              => 'This is the actual content of SMS nr N'               // Mandatory
                        'scheduleDatetime'  => null,                  // Date & Time to send SMS      // Optional
                        'validityDatetime'  => null,                  // Date & Time of expire SMS    // Optional
                        'callbackUrl'       => 'DOMAIN/XXX/',         // Full callback URL            // Optional    
                        'userData'          => null,                  // User data                    // Optional
                        'visibleMessage'    => false                  // false / True                 // Optional
                        ];


    $sendSMS->setRequest();
    $sendSMS->sendSMS();

    ...

参数

accountType： "accountType"定义了您在WEB2SMS平台上的账户类型。WEB2SMS有两种账户类型，即“后付费”和“预付费”。默认账户类型为“预付费”。
apiKey： "apiKey"是您与WEB2SMS API工作的唯一ID，此参数为必填项。
secretKey： "secretKey"是您与WEB2SMS API工作的另一个唯一ID，此参数也是必填项。
messages： "messages"是您的实际短信。您可以定义要作为短信发送的单条消息，或定义一组要发送到目标的消息。如上例所示，列表中的任何消息都是独立的，可以有不同的配置、文本内容，甚至可以在不同的时间发送。
- sender： "sender"是实际发送短信到目标电话号码的实际号码。发送者是一个可选参数，目标电话号码上显示的号码将如平台中定义的那样。如果您在平台中有多个预定义的号码，则可以选择其中一个作为短信发送者。
- recipient： "recipient"是短信目标的实际电话号码。这是一个必填参数。
- body： "body"是短信的实际内容。这是一个必填参数。
- scheduleDatetime： 设置短信发送的日期和时间。通过设置此选项，您可以定义一条/一组在未来的任何时间间隔内发送的短信。此参数的格式为如示例所示的：Y-m-d H:i:s，例如：2021-12-01 08:59:30。此参数是可选的。
- validityDatetime： 设置短信发送的过期日期和时间。这是一个可选参数。
- callbackUrl： "callBackUrl"是您网站的URL，用于在将短信发送到目标后发送反馈，以通知每个单个短信。这是一个可选参数。
- userData： "userData"是由您提供的字符串，用于在WEB2SMS平台生成的报告中使用。此选项有助于对信息进行分类。例如，如果您为不同的活动发送了许多短信，则可以选择一个作为
- visibleMessage : “visibleMessage”选项用于在WEB2SMS平台中隐藏和显示短信内容，以保护敏感数据。您可以将此参数设置为 TRUE | FALSE。默认情况下，短信内容会显示在平台上。此参数是可选的。

错误代码定义

536870913 : 内部WEB2SMS错误
268435457 : 调用IP没有可用账户
268435463 : 关联账户已被禁用
268435462 : 关联账户配置错误
268435464 : 创建短信发送者时发生内部WEB2SMS错误
268435458 : 参数电话号码格式错误或属于未为关联账户配置的GSM网络！
268435466 : 电话号码被列入黑名单
268435520 : 电话号码属于未为关联账户配置的GSN网络
268435460 : 您已超出每月短信发送限额
268435488 : 您尝试在配置的时间间隔限制之外安排短信消息
268435459 : 参数消息为空！不允许空消息
268435465 : 安排短信时发生内部WEB2SMS错误

何时/为什么发送短信

如今，向客户发送短信有助于任何业务增加客户保留率。

此外，您还可以在其他场景中受益于发送短信。例如：* 用于您应用的/网站的成员的手机验证 * 用于双步验证 * 用于通知/提醒事件 * 等

navid59 / web2sms

维护者

详细信息