tencent cloud

Feedback

SDK for PHP

Last updated: 2024-05-20 18:24:32
    SDK 3.0 is a companion tool for the TencentCloud API 3.0 platform. You can use all SMS APIs through the SDK. The new SDK version is unified and features the same SDK usage, API call methods, error codes, and returned packet formats for different programming languages.
    Note:
    API version required for connecting to Tencent Cloud International:
    SMS API v2021-01-11 is required. For details, see the sample code.
    SMS sending APIs:
    One message can be sent to up to 200 numbers at a time.
    Signature and body template APIs:
    Individual users have no permission to use signature and body template APIs and can manage SMS signatures and SMS body templates only in the SMS console. To use the APIs, change "Individual Identity" to "Organizational Identity".

    Prerequisites

    You have learned about the concept of region and selected a region as needed.
    You have activated SMS. For detailed directions, please see Getting Started.
    You have prepared the dependent environment: PHP 5.6.33 or above.
    You have obtained the SecretID and SecretKey on the API Key Management page in the CAM console.
    SecretID is used to identify the API caller.
    SecretKey is used to encrypt the string to sign that can be verified on the server. You should keep it private and avoid disclosure.
    The endpoint of the SMS service is sms.tencentcloudapi.com.

    Relevant Documents

    For more information on the APIs and their parameters, please see API Documentation.
    You can download the SDK source code from Github Repository.

    Installing SDK

    Installing via Composer

    See Github repository:Installing via Composer

    Sample Code

    Note:
    All samples are for reference only and cannot be directly compiled and executed. You need to modify them based on your actual needs. You can also use API 3.0 Explorer to automatically generate the demo code as needed.
    Each API has a corresponding request structure and a response structure. This document only lists the sample code of several common features as shown below:

    Sending SMS message

    <?php
    require_once '/path/to/vendor/autoload.php';
    // Import the client of the corresponding product module
    use TencentCloud\\Sms\\V20210111\\SmsClient;
    // Import the `Request` class corresponding to the request API
    use TencentCloud\\Sms\\V20210111\\Models\\SendSmsRequest;
    use TencentCloud\\Common\\Exception\\TencentCloudSDKException;
    use TencentCloud\\Common\\Credential;
    // Import the optional configuration classes
    use TencentCloud\\Common\\Profile\\ClientProfile;
    use TencentCloud\\Common\\Profile\\HttpProfile;
    
    try {
    /* Required steps:
    * Instantiate an authentication object. The Tencent Cloud account key pair `secretId` and `secretKey` need to be passed in as the input parameters.
    * The example here uses the way to read from the environment variable, so you need to set these two values in the environment variable first.
    * You can also write the key pair directly into the code, but be careful not to copy, upload, or share the code to others;
    * otherwise, the key pair may be leaked, causing damage to your properties.
    * Query the CAM key: https://console.tencentcloud.com/cam/capi*/
    
    $cred = new Credential("xxx", "xxx");
    //$cred = new Credential(getenv("TENCENTCLOUD_SECRET_ID"), getenv("TENCENTCLOUD_SECRET_KEY"));
    
    // (Optional) Instantiate an HTTP option
    $httpProfile = new HttpProfile();
    // Configure the proxy
    // $httpProfile->setProxy("https://ip:port");
    $httpProfile->setReqMethod("GET"); // POST request (POST request by default)
    $httpProfile->setReqTimeout(30); // Request timeout period in seconds (60 seconds by default)
    $httpProfile->setEndpoint("sms.tencentcloudapi.com"); // Specify the access region domain name (nearby access by default)
    
    // Instantiate a client option (optional; skip if no special requirements are present)
    $clientProfile = new ClientProfile();
    $clientProfile->setSignMethod("TC3-HMAC-SHA256"); // Specify the signature algorithm (`HmacSHA256` by default)
    $clientProfile->setHttpProfile($httpProfile);
    
    // Instantiate the client object of the requested product (with SMS as an example). `clientProfile` is optional
    // The second parameter is the information on the region you select in Tencent Cloud International. If you select Singapore, you should enter the string `ap-singapore`. Click https://www.tencentcloud.com/document/api/382/40466?lang=en#region-list to view the region list.
    $client = new SmsClient($cred, "ap-singapore", $clientProfile);
    
    // Instantiate an SMS message sending request object. Each API corresponds to a request object
    $req = new SendSmsRequest();
    
    /* Populate the request parameters. Here, the member variables of the request object are the input parameters of the corresponding API
    * You can view the definition of the request parameters in the API documentation at the official website or by redirecting to the definition of the request object
    * Settings of a basic parameter:
    * Help link:
    * SMS console: https://console.tencentcloud.com/smsv2
    * sms helper: https://www.tencentcloud.com/document/product/382/3773?from_cn_redirect=1 */
    
    /* SMS application ID, which is the `SdkAppId` generated after an application is added in the [SMS console], such as 1400006666 */
    $req->SmsSdkAppId = "1400787878";
    /* SMS signature content, which should be encoded in UTF-8. You must enter an approved signature, which can be viewed in the [SMS console] */
    $req->SignName = "xxx";
    /* SMS code number extension, which is not activated by default. If you need to activate it, please contact [SMS Helper] */
    $req->ExtendCode = "";
    /* Target mobile number in the E.164 standard (+[country/region code][mobile number])
    * Example: +8613711112222, which has a + sign followed by 86 (country/region code) and then by 13711112222 (mobile number). Up to 200 mobile numbers are supported */
    $req->PhoneNumberSet = array("+8613711112222");
    /* `SenderId` for Global SMS, which is not activated by default. If you need to activate it, please contact [SMS Helper] for assistance. This parameter should be left empty for Mainland China SMS */
    $req->SenderId = "";
    /* User session content, which can carry context information such as user-side ID and will be returned as-is by the server */
    $req->SessionContext = "xxx";
    /* Template ID. You must enter the ID of an approved template, which can be viewed in the [SMS console] */
    $req->TemplateId = "449739";
    /* Template parameters. If there are no template parameters, leave it empty */
    $req->TemplateParamSet = array("0");
    
    
    // Initialize the request by calling the `SendSms` method on the client object. Note: the request method name corresponds to the request object
    // The returned `resp` is an instance of the `SendSmsResponse` class which corresponds to the request object
    $resp = $client->SendSms($req);
    
    // A string return packet in JSON format is output
    print_r($resp->toJsonString());
    
    // You can also take a single value
    // You can view the definition of the return field in the API documentation at the official website or by redirecting to the definition of the response object
    print_r($resp->TotalCount);
    }
    catch(TencentCloudSDKException $e) {
    echo $e;
    }

    Pulling receipt status

    <?php
    require_once '/path/to/vendor/autoload.php';
    // Import the client of the corresponding product module
    use TencentCloud\\Sms\\V20210111\\SmsClient;
    // Import the `Request` class corresponding to the request API
    use TencentCloud\\Sms\\V20210111\\Models\\PullSmsSendStatusRequest;
    use TencentCloud\\Common\\Exception\\TencentCloudSDKException;
    use TencentCloud\\Common\\Credential;
    // Import the optional configuration classes
    use TencentCloud\\Common\\Profile\\ClientProfile;
    use TencentCloud\\Common\\Profile\\HttpProfile;
    
    try {
    /* Required steps:
    * Instantiate an authentication object. The Tencent Cloud account key pair `secretId` and `secretKey` need to be passed in as the input parameters.
    * The example here uses the way to read from the environment variable, so you need to set these two values in the environment variable first.
    * You can also write the key pair directly into the code, but be careful not to copy, upload, or share the code to others;
    * otherwise, the key pair may be leaked, causing damage to your properties.
    * Query the CAM key: https://console.tencentcloud.com/cam/capi*/
    
    $cred = new Credential("xxx", "xxx");
    //$cred = new Credential(getenv("TENCENTCLOUD_SECRET_ID"), getenv("TENCENTCLOUD_SECRET_KEY"));
    
    // (Optional) Instantiate an HTTP option
    $httpProfile = new HttpProfile();
    // Configure the proxy
    // $httpProfile->setProxy("https://ip:port");
    $httpProfile->setReqMethod("GET"); // POST request (POST request by default)
    $httpProfile->setReqTimeout(30); // Request timeout period in seconds (60 seconds by default)
    $httpProfile->setEndpoint("sms.tencentcloudapi.com"); // Specify the access region domain name (nearby access by default)
    
    // Instantiate a client option (optional; skip if no special requirements are present)
    $clientProfile = new ClientProfile();
    $clientProfile->setSignMethod("TC3-HMAC-SHA256"); // Specify the signature algorithm (`HmacSHA256` by default)
    $clientProfile->setHttpProfile($httpProfile);
    
    // Instantiate the client object of the requested product (with SMS as an example). `clientProfile` is optional
    // The second parameter is the information on the region you select in Tencent Cloud International. If you select Singapore, you should enter the string `ap-singapore`. Click https://www.tencentcloud.com/document/api/382/40466?lang=en#region-list to view the region list.
    $client = new SmsClient($cred, "ap-singapore", $clientProfile);
    
    // Instantiate an SMS message sending request object. Each API corresponds to a request object
    $req = new PullSmsSendStatusRequest();
    
    /* Populate the request parameters. Here, the member variables of the request object are the input parameters of the corresponding API
    * You can view the definition of the request parameters in the API documentation at the official website or by redirecting to the definition of the request object
    * Settings of a basic parameter:
    * Help link:
    * SMS console: https://console.tencentcloud.com/sms/smslist
    * sms helper: https://www.tencentcloud.com/document/product/382/3773?from_cn_redirect=1 */
    
    /* SMS application ID, which is the `SdkAppId` generated after an application is added in the [SMS console], such as 1400006666 */
    $req->SmsSdkAppId = "1400787878";
    /* Maximum number of pulled entries. Maximum value: 100 */
    $req->Limit = 10;
    
    
    // Initialize the request by calling the `PullSmsSendStatus` method on the client object. Note: the request method name corresponds to the request object
    // The returned `resp` is an instance of the `PullSmsSendStatusResponse` class which corresponds to the request object
    $resp = $client->PullSmsSendStatus($req);
    
    // A string return packet in JSON format is output
    print_r($resp->toJsonString());
    
    // You can also take a single value
    // You can view the definition of the return field in the API documentation at the official website or by redirecting to the definition of the response object
    print_r($resp->TotalCount);
    }
    catch(TencentCloudSDKException $e) {
    echo $e;
    }

    Collecting SMS message sending data

    <?php
    require_once '/path/to/vendor/autoload.php';
    // Import the client of the corresponding product module
    use TencentCloud\\Sms\\V20210111\\SmsClient;
    // Import the `Request` class corresponding to the request API
    use TencentCloud\\Sms\\V20210111\\Models\\SendStatusStatisticsRequest;
    use TencentCloud\\Common\\Exception\\TencentCloudSDKException;
    use TencentCloud\\Common\\Credential;
    // Import the optional configuration classes
    use TencentCloud\\Common\\Profile\\ClientProfile;
    use TencentCloud\\Common\\Profile\\HttpProfile;
    
    try {
    /* Required steps:
    * Instantiate an authentication object. The Tencent Cloud account key pair `secretId` and `secretKey` need to be passed in as the input parameters.
    * The example here uses the way to read from the environment variable, so you need to set these two values in the environment variable first.
    * You can also write the key pair directly into the code, but be careful not to copy, upload, or share the code to others;
    * otherwise, the key pair may be leaked, causing damage to your properties.
    * Query the CAM key: https://console.tencentcloud.com/cam/capi*/
    
    $cred = new Credential("xxx", "xxx");
    //$cred = new Credential(getenv("TENCENTCLOUD_SECRET_ID"), getenv("TENCENTCLOUD_SECRET_KEY"));
    
    // (Optional) Instantiate an HTTP option
    $httpProfile = new HttpProfile();
    // Configure the proxy
    // $httpProfile->setProxy("https://ip:port");
    $httpProfile->setReqMethod("GET"); // POST request (POST request by default)
    $httpProfile->setReqTimeout(30); // Request timeout period in seconds (60 seconds by default)
    $httpProfile->setEndpoint("sms.tencentcloudapi.com"); // Specify the access region domain name (nearby access by default)
    
    // Instantiate a client option (optional; skip if no special requirements are present)
    $clientProfile = new ClientProfile();
    $clientProfile->setSignMethod("TC3-HMAC-SHA256"); // Specify the signature algorithm (`HmacSHA256` by default)
    $clientProfile->setHttpProfile($httpProfile);
    
    // Instantiate the client object of the requested product (with SMS as an example). `clientProfile` is optional
    // The second parameter is the information on the region you select in Tencent Cloud International. If you select Singapore, you should enter the string `ap-singapore`. Click https://www.tencentcloud.com/document/api/382/40466?lang=en#region-list to view the region list.
    $client = new SmsClient($cred, "ap-singapore", $clientProfile);
    
    // Instantiate an SMS message sending request object. Each API corresponds to a request object
    $req = new SendStatusStatisticsRequest();
    
    /* Populate the request parameters. Here, the member variables of the request object are the input parameters of the corresponding API
    * You can view the definition of the request parameters in the API documentation at the official website or by redirecting to the definition of the request object
    * Settings of a basic parameter:
    * Help link:
    * SMS console: https://console.tencentcloud.com/smsv2
    * sms helper: https://www.tencentcloud.com/document/product/382/3773?from_cn_redirect=1 */
    
    /* SMS application ID, which is the `SdkAppId` generated after an application is added in the [SMS console], such as 1400006666 */
    $req->SmsSdkAppId = "1400787878";
    /* Maximum number of pulled entries. Maximum value: 100 */
    $req->Limit = 10;
    /* Offset. Note: this parameter is currently fixed at 0 */
    $req->Offset = 0;
    /* Start time of pull in the format of `yyyymmddhh` accurate to the hour */
    $req->BeginTime = "2019122500";
    /* End time of pull in the format of `yyyymmddhh` accurate to the hour
    * Note: `EndTime` must be after `BeginTime` */
    $req->EndTime = "2019122523";
    
    // Initialize the request by calling the `SendStatusStatistics` method on the client object. Note: the request method name corresponds to the request object
    // The returned `resp` is an instance of the `SendStatusStatisticsResponse` class which corresponds to the request object
    $resp = $client->SendStatusStatistics($req);
    
    // A string return packet in JSON format is output
    print_r($resp->toJsonString());
    
    // You can also take a single value
    // You can view the definition of the return field in the API documentation at the official website or by redirecting to the definition of the response object
    print_r($resp->TotalCount);
    }
    catch(TencentCloudSDKException $e) {
    echo $e;
    }

    Applying for SMS template

    <?php
    require_once '/path/to/vendor/autoload.php';
    // Import the client of the SMS module
    use TencentCloud\\Sms\\V20210111\\SmsClient;
    // Import the `Request` class corresponding to the API to be requested
    use TencentCloud\\Sms\\V20210111\\Models\\AddSmsTemplateRequest;
    use TencentCloud\\Common\\Exception\\TencentCloudSDKException;
    use TencentCloud\\Common\\Credential;
    // Import the optional configuration classes
    use TencentCloud\\Common\\Profile\\ClientProfile;
    use TencentCloud\\Common\\Profile\\HttpProfile;
    try {
    /* Required steps:
    * Instantiate an authentication object. The Tencent Cloud account key pair `secretId` and `secretKey` need to be passed in as the input parameters
    * This example uses the way to read from the environment variable, so you need to set these two values in the environment variable in advance
    * You can also write the key pair directly into the code, but be careful not to copy, upload, or share the code to others
    * Query the CAM key: https://console.tencentcloud.com/cam/capi*/
    
    $cred = new Credential("xxx", "xxx");
    //$cred = new Credential(getenv("TENCENTCLOUD_SECRET_ID"), getenv("TENCENTCLOUD_SECRET_KEY"));
    
    // Instantiate an HTTP option (optional; skip if there are no special requirements)
    $httpProfile = new HttpProfile();
    // Configure the proxy
    // $httpProfile->setProxy("https://ip:port");
    $httpProfile->setReqMethod("GET"); // POST request (POST request by default)
    $httpProfile->setReqTimeout(30); // Request timeout period in seconds (60 seconds by default)
    $httpProfile->setEndpoint("sms.tencentcloudapi.com"); // Specify the access region domain name (nearby access by default)
    
    // Instantiate a client option (optional; skip if no special requirements are present)
    $clientProfile = new ClientProfile();
    $clientProfile->setSignMethod("TC3-HMAC-SHA256"); // Specify the signature algorithm (`HmacSHA256` by default)
    $clientProfile->setHttpProfile($httpProfile);
    
    // Instantiate an SMS client object. `clientProfile` is optional
    // The second parameter is the information on the region you select in Tencent Cloud International. If you select Singapore, you should enter the string `ap-singapore`. Click https://www.tencentcloud.com/document/api/382/40466?lang=en#region-list to view the region list.
    $client = new SmsClient($cred, "ap-singapore", $clientProfile);
    
    // Instantiate an `AddSmsTemplateRequest` request object. Each API corresponds to a request object
    $req = new AddSmsTemplateRequest();
    
    /* Populate the request parameters. Here, the member variables of the request object are the input parameters of the corresponding API
    * You can view the definition of the request parameters in the API documentation at the official website or by redirecting to the definition of the request object
    * Settings of a basic parameter:
    * Help link:
    * SMS console: https://console.tencentcloud.com/smsv2
    * sms helper:https://www.tencentcloud.com/document/product/382/3773?from_cn_redirect=1
    */
    
    /* Template name */
    $req->TemplateName = "Tencent Cloud";
    /* Template content */
    $req->TemplateContent = "Your login verification code is {1}. Please enter it within {2} minutes. If the login was not initiated by you, please ignore this message.";
    /* SMS type. 1: Marketing SMS, 2: Notification SMS, 3: OTP SMS */
    $req->SmsType = 3;
    /* Whether it is Global SMS:
    0: Mainland China SMS
    1: Global SMS */
    $req->International = 0;
    /* Template remarks, such as reason for application and use case */
    $req->Remark = "xxx";
    // Initialize the request by calling the `AddSmsTemplate` method on the client object. Note: the request method name corresponds to the request object
    $resp = $client->AddSmsTemplate($req);
    // A string return packet in JSON format is output
    print_r($resp->toJsonString());
    
    // You can take a single value. You can view the definition of the return field in the API documentation at the official website or by redirecting to the definition of the response object
    print_r($resp->TotalCount);
    }
    catch(TencentCloudSDKException $e) {
    echo $e;
    }

    FAQs

    
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support