web2sms/sms

一套库,便于使用PHP语言编写的任何应用程序通过WEB2SMS服务发送短信

v1.0.3 2022-09-13 13:53 UTC

This package is auto-updated.

Last update: 2024-08-27 17:17:07 UTC


README

Parsedown

WEB2SMS SRL

WEB2SMS Composer

介绍

WEB2SMS PHP库提供了一种简单的方式来从使用PHP语言编写的任何应用程序中通过WEB2SMS API发送短信。

如需更多信息,请随时联系我们 - contact@web2sms.ro

兼容性

PHP 5.7.0 - 8.0.8

安装

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

    composer require web2sms/sms

URLs

操作

  • 发送短信

    要发送一条或多条 SMS

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

    示例

        ...
        
        use Web2sms\Sms\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有两种账户类型,即 "postpaid""prepaid" 。默认账户类型为 prepaid

    • apiKey : "apiKey" 是您与WEB2SMS API交互的唯一标识符,此参数是必需的。

    • secretKey : "secretKey" 是您与WEB2SMS API交互的另一个唯一标识符,此参数也是必需的。

    • 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平台生成的报告中。此选项帮助您对信息进行分类。例如,如果您为不同的活动发送许多短信,您可以选择将事件标题作为userData以显示在报告中。

      • visibleMessage:“visibleMessage”选项用于在WEB2SMS平台中隐藏和显示短信内容,以保护敏感数据。您可以将此参数设置为TRUE | FALSE。默认情况下,短信内容会显示在平台上。此参数是可选的。

错误代码定义

  • 536870913:内部WEB2SMS错误

  • 268435457:没有可用的账户供调用IP使用

  • 268435463:关联账户已被禁用

  • 268435462:关联账户配置错误

  • 268435464:创建短信发送者时内部WEB2SMS错误

  • 268435458:参数电话号码格式错误或它属于未为关联账户配置的GSM网络!

  • 268435466:电话号码被列入黑名单

  • 268435520:电话号码属于未为关联账户配置的GSN网络

  • 268435460:您已超出每月短信发送限额

  • 268435488:您尝试在配置的时间间隔限制之外安排短信消息

  • 268435459:参数消息为空!不允许空消息

  • 268435465:安排短信时内部WEB2SMS错误

技术支持

邮箱:support@web2sms.ro

资源
WEB2SMS文档