Help Center/ Message & SMS/ Developer Guide/ Code Examples/ AK/SK Authentication (Recommended)/ PHP
Updated on 2024-07-03 GMT+08:00
View PDF
Share

PHP

Example

Example of Sending SMSs, Example of Sending SMSs in Batches

Receiving Status Reports

Environment

php-7.4.33-Win32-vc15-x64

Install the PHP plug-in (Oro PHPStorm Plugin) on IntelliJ IDEA (2021.1.3 version).

Download required SDKs and demos for PHP. Replace the content of the index.php file with the following code example.

  • 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.

Example of Sending SMSs

 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
 
<html>
<head>
    <title>Send SMS test</title>
</head>
<body>
<pre>
    <?php
    require 'signer.php';
    $signer = new Signer();
    // Hard-coded or plaintext appKey/appSecret is risky. For security, encrypt your appKey/appSecret and store them in the configuration file or environment variables.
    $signer->Key = 'c8RWg3ggEcyd4D3p94bf3Y7x1Ile';      // app key
    $signer->Secret = "q4Ii87Bh************80SfD7Al";   // app secret
    $req = new Request('POST', 'https://smsapi.ap-southeast-1.myhuaweicloud.com:443/sms/batchSendSms/v1');
    // Add header parameters
    $req->headers = array(
        'content-type' => 'application/x-www-form-urlencoded',
    );
    $req->body = 'from=csms12345678&to=%2B8615112346788&templateId=8ff55eac1d0b478ab3c06c3c6a492300&templateParas=["1"]&statusCallback=https://your.server.com/rest/callback/statusReport';
    $curl = $signer->Sign($req);
    curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, FALSE);
    curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, FALSE);
    curl_setopt($curl, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1);
    var_dump($req->headers);
    var_dump($req);
    echo "--------------\n";
    $response = curl_exec($curl);
    $status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
    if ($status == 0) {
        echo curl_error($curl);
    } else {
        echo $status . "\n";
        echo $response;
    }
    curl_close($curl);
    ?>
</pre>
</body>
</html>

Example of Sending SMSs in Batches

 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
 
<html>
<head>
    <title>Send Diff SMS test</title>
</head>
<body>
<pre>
    <?php
    require 'signer.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 (obtain it from the Application Management page on the console) 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'; //APP_Key
    $APP_SECRET = 'q4Ii87Bh************80SfD7Al'; //APP_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, +86151****6789. Use commas (,) to separate multiple numbers.
    $receiver_1 = ['+86151****6789', '+86152****7890']; // Recipient number of template 1
   $receiver_2 = ['+86151****6789', '+86152****7890']; // 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'].
     * To view more information, choose Service Overview > 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 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)
        ]
    ]);

    $signer = new Signer();
    $signer->Key = $APP_KEY;      // app key
    $signer->Secret = $APP_SECRET;   // app secret

    $req = new Request('POST', $url);
    // Add header parameters
    $req->headers = array(
        'content-type' => 'application/json',
    );
    $req->body = $data;
    $curl = $signer->Sign($req);
    curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, FALSE);
    curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, FALSE);
    curl_setopt($curl, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1);
    var_dump($req->headers);
    var_dump($req);
    echo "--------------\n";
    $response = curl_exec($curl);
    $status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
    if ($status == 0) {
        echo curl_error($curl);
    } else {
        echo $status . "\n";
        echo $response;
    }
    curl_close($curl);

    /**
     * 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];
    }

    ?>
</pre>
</body>
</html>

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;
    }
}
?>