Easy SMS

Initialize EasySms with a configuration array. The configuration includes a timeout for HTTP requests, a default section to define the gateway calling strategy and the list of gateways to use, and a gateways section containing the specific credentials for each provider.

To send a message, use the send method with the recipient's phone number and an array containing content, template, and data.

use Overtrue//EasySms\EasySms;

$config = [
    // HTTP request timeout in seconds
    'timeout' => 5.0,

    // Default sending configuration
    'default' => [
        // Gateway calling strategy, default: OrderStrategy
        'strategy' => \Overtrue\EasySms\Strategies\OrderStrategy::class,

        // Default available gateways
        'gateways' => [
            'yunpian', 'aliyun',
        ],
    ],
    // Configuration for available gateways
    'gateways' => [
        'errorlog' => [
            'file' => '/tmp/easy-sms.log',
        ],
        'yunpian' => [
            'api_key' => '824f0ff2f71cab52936axxxxxxxxxx',
        ],
        'aliyun' => [
            'access_key_id' => '',
            'access_key_secret' => '',
            'sign_name' => '',
        ],
        //...
    ],
];

$easySms = new EasySms($config);

$easySms->send(13188888888, [
    'content'  => '您的验证码为: 6379',
    'template' => 'SMS_001',
    'data' => [
        'code' => 6379
    ],
]);

Aliyun provides several gateway options. Most use template and data for content.

• Aliyun (Standard): Requires access_key_id, access_key_secret, and sign_name.
• Aliyun Rest: Requires app_key, app_secret_key, and sign_name.
• Aliyun International: Requires access_key_id, access_key_secret, and sign_name.
• Aliyun SMS Authentication (DYPNS): Requires access_key_id, access_key_secret, and sign_name. Note that sign_name cannot be customized for this service.

// Aliyun Standard
'aliyun' => [
    'access_key_id' => '',
    'access_key_secret' => '',
    'sign_name' => '',
],

// Aliyun Rest
'aliyunrest' => [
    'app_key' => '',
    'app_secret_key' => '',
    'sign_name' => '',
],

// Aliyun International
'aliyunintl' => [
    'access_key_id' => '',
    'access_key_secret' => '',
    'sign_name' => '',
],

// Aliyun SMS Authentication (DYPNS)
'aliyundypns' => [
    'access_key_id' => '',
    'access_key_secret' => '',
    'sign_name' => '',
],

Chuanglan offers two main modes:

1. Standard (Chuanglan): Uses content. Requires account, password, and optional intel_account/intel_password for international SMS. Use the channel option to switch between CHANNEL_VALIDATE_CODE (default) and CHANNEL_PROMOTION_CODE.
2. Chuanglan V1:
   • Normal SMS: Uses content. Requires account, password, and channel set to CHANNEL_NORMAL_CODE.
   • Variable SMS: Uses template and data. Requires channel set to CHANNEL_VARIABLE_CODE and data formatted as a specific string.

// Chuanglan (253 Cloud)
'chuanglan' => [
    'account' => '',
    'password' => '',
    'intel_account' => '',
    'intel_password' => '',
    'channel'  => \Overtrue\EasySms\Gateways\ChuanglanGateway::CHANNEL_VALIDATE_CODE,
    'sign' => '【通讯云】',
    'unsubscribe' => '回TD退订',
],

// Chuanglan V1 (Normal)
'chuanglanv1' => [
    'account' => '',
    'password' => '',
    'needstatus' => false,
    'channel' => \Overtrue\EasySms\Gateways\Chuanglanv1Gateway::CHANNEL_NORMAL_CODE,
],

// Chuanglan V1 (Variable)
'chuanglanv1' => [
    'account' => '',
    'password' => '',
    'needstatus' => false,
    'channel' => \Overtrue\EasySms\Gateways\Chuanglanv1Gateway::CHANNEL_VARIABLE_CODE,
],