SDK for Node.js

Last updated: 2020-10-16 11:43:07

    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.

    • 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 activated SMS. For detailed directions, please see Getting Started with Mainland China SMS.
    • If you need to send SMS messages in Mainland China, you need to purchase a Mainland China SMS package first.
    • You have prepared the dependent environment: Node.js 7.10.1 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.
    • You have obtained the call address (endpoint). The call address 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 here.

    Installing SDK

    Installing through npm (recommended)

    npm is a package management tool for Node.js.

    1. Run the following installation command:
      npm install tencentcloud-sdk-nodejs --save
    2. Refer to the corresponding module code in your code. For more information, please see the sample code.

    Installing through source package

    1. Go to the GitHub code hosting page or quick download address to download the source code package.
    2. Decompress the source package to an appropriate location in your project.
    3. Refer to the corresponding module code in your code. For more information, please see the sample code.

    Sample Code

    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. For more samples, please see SDK for Node.js Samples.

    Applying for SMS template

    const tencentcloud = require("../../../../tencentcloud-sdk-nodejs");
    
    // Import the client models of the SMS module
    const smsClient = tencentcloud.sms.v20190711.Client;
    const models = tencentcloud.sms.v20190711.Models;
    
    const Credential = tencentcloud.common.Credential;
    const ClientProfile = tencentcloud.common.ClientProfile;
    const HttpProfile = tencentcloud.common.HttpProfile;
    
    
    /* 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.cloud.tencent.com/cam/capi*/
    //let cred = new Credential(process.env.TENCENTCLOUD_SECRET_ID, process.env.TENCENTCLOUD_SECRET_KEY);
    let cred = new Credential("xxx", "xxx");
    /* Optional steps:
     * Instantiate a client configuration object. You can specify the timeout period and other configuration items */
    let httpProfile = new HttpProfile();
    /* The SDK uses the POST method by default
     * If you need to use the GET method, you can set it here, but the GET method cannot handle some large requests */
    httpProfile.reqMethod = "POST";
    /* The SDK has a default timeout period. Do not adjust it unless absolutely necessary
     * If needed, check in the code to get the latest default value */
    httpProfile.reqTimeout = 30;
    httpProfile.endpoint = "sms.tencentcloudapi.com";
    
    // Instantiate a client option (optional; skip if no special requirements are present)
    let clientProfile = new ClientProfile();
    /* The SDK uses `TC3-HMAC-SHA256` to sign by default. Do not modify this field unless absolutely necessary */
    clientProfile.signMethod = "HmacSHA256";
    clientProfile.httpProfile = httpProfile;
    
    /* The SDK automatically specifies the domain name. Generally, you don't need to specify a domain name, but if you are accessing a service in a finance AZ, you must manually specify the domain name
     * For example, the SMS domain name of the Shanghai Finance Zone is `sms.ap-shanghai-fsi.tencentcloudapi.com` *
     * Instantiate an SMS client object
     * The second parameter is the region information. You can directly enter the string `ap-guangzhou` or import the preset constant */
    let client = new smsClient(cred, "ap-guangzhou", clientProfile);
    
    /* Instantiate a request object. You can further set the request parameters according to the API called and actual conditions
     * You can directly check the SDK source code to determine which attributes of `SendSmsRequest` can be set
     * An attribute may be of a basic type or import another data structure
     * You are recommended to use the IDE for development where you can easily redirect to and view the documentation of each API and data structure */
    let req = new models.AddSmsTemplateRequest();
    
    /* Settings of a basic parameter:
     * The SDK uses the pointer style to specify parameters, so even for basic parameters, you need to use pointers to assign values to them
     * The SDK provides encapsulation functions for importing the pointers of basic parameters
     * Help link:
     * SMS Console: https://console.cloud.tencent.com/smsv2
     * SMS helper: https://intl.cloud.tencent.com/document/product/382/3773 */
    
    /* 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. 0: general SMS; 1: marketing SMS */
    req.SmsType = 0;
    /* 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";
    
    // Call the API you want to access through the client object; you need to pass in the request object and the response callback function
    client.AddSmsTemplate(req, function (err, response) {
        // The request returns an exception and the exception information is printed
        if (err) {
            console.log(err);
            return;
        }
        // The request is returned normally, and the `response` object is printed
        console.log(response.to_json_string());
    });

    Sending SMS message

    const tencentcloud = require("../../../../tencentcloud-sdk-nodejs");
    
    // Import the client models of the SMS module
    const smsClient = tencentcloud.sms.v20190711.Client;
    const models = tencentcloud.sms.v20190711.Models;
    
    const Credential = tencentcloud.common.Credential;
    const ClientProfile = tencentcloud.common.ClientProfile;
    const HttpProfile = tencentcloud.common.HttpProfile;
    
    
    /* 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.cloud.tencent.com/cam/capi*/
    //let cred = new Credential(process.env.TENCENTCLOUD_SECRET_ID, process.env.TENCENTCLOUD_SECRET_KEY);
    let cred = new Credential("xxx", "xxx");
    /* Optional steps:
     * Instantiate a client configuration object. You can specify the timeout period and other configuration items */
    let httpProfile = new HttpProfile();
    /* The SDK uses the POST method by default
     * If you need to use the GET method, you can set it here, but the GET method cannot handle some large requests */
    httpProfile.reqMethod = "POST";
    /* The SDK has a default timeout period. Do not adjust it unless absolutely necessary
     * If needed, check in the code to get the latest default value */
    httpProfile.reqTimeout = 30;
    httpProfile.endpoint = "sms.tencentcloudapi.com";
    
    // Instantiate a client option (optional; skip if no special requirements are present)
    let clientProfile = new ClientProfile();
    /* The SDK uses `TC3-HMAC-SHA256` to sign by default. Do not modify this field unless absolutely necessary */
    clientProfile.signMethod = "HmacSHA256";
    clientProfile.httpProfile = httpProfile;
    
    /* The SDK automatically specifies the domain name. Generally, you don't need to specify a domain name, but if you are accessing a service in a finance AZ, you must manually specify the domain name
     * For example, the SMS domain name of the Shanghai Finance Zone is `sms.ap-shanghai-fsi.tencentcloudapi.com` *
     * Instantiate an SMS client object
     * The second parameter is the region information. You can directly enter the string `ap-guangzhou` or import the preset constant */
    let client = new smsClient(cred, "ap-guangzhou", clientProfile);
    
    /* Instantiate a request object. You can further set the request parameters according to the API called and actual conditions
     * You can directly check the SDK source code to determine which attributes of `SendSmsRequest` can be set
     * An attribute may be of a basic type or import another data structure
     * You are recommended to use the IDE for development where you can easily redirect to and view the documentation of each API and data structure */
    let req = new models.SendSmsRequest();
    
    /* Settings of a basic parameter:
     * The SDK uses the pointer style to specify parameters, so even for basic parameters, you need to use pointers to assign values to them
     * The SDK provides encapsulation functions for importing the pointers of basic parameters
     * Help link:
     * SMS Console: https://console.cloud.tencent.com/smsv2
     * SMS helper: https://intl.cloud.tencent.com/document/product/382/3773 */
    
    /* SMS application ID, which is the actual `SDKAppID` generated after an application is added in the [SMS Console], such as 1400006666 */
    req.SmsSdkAppid = "1400787878";
    /* The content of SMS signature should be encoded in UTF-8. You must enter an approved signature, which can be viewed in the [SMS Console] */
    req.Sign = "xxx";
    /* SMS code number extension, which is not activated by default. If you need to activate it, please contact [SMS Helper] */
    req.ExtendCode = "";
    /* `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 = "";
    /* 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 = ["+8613711112222", "+8613711333222", "+8613711144422"];
    /* 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 = ["666"];
    
    // Call the API you want to access through the client object; you need to pass in the request object and the response callback function
    client.SendSms(req, function (err, response) {
        // The request returns an exception and the exception information is printed
        if (err) {
            console.log(err);
            return;
        }
        // The request is returned normally, and the `response` object is printed
        console.log(response.to_json_string());
    });

    Pulling receipt status

    const tencentcloud = require("../../../../tencentcloud-sdk-nodejs");
    
    // Import the client models of the SMS module
    const smsClient = tencentcloud.sms.v20190711.Client;
    const models = tencentcloud.sms.v20190711.Models;
    
    const Credential = tencentcloud.common.Credential;
    const ClientProfile = tencentcloud.common.ClientProfile;
    const HttpProfile = tencentcloud.common.HttpProfile;
    
    
    /* 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.cloud.tencent.com/cam/capi*/
    //let cred = new Credential(process.env.TENCENTCLOUD_SECRET_ID, process.env.TENCENTCLOUD_SECRET_KEY);
    let cred = new Credential("xxx", "xxx");
    /* Optional steps:
     * Instantiate a client configuration object. You can specify the timeout period and other configuration items */
    let httpProfile = new HttpProfile();
    /* The SDK uses the POST method by default
     * If you need to use the GET method, you can set it here, but the GET method cannot handle some large requests */
    httpProfile.reqMethod = "POST";
    /* The SDK has a default timeout period. Do not adjust it unless absolutely necessary
     * If needed, check in the code to get the latest default value */
    httpProfile.reqTimeout = 30;
    httpProfile.endpoint = "sms.tencentcloudapi.com";
    
    // Instantiate a client option (optional; skip if no special requirements are present)
    let clientProfile = new ClientProfile();
    /* The SDK uses `TC3-HMAC-SHA256` to sign by default. Do not modify this field unless absolutely necessary */
    clientProfile.signMethod = "HmacSHA256";
    clientProfile.httpProfile = httpProfile;
    
    /* The SDK automatically specifies the domain name. Generally, you don't need to specify a domain name, but if you are accessing a service in a finance AZ, you must manually specify the domain name
     * For example, the SMS domain name of the Shanghai Finance Zone is `sms.ap-shanghai-fsi.tencentcloudapi.com` *
     * Instantiate an SMS client object
     * The second parameter is the region information. You can directly enter the string `ap-guangzhou` or import the preset constant */
    let client = new smsClient(cred, "ap-guangzhou", clientProfile);
    
    /* Instantiate a request object. You can further set the request parameters according to the API called and actual conditions
     * You can directly check the SDK source code to determine which attributes of `SendSmsRequest` can be set
     * An attribute may be of a basic type or import another data structure
     * You are recommended to use the IDE for development where you can easily redirect to and view the documentation of each API and data structure */
    let req = new models.PullSmsSendStatusRequest();
    
    /* Settings of a basic parameter:
     * The SDK uses the pointer style to specify parameters, so even for basic parameters, you need to use pointers to assign values to them
     * The SDK provides encapsulation functions for importing the pointers of basic parameters
     * Help link:
     * SMS Console: https://console.cloud.tencent.com/smsv2
     * SMS helper: https://intl.cloud.tencent.com/document/product/382/3773 */
    
    /* SMS application ID, which is the actual `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;
    
    // Call the API you want to access through the client object; you need to pass in the request object and the response callback function
    client.PullSmsSendStatus(req, function (err, response) {
        // The request returns an exception and the exception information is printed
        if (err) {
            console.log(err);
            return;
        }
        // The request is returned normally, and the `response` object is printed
        console.log(response.to_json_string());
    });

    Collecting SMS message sending data

    const tencentcloud = require("../../../../tencentcloud-sdk-nodejs");
    
    // Import the client models of the SMS module
    const smsClient = tencentcloud.sms.v20190711.Client;
    const models = tencentcloud.sms.v20190711.Models;
    
    const Credential = tencentcloud.common.Credential;
    const ClientProfile = tencentcloud.common.ClientProfile;
    const HttpProfile = tencentcloud.common.HttpProfile;
    
    
    /* 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.cloud.tencent.com/cam/capi*/
    //let cred = new Credential(process.env.TENCENTCLOUD_SECRET_ID, process.env.TENCENTCLOUD_SECRET_KEY);
    let cred = new Credential("xxx", "xxx");
    /* Optional steps:
     * Instantiate a client configuration object. You can specify the timeout period and other configuration items */
    let httpProfile = new HttpProfile();
    /* The SDK uses the POST method by default
     * If you need to use the GET method, you can set it here, but the GET method cannot handle some large requests */
    httpProfile.reqMethod = "POST";
    /* The SDK has a default timeout period. Do not adjust it unless absolutely necessary
     * If needed, check in the code to get the latest default value */
    httpProfile.reqTimeout = 30;
    httpProfile.endpoint = "sms.tencentcloudapi.com";
    
    // Instantiate a client option (optional; skip if no special requirements are present)
    let clientProfile = new ClientProfile();
    /* The SDK uses `TC3-HMAC-SHA256` to sign by default. Do not modify this field unless absolutely necessary */
    clientProfile.signMethod = "HmacSHA256";
    clientProfile.httpProfile = httpProfile;
    
    /* The SDK automatically specifies the domain name. Generally, you don't need to specify a domain name, but if you are accessing a service in a finance AZ, you must manually specify the domain name
     * For example, the SMS domain name of the Shanghai Finance Zone is `sms.ap-shanghai-fsi.tencentcloudapi.com` *
     * Instantiate an SMS client object
     * The second parameter is the region information. You can directly enter the string `ap-guangzhou` or import the preset constant */
    let client = new smsClient(cred, "ap-guangzhou", clientProfile);
    
    /* Instantiate a request object. You can further set the request parameters according to the API called and actual conditions
     * You can directly check the SDK source code to determine which attributes of `SendSmsRequest` can be set
     * An attribute may be of a basic type or import another data structure
     * You are recommended to use the IDE for development where you can easily redirect to and view the documentation of each API and data structure */
    let req = new models.SendStatusStatisticsRequest();
    
    /* Settings of a basic parameter:
     * The SDK uses the pointer style to specify parameters, so even for basic parameters, you need to use pointers to assign values to them
     * The SDK provides encapsulation functions for importing the pointers of basic parameters
     * Help link:
     * SMS Console: https://console.cloud.tencent.com/smsv2
     * SMS helper: https://intl.cloud.tencent.com/document/product/382/3773 */
    
    // SMS application ID, which is the actual `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, which is currently fixed at 0
    req.Offset = 0;
    // Start time of pull in the format of `yyyymmddhh` accurate to the hour
    req.StartDateTime = 2019122400;
    // End time of pull in the format of `yyyymmddhh` accurate to the hour
    // Note: `EndDataTime` must be later than `StartDateTime`
    req.EndDataTime = 2019122523;
    
    // Call the API you want to access through the client object; you need to pass in the request object and the response callback function
    client.SendStatusStatistics(req, function (err, response) {
        // The request returns an exception and the exception information is printed
        if (err) {
            console.log(err);
            return;
        }
        // The request is returned normally, and the `response` object is printed
        console.log(response.to_json_string());
    });

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help