Updated on 2024-07-03 GMT+08:00

PHP

Example

Sending SMSs (Example 1), Sending SMSs in Batches (Example 1)

Sending SMSs (Example 2), Sending SMSs in Batches (Example 2)

Receiving Status Reports

Environment

PHP 7.0 or later versions are required. The examples are developed based on PHP 7.2.9.

Dependency Configuration

Composer and Guzzle (only for example 1)

  1. Install and configure the Composer by following the instructions provided in https://getcomposer.org/download/.
  2. Create the composer.json file in the project folder. The content of the file is as follows:
    {
        "require": {
            "guzzlehttp/guzzle": "~6.0@dev"
        }
    }
  3. Open the CLI window, enter the project folder, and run composer install to install Guzzle.

    Note: After the installation is complete, the vendor/autoload.php file is automatically generated in the project folder.

  • Sending SMSs shows an example of sending group SMSs with a single template. Sending SMSs in batches shows an example of sending group SMSs with multiple templates.
  • The examples described in this document may involve the use of personal data. You are advised to comply with relevant laws and regulations and take measures to ensure that personal data is fully protected.
  • The examples described in this document are for demonstration purposes only. Commercial use of the examples is prohibited.
  • Information in this document is for your reference only. It does not constitute any offer or commitment.

Sending SMSs (Example 1)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
<?php
require 'vendor/autoload.php'; // This file is automatically generated when composer install is executed.

use GuzzleHttp\Psr7;
use GuzzleHttp\Client;
use GuzzleHttp\Exception\RequestException;

// Mandatory. The values here are example values only. Obtain the actual values based on Development Preparation.
$url = 'https://smsapi.ap-southeast-1.myhuaweicloud.com:443/sms/batchSendSms/v1'; // Application access address and API access URI
// Hard-coded or plaintext appKey/appSecret is risky. For security, encrypt your appKey/appSecret and store them in the configuration file or environment variables.
$APP_KEY = 'c8RWg3ggEcyd4D3p94bf3Y7x1Ile'; //Application&nbsp;Key
$APP_SECRET = 'q4Ii87Bh************80SfD7Al'; //Application&nbsp;Secret
$sender = 'csms12345678'; // Channel number for Chinese mainland SMS signature or international SMS
$TEMPLATE_ID = '8ff55eac1d0b478ab3c06c3c6a492300'; // Template ID

// Mandatory for Chinese mainland SMS. This parameter is valid and mandatory when Template Type corresponding to templateId is Universal template. The signature name must be approved and be the same type as the template.
// This parameter is not required for international SMS.
$signature = "Huawei Cloud SMS test"; // Signature

// Mandatory. Global number format (including the country code), for example, +8615123456789. Use commas (,) to separate multiple numbers.
$receiver = '+8615123456789,+8615234567890'; // Recipient numbers

// Optional. Address for receiving SMS status reports. The domain name is recommended. If this parameter is set to an empty value or left unspecified, customers do not receive status reports.
$statusCallback = '';

/**
 * Optional. If a template with no variable is used, assign an empty value to this parameter, for example, $TEMPLATE_PARAS = '';
 * Example of a single-variable template: If the template content is "Your verification code is ${NUM_6}", $TEMPLATE_PARAS can be set to '["369751"]'.
 * Example of a dual-variable template: If the template content is "You have ${NUM_2} parcels delivered to ${TXT_20}", $TEMPLATE_PARAS can be set to '["3","main gate of People's Park"]'.
 * For details, see Template and Variable Specifications.
 * @var string $TEMPLATE_PARAS
 */
$TEMPLATE_PARAS = '["369751"]'; // Template variable. The following uses a single-variable verification code SMS message as an example. The customer needs to generate a 6-digit verification code and define it as a character string to prevent the loss of first digits 0 (for example, 002569 is changed to 2569).

$client = new Client();
try {
    $response = $client->request('POST', $url, [
        'form_params' => [
            'from' => $sender,
            'to' => $receiver,
            'templateId' => $TEMPLATE_ID,
            'templateParas' => $TEMPLATE_PARAS,
            'statusCallback' => $statusCallback,
//            'signature' => $signature // Uncomment this line if the universal template for Chinese mainland SMS is used.
        ],
        'headers' => [
            'Authorization' => 'WSSE realm="SDP",profile="UsernameToken",type="Appkey"',
            'X-WSSE' => buildWsseHeader($APP_KEY, $APP_SECRET)
        ],
        'verify' => false // Ignore the certificate trust issues to prevent API calling failures caused by HTTPS certificate authentication failures.
    ]);
    echo Psr7\str($response); // Record the response data.
} catch (RequestException $e) {
    echo $e;
    echo Psr7\str($e->getRequest()), "\n";
    if ($e->hasResponse()) {
        echo Psr7\str($e->getResponse());
    }
}

/**
 * Construct the value of X-WSSE.
 * @param string $appKey
 * @param string $appSecret
 * @return string
 */
function buildWsseHeader(string $appKey, string $appSecret){
    $now = date('Y-m-d\TH:i:s\Z'); //Created
    $nonce = uniqid(); //Nonce
    $base64 = base64_encode(hash('sha256', ($nonce . $now . $appSecret))); //PasswordDigest
    return sprintf("UsernameToken Username=\"%s\",PasswordDigest=\"%s\",Nonce=\"%s\",Created=\"%s\"",
        $appKey, $base64, $nonce, $now);
}
?>

Sending SMSs (Example 2)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
<?php
// Mandatory. The values here are example values only. Obtain the actual values based on Development Preparation.
$url = 'https://smsapi.ap-southeast-1.myhuaweicloud.com:443/sms/batchSendSms/v1'; // Application access address and API access URI
// Hard-coded or plaintext appKey/appSecret is risky. For security, encrypt your appKey/appSecret and store them in the configuration file or environment variables.
$APP_KEY = 'c8RWg3ggEcyd4D3p94bf3Y7x1Ile'; //Application&nbsp;Key
$APP_SECRET = 'q4Ii87Bh************80SfD7Al'; //Application&nbsp;Secret
$sender = 'csms12345678'; // Channel number for Chinese mainland SMS signature or international SMS
$TEMPLATE_ID = '8ff55eac1d0b478ab3c06c3c6a492300'; // Template ID

// Mandatory for Chinese mainland SMS. This parameter is valid and mandatory when Template Type corresponding to templateId is Universal template. The signature name must be approved and be the same type as the template.
// This parameter is not required for international SMS.
$signature = "Huawei Cloud SMS test"; // Signature

// Mandatory. Global number format (including the country code), for example, +8615123456789. Use commas (,) to separate multiple numbers.
$receiver = '+8615123456789,+8615234567890'; // Recipient numbers

// Optional. Address for receiving SMS status reports. The domain name is recommended. If this parameter is set to an empty value or left unspecified, customers do not receive status reports.
$statusCallback = '';

/**
 * Optional. If a template with no variable is used, assign an empty value to this parameter, for example, $TEMPLATE_PARAS = '';
 * Example of a single-variable template: If the template content is "Your verification code is ${NUM_6}", $TEMPLATE_PARAS can be set to '["369751"]'.
 * Example of a dual-variable template: If the template content is "You have ${NUM_2} parcels delivered to ${TXT_20}", $TEMPLATE_PARAS can be set to '["3","main gate of People's Park"]'.
 * For details, see Template and Variable Specifications.
 * @var string $TEMPLATE_PARAS
 */
$TEMPLATE_PARAS = '["369751"]'; // Template variable. The following uses a single-variable verification code SMS message as an example. The customer needs to generate a 6-digit verification code and define it as a character string to prevent the loss of first digits 0 (for example, 002569 is changed to 2569).

// Request headers
$headers = [
    'Content-Type: application/x-www-form-urlencoded',
    'Authorization: WSSE realm="SDP",profile="UsernameToken",type="Appkey"',
    'X-WSSE: ' . buildWsseHeader($APP_KEY, $APP_SECRET)
];
// Request body
$data = http_build_query([
    'from' => $sender,
    'to' => $receiver,
    'templateId' => $TEMPLATE_ID,
    'templateParas' => $TEMPLATE_PARAS,
    'statusCallback' => $statusCallback,
//    'signature' => $signature // Uncomment this line if the universal template for Chinese mainland SMS is used.
]);

$context_options = [
    'http' => ['method' => 'POST', 'header'=> $headers, 'content' => $data, 'ignore_errors' => true],
    'ssl' => ['verify_peer' => false, 'verify_peer_name' => false] // Ignore the certificate trust issues to prevent API calling failures caused by HTTPS certificate authentication failures.
];
print_r($context_options) . PHP_EOL; // Record the request.

$response = file_get_contents($url, false, stream_context_create($context_options));
print_r($response) . PHP_EOL; // Record the response.

/**
 * Construct the value of X-WSSE.
 * @param string $appKey
 * @param string $appSecret
 * @return string
 */
function buildWsseHeader(string $appKey, string $appSecret){
    date_default_timezone_set('Asia/Shanghai');
    $now = date('Y-m-d\TH:i:s\Z'); //Created
    $nonce = uniqid(); //Nonce
    $base64 = base64_encode(hash('sha256', ($nonce . $now . $appSecret))); //PasswordDigest
    return sprintf("UsernameToken Username=\"%s\",PasswordDigest=\"%s\",Nonce=\"%s\",Created=\"%s\"",
        $appKey, $base64, $nonce, $now);
}
?>

Sending SMSs in Batches (Example 1)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
<?php
require 'vendor/autoload.php'; // This file is automatically generated when composer install is executed.

use GuzzleHttp\Psr7;
use GuzzleHttp\Client;
use GuzzleHttp\Exception\RequestException;

// Mandatory. The values here are example values only. Obtain the actual values based on Development Preparation.
$url = 'https://smsapi.ap-southeast-1.myhuaweicloud.com:443/sms/batchSendDiffSms/v1'; // Application access address and API access URI
// Hard-coded or plaintext appKey/appSecret is risky. For security, encrypt your appKey/appSecret and store them in the configuration file or environment variables.
$APP_KEY = 'c8RWg3ggEcyd4D3p94bf3Y7x1Ile'; //Application&nbsp;Key
$APP_SECRET = 'q4Ii87Bh************80SfD7Al'; //Application&nbsp;Secret
$sender = 'csms12345678'; // Channel number for Chinese mainland SMS signature or international SMS
$TEMPLATE_ID_1 = '8ff55eac1d0b478ab3c06c3c6a492300'; // Template ID 1
$TEMPLATE_ID_2 = '8ff55eac1d0b478ab3c06c3c6a492300'; // Template ID 2

// Mandatory for Chinese mainland SMS. This parameter is valid and mandatory when Template Type corresponding to templateId is Universal template. The signature name must be approved and be the same type as the template.
// This parameter is not required for international SMS.
$signature_1 = "Huawei Cloud SMS test"; // Signature 1
 $signature_2 = "Huawei Cloud SMS test"; // Signature 2

// Mandatory. Global number format (including the country code), for example, +8615123456789. Use commas (,) to separate multiple numbers.
$receiver_1 = ['+8615123456789', '+8615234567890']; // Recipient number of template 1
$receiver_2 = ['+8615123456789', '+8615234567890']; // Recipient number of template 2

// Optional. Address for receiving SMS status reports. The domain name is recommended. If this parameter is set to an empty value or left unspecified, customers do not receive status reports.
$statusCallback = '';

/**
 * Optional. If a template with no variable is used, assign an empty value to this parameter, for example, $TEMPLATE_PARAS = [];
 * Example of a single-variable template: If the template content is "Your verification code is ${NUM_6}", $TEMPLATE_PARAS can be set to ['369751'].
 * Example of a dual-variable template: If the template content is "You have ${NUM_2} parcels delivered to ${TXT_20}", $TEMPLATE_PARAS can be set to ['3','main gate of People's Park'].
 * For details, see Template and Variable Specifications.
 */
$TEMPLATE_PARAS_1 = ['123456']; // Template 1 variable. The following uses a single-variable verification code SMS message as an example. The customer needs to generate a 6-digit verification code and define it as a character string to prevent the loss of first digits 0 (for example, 002569 is changed to 2569).
$TEMPLATE_PARAS_2 = ['234567']; // Template 2 variable. The following uses a single-variable verification code SMS message as an example. The customer needs to generate a 6-digit verification code and define it as a character string to prevent the loss of first digits 0 (for example, 002569 is changed to 2569).

// Mandatory. Set variables based on the number of template IDs.
$smsContent = [
    // smsContent. If the signature name is not required, set signature to ''.
    initDiffSms($receiver_1, $TEMPLATE_ID_1, $TEMPLATE_PARAS_1, $signature_1),
    initDiffSms($receiver_2, $TEMPLATE_ID_2, $TEMPLATE_PARAS_2, $signature_2)
];

$client = new Client();
try {
    $response = $client->request('POST', $url, [
        'body' => json_encode([
            'from' => $sender,
            'statusCallback' => $statusCallback,
            'smsContent' => $smsContent
        ]),
        'headers' => [
            'Authorization' => 'WSSE realm="SDP",profile="UsernameToken",type="Appkey"',
            'X-WSSE' => buildWsseHeader($APP_KEY, $APP_SECRET),
            'Content-Type' => 'application/json'
        ],
        'verify' => false // Ignore the certificate trust issues to prevent API calling failures caused by HTTPS certificate authentication failures.
    ]);
    echo Psr7\str($response); // Record the response data.
} catch (RequestException $e) {
    echo $e;
    echo Psr7\str($e->getRequest()), "\n";
    if ($e->hasResponse()) {
        echo Psr7\str($e->getResponse());
    }
}

/**
 * Construct the value of smsContent.
 * @param array $receiver
 * @param string $templateId
 * @param array $templateParas
 * @param string $signature | Signature name, which must be specified when the universal template for Chinese mainland SMS is used.
 * @return string[]
 */
function initDiffSms(array $receiver, string $templateId, array $templateParas, string $signature) {
    if (null != $signature && strlen($signature) > 0) {
        return ['to' => $receiver, 'templateId' => $templateId, 'templateParas' => $templateParas, 'signature' => $signature];
    }
    return ['to' => $receiver, 'templateId' => $templateId, 'templateParas' => $templateParas];
}

/**
 * Construct the value of X-WSSE.
 * @param string $appKey
 * @param string $appSecret
 * @return string
 */
function buildWsseHeader(string $appKey, string $appSecret){
    $now = date('Y-m-d\TH:i:s\Z'); //Created
    $nonce = uniqid();  //Nonce
    $base64 = base64_encode(hash('sha256', ($nonce . $now . $appSecret))); //PasswordDigest
    return sprintf("UsernameToken Username=\"%s\",PasswordDigest=\"%s\",Nonce=\"%s\",Created=\"%s\"",
        $appKey, $base64, $nonce, $now);
}
?>

Sending SMSs in Batches (Example 2)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
<?php
// Mandatory. The values here are example values only. Obtain the actual values based on Development Preparation.
$url = 'https://smsapi.ap-southeast-1.myhuaweicloud.com:443/sms/batchSendDiffSms/v1'; // Application access address and API access URI
$APP_KEY = 'c8RWg3ggEcyd4D3p94bf3Y7x1Ile'; //Application&nbsp;Key
// Hard-coded or plaintext appKey/appSecret is risky. For security, encrypt your appKey/appSecret and store them in the configuration file or environment variables.
$APP_SECRET = 'q4Ii87Bh************80SfD7Al'; //Application&nbsp;Secret
$sender = 'csms12345678'; // Channel number for Chinese mainland SMS signature or international SMS
$TEMPLATE_ID_1 = '8ff55eac1d0b478ab3c06c3c6a492300'; // Template ID 1
$TEMPLATE_ID_2 = '8ff55eac1d0b478ab3c06c3c6a492300'; // Template ID 2

// Mandatory for Chinese mainland SMS. This parameter is valid and mandatory when Template Type corresponding to templateId is Universal template. The signature name must be approved and be the same type as the template.
// This parameter is not required for international SMS.
$signature_1 = "Huawei Cloud SMS test"; // Signature 1
 $signature_2 = "Huawei Cloud SMS test"; // Signature 2

// Mandatory. Global number format (including the country code), for example, +8615123456789. Use commas (,) to separate multiple numbers.
$receiver_1 = ['+8615123456789', '+8615234567890']; // Recipient number of template 1
$receiver_2 = ['+8615123456789', '+8615234567890']; // Recipient number of template 2

// Optional. Address for receiving SMS status reports. The domain name is recommended. If this parameter is set to an empty value or left unspecified, customers do not receive status reports.
$statusCallback = '';

/**
 * Optional. If a template with no variable is used, assign an empty value to this parameter, for example, $TEMPLATE_PARAS = [];
 * Example of a single-variable template: If the template content is "Your verification code is ${NUM_6}", $TEMPLATE_PARAS can be set to ['369751'].
 * Example of a dual-variable template: If the template content is "You have ${NUM_2} parcels delivered to ${TXT_20}", $TEMPLATE_PARAS can be set to ['3','main gate of People's Park'].
 * For details, see Template and Variable Specifications.
 */
$TEMPLATE_PARAS_1 = ['123456']; // Template 1 variable. The following uses a single-variable verification code SMS message as an example. The customer needs to generate a 6-digit verification code and define it as a character string to prevent the loss of first digits 0 (for example, 002569 is changed to 2569).
$TEMPLATE_PARAS_2 = ['234567']; // Template 2 variable. The following uses a single-variable verification code SMS message as an example. The customer needs to generate a 6-digit verification code and define it as a character string to prevent the loss of first digits 0 (for example, 002569 is changed to 2569).

// Request headers
$headers = [
    'Content-Type: application/json',
    'Authorization: WSSE realm="SDP",profile="UsernameToken",type="Appkey"',
    'X-WSSE: ' . buildWsseHeader($APP_KEY, $APP_SECRET)
];
// Request body
$data = json_encode([
    'from' => $sender,
    'statusCallback' => $statusCallback,
    'smsContent' => [// Mandatory. Set the parameters based on the number of template IDs.
        // smsContent. If the signature name is not required, set signature to ''.
        initDiffSms($receiver_1, $TEMPLATE_ID_1, $TEMPLATE_PARAS_1, $signature_1),
        initDiffSms($receiver_2, $TEMPLATE_ID_2, $TEMPLATE_PARAS_2, $signature_2)
    ]
]);

$context_options = [
    'http' => ['method' => 'POST', 'header'=> $headers, 'content' => $data, 'ignore_errors' => true],
    'ssl' => ['verify_peer' => false, 'verify_peer_name' => false] // Ignore the certificate trust issues to prevent API calling failures caused by HTTPS certificate authentication failures.
];
print_r($context_options) . PHP_EOL; // Record the request.

$response = file_get_contents($url, false, stream_context_create($context_options));
print_r($response) . PHP_EOL; // Record the response.

/**
 * Construct the value of smsContent.
 * @param array $receiver
 * @param string $templateId
 * @param array $templateParas
 * @param string $signature | Signature name, which must be specified when the universal template for Chinese mainland SMS is used.
 * @return string[]
 */
function initDiffSms(array $receiver, string $templateId, array $templateParas, string $signature) {
    if (null != $signature && strlen($signature) > 0) {
        return ['to' => $receiver, 'templateId' => $templateId, 'templateParas' => $templateParas, 'signature' => $signature];
    }
    return ['to' => $receiver, 'templateId' => $templateId, 'templateParas' => $templateParas];
}

/**
 * Construct the value of X-WSSE.
 * @param string $appKey
 * @param string $appSecret
 * @return string
 */
function buildWsseHeader(string $appKey, string $appSecret){
    date_default_timezone_set('Asia/Shanghai');
    $now = date('Y-m-d\TH:i:s\Z'); //Created
    $nonce = uniqid(); //Nonce
    $base64 = base64_encode(hash('sha256', ($nonce . $now . $appSecret))); //PasswordDigest
    return sprintf("UsernameToken Username=\"%s\",PasswordDigest=\"%s\",Nonce=\"%s\",Created=\"%s\"",
        $appKey, $base64, $nonce, $now);
}
?>

Receiving Status Reports

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
<?php
// Data example (urlencode) of the status report reported by the SMS platform
// $success_body = 'sequence=1&total=1&updateTime=2018-10-31T08%3A43%3A41Z&source=2&smsMsgId=2ea20735-f856-4376-afbf-570bd70a46ee_11840135&status=DELIVRD';
$failed_body = 'orgCode=E200027&sequence=1&total=1&updateTime=2018-10-31T08%3A43%3A41Z&source=2&smsMsgId=2ea20735-f856-4376-afbf-570bd70a46ee_11840135&status=RTE_ERR';

// onSmsStatusReport($success_body);
onSmsStatusReport($failed_body);

/**
 * Parse the status report data.
 *
 * @param string $data: Status report data reported by the SMS platform
 */
function onSmsStatusReport(string $data)
{
    $keyValues = [];
    parse_str(urldecode($data), $keyValues); // Parse the status report data.

    /**
     * Example: Parsing status is used as an example. 
     *
     * 'smsMsgId': Unique ID of an SMS
     * 'total': Number of SMS segments
     * 'sequence': Sequence number of an SMS after splitting
     * 'source': Status report source
     * 'updateTime': Resource update time
     * 'status': Enumeration values of the status report
     * 'orgCode': Status code
     */
    $status = $keyValues['status']; // Enumerated values of the status report
    // Check whether the SMS is successfully sent based on the value of status.
    if ('DELIVRD' === strtoupper($status)) {
        print 'Send sms success. smsMsgId: ' . $keyValues['smsMsgId'] . PHP_EOL;
    } else {
        // The SMS fails to be sent. The values of status and orgCode are recorded.
        print 'Send sms failed. smsMsgId: ' . $keyValues['smsMsgId'] . PHP_EOL;
        print 'Failed status: ' . $status . PHP_EOL;
        print 'Failed orgCode: ' . $keyValues['orgCode'] . PHP_EOL;
    }
}
?>