tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Short Message Service
    Documentation
    Download PDF

    SDK for Python

    Last updated: 2024-06-27 15:48:00
    Download PDF
      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 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 Pip (recommended)

      See Github Repository: Installing via Pip (recommended)

      Installing via source package

      See Github Repository: Installing via source package

      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

      # -*- coding: utf-8 -*-
      from tencentcloud.common import credential
      from tencentcloud.common.exception.tencent_cloud_sdk_exception import TencentCloudSDKException
      # Import the client models of the corresponding product module.
      from tencentcloud.sms.v20210111 import sms_client, models
      
      # Import the optional configuration classes
      from tencentcloud.common.profile.client_profile import ClientProfile
      from tencentcloud.common.profile.http_profile import HttpProfile
      try:
          # Instantiate an authentication object, the input parameters must include the Tencent Cloud account SecretId and SecretKey.
          # To protect key security, it is suggested to set keys in environment variables or configuration files.
    # Hardcoding keys into the code might lead to exposure through leaked code, posing a security vulnerability, and is not recommended.            
        
          # Query SecretId, SecretKey: https://console.tencentcloud.com/cam/capi
          # cred = credential.Credential("secretId", "secretKey")
          cred = credential.Credential(
              os.environ.get("TENCENTCLOUD_SECRET_ID"),
              os.environ.get("TENCENTCLOUD_SECRET_KEY"))
      
          # (Optional) Instantiate an HTTP option
          httpProfile = HttpProfile()
          # If you need to specify the proxy for API access, you can initialize HttpProfile as follows
          # httpProfile = HttpProfile(proxy="http://username:password@proxy IP:proxy port")
          httpProfile.reqMethod = "POST"  # POST request (POST request by default)
          httpProfile.reqTimeout = 10    # Request timeout period in seconds (60 seconds by default)
          httpProfile.endpoint = "sms.tencentcloudapi.com"  # Specify the access region domain name (nearby access by default)
      
          # Optional steps:
          # Instantiate a client configuration object. You can specify the timeout period and other configuration items
          clientProfile = ClientProfile()
          clientProfile.signMethod = "TC3-HMAC-SHA256"  # Specify the signature algorithm
          clientProfile.language = "en-US"
          clientProfile.httpProfile = httpProfile
      
          # Instantiate the client object of the requested product (with SMS as an example)
          # 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 = sms_client.SmsClient(cred, "ap-singapore", 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
          # We recommend you use the IDE for development where you can easily redirect to and view the documentation of each API and data structure
          req = 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.tencentcloud.com/smsv2
          # sms helper: https://www.tencentcloud.com/document/product/382/3773
      
          # SMS application ID, which is the `SdkAppId` generated after an application is added in the [SMS console], such as 2400006666
          req.SmsSdkAppId = "2400006666"
          # 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 = ""
          # 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"
          # `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 = ""
          # Target mobile number in the E.164 standard (+[country/region code][mobile number])
          # Example: +60198890000, which has a + sign followed by 60 (country/region code) and then by 198890000 (mobile number). Up to 200 mobile numbers are supported
          req.PhoneNumberSet = ["+60198890000"]
          # 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"]
      
      
          # Initialize the request by calling the `DescribeInstances` method on the client object. Note: the request method name corresponds to the request object
          # The returned `resp` is an instance of the `DescribeInstancesResponse` class which corresponds to the request object
          resp = client.SendSms(req)
      
          # A string return packet in JSON format is outputted
          print(resp.to_json_string(indent=2))
      
      except TencentCloudSDKException as err:
          print(err)

      Pulling SMS delivery status

      # -*- coding: utf-8 -*-
      from tencentcloud.common import credential
      from tencentcloud.common.exception.tencent_cloud_sdk_exception import TencentCloudSDKException
      # Import the client models of the corresponding product module.
      from tencentcloud.sms.v20210111 import sms_client, models
      
      # Import the optional configuration classes
      from tencentcloud.common.profile.client_profile import ClientProfile
      from tencentcloud.common.profile.http_profile import HttpProfile
      try:
          # Instantiate an authentication object, the input parameters must include the Tencent Cloud account SecretId and SecretKey.
          # To protect key security, it is suggested to set keys in environment variables or configuration files.
    # Hardcoding keys into the code might lead to exposure through leaked code, posing a security vulnerability, and is not recommended.            
          # Query SecretId, SecretKey: https://console.tencentcloud.com/cam/capi
          # cred = credential.Credential("secretId", "secretKey")
          cred = credential.Credential(
              os.environ.get("TENCENTCLOUD_SECRET_ID"),
              os.environ.get("TENCENTCLOUD_SECRET_KEY"))
      
          # (Optional) Instantiate an HTTP option
          httpProfile = HttpProfile()
          # If you need to specify the proxy for API access, you can initialize HttpProfile as follows
          # httpProfile = HttpProfile(proxy="http://username:password@proxy IP:proxy port")
          httpProfile.reqMethod = "POST"  # POST request (POST request by default)
          httpProfile.reqTimeout = 30    # Request timeout period in seconds (60 seconds by default)
          httpProfile.endpoint = "sms.tencentcloudapi.com"  # Specify the access region domain name (nearby access by default)
      
          # Optional steps:
          # Instantiate a client configuration object. You can specify the timeout period and other configuration items
          clientProfile = ClientProfile()
          clientProfile.signMethod = "TC3-HMAC-SHA256"  # Specify the signature algorithm
          clientProfile.language = "en-US"
          clientProfile.httpProfile = httpProfile
      
          # Instantiate the client object of the requested product (with SMS as an example)
          # 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 = sms_client.SmsClient(cred, "ap-singapore", 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
          # We recommend you use the IDE for development where you can easily redirect to and view the documentation of each API and data structure
          req = 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.tencentcloud.com/smsv2
          # sms helper: https://www.tencentcloud.com/document/product/382/3773
      
          # SMS application ID, which is the `SdkAppId` generated after an application is added in the [SMS console], such as 2400006666
          req.SmsSdkAppId = "2400006666"
          # 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 outputted
          print(resp.to_json_string(indent=2))
      
      
      except TencentCloudSDKException as err:
          print(err)

      Collecting SMS message sending data

      # -*- coding: utf-8 -*-
      from tencentcloud.common import credential
      from tencentcloud.common.exception.tencent_cloud_sdk_exception import TencentCloudSDKException
      # Import the client models of the corresponding product module.
      from tencentcloud.sms.v20210111 import sms_client, models
      
      # Import the optional configuration classes
      from tencentcloud.common.profile.client_profile import ClientProfile
      from tencentcloud.common.profile.http_profile import HttpProfile
      try:
          # Instantiate an authentication object, the input parameters must include the Tencent Cloud account SecretId and SecretKey.
          # To protect key security, it is suggested to set keys in environment variables or configuration files.
    # Hardcoding keys into the code might lead to exposure through leaked code, posing a security vulnerability, and is not recommended.            
          # Query SecretId, SecretKey: https://console.tencentcloud.com/cam/capi
          # cred = credential.Credential("secretId", "secretKey")
          cred = credential.Credential(
              os.environ.get("TENCENTCLOUD_SECRET_ID"),
              os.environ.get("TENCENTCLOUD_SECRET_KEY"))
      
          # (Optional) Instantiate an HTTP option
          httpProfile = HttpProfile()
          # If you need to specify the proxy for API access, you can initialize HttpProfile as follows
          # httpProfile = HttpProfile(proxy="http://username:password@proxy IP:proxy port")
          httpProfile.reqMethod = "POST"  # POST request (POST request by default)
          httpProfile.reqTimeout = 30    # Request timeout period in seconds (60 seconds by default)
          httpProfile.endpoint = "sms.tencentcloudapi.com"  # Specify the access region domain name (nearby access by default)
      
          # Optional steps:
          # Instantiate a client configuration object. You can specify the timeout period and other configuration items
          clientProfile = ClientProfile()
          clientProfile.signMethod = "TC3-HMAC-SHA256"  # Specify the signature algorithm
          clientProfile.language = "en-US"
          clientProfile.httpProfile = httpProfile
      
          # Instantiate the client object of the requested product (with SMS as an example)
          # 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 = sms_client.SmsClient(cred, "ap-singapore", 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
          # We recommend you use the IDE for development where you can easily redirect to and view the documentation of each API and data structure
          req = 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.tencentcloud.com/smsv2
          # sms helper: https://www.tencentcloud.com/document/product/382/3773
      
          # SMS application ID, which is the `SmsSdkAppId` generated after an application is added in the [SMS console], such as 2400006666
          req.SmsSdkAppId = "2400006666"
          # 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 = "2019122400"
          # 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 outputted
          print(resp.to_json_string(indent=2))
      
      except TencentCloudSDKException as err:
          print(err)

      Applying for SMS template

      # -*- coding: utf-8 -*-
      from tencentcloud.common import credential
      from tencentcloud.common.exception.tencent_cloud_sdk_exception import TencentCloudSDKException
      # Import the client models of the corresponding product module.
      from tencentcloud.sms.v20210111 import sms_client, models
      
      # Import the optional configuration classes
      from tencentcloud.common.profile.client_profile import ClientProfile
      from tencentcloud.common.profile.http_profile import HttpProfile
      try:
          # Instantiate an authentication object, the input parameters must include the Tencent Cloud account SecretId and SecretKey.
          # To protect key security, it is suggested to set keys in environment variables or configuration files.
    # Hardcoding keys into the code might lead to exposure through leaked code, posing a security vulnerability, and is not recommended.            
          # Query SecretId, SecretKey: https://console.tencentcloud.com/cam/capi
          # cred = credential.Credential("secretId", "secretKey")
          cred = credential.Credential(
              os.environ.get("TENCENTCLOUD_SECRET_ID"),
              os.environ.get("TENCENTCLOUD_SECRET_KEY"))
      
          # Instantiate an HTTP option (optional; skip if there are no special requirements)
          httpProfile = HttpProfile()
          # If you need to specify the proxy for API access, you can initialize HttpProfile as follows
          # httpProfile = HttpProfile(proxy="http://username:password@proxy IP:proxy port")
          httpProfile.reqMethod = "POST"  # POST request (POST request by default)
          httpProfile.reqTimeout = 30    # Request timeout period in seconds (60 seconds by default)
          httpProfile.endpoint = "sms.tencentcloudapi.com"  # Specify the access region domain name (nearby access by default)
      
          # Optional steps:
          # Instantiate a client configuration object. You can specify the timeout period and other configuration items
          clientProfile = ClientProfile()
          clientProfile.signMethod = "TC3-HMAC-SHA256"  # Specify the signature algorithm
          clientProfile.language = "en-US"
          clientProfile.httpProfile = httpProfile
      
          # Instantiate an SMS client object
          # 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 = sms_client.SmsClient(cred, "ap-singapore", 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 `AddSmsTemplateRequest` can be set
          # An attribute may be of a basic type or import another data structure
          # We recommend you use the IDE for development where you can easily redirect to and view the documentation of each API and data structure
          req = 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.tencentcloud.com/smsv2
          # sms helper: https://www.tencentcloud.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. 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
          # The returned `resp` is an instance of the `AddSmsTemplateResponse` class which corresponds to the request object
          resp = client.AddSmsTemplate(req)
      
          # A string return packet in JSON format is output
          print(resp.to_json_string(indent=2))
      
      except TencentCloudSDKException as err:
          print(err)

      FAQs

      
      Contact Us

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

      Contact Us
      Technical Support

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

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy