QueryUSMSTemplate

Query SMS Template

API Description

Query specified SMS template information. Supports batch query.

Request Information

• Get API Key: ACCESSKEY_ID:ACCESSKEY_SECRET
• Request Method: GET
• Request Path: /api/v1/usms/USMSTemplate
• Content-Type: application/json

Request Parameters

Header Parameters

Parameter Name	Type	Required	Description	Example Value
Content-Type	string	Yes	Request content type	"application/json"
Authorization	string	Yes	HTTP Basic authentication	"Basic $(echo -n 'accesskeyId:accesskeySecret'

Query Parameters

Parameter Name	Type	Required	Description	Example Value
id	string[]	Yes	Template ID list (passed via query parameters, multiple allowed)	["template_id_1", "template_id_2"]

Note: Parameters are passed via URL query string, format: ?id=template_id_1&id=template_id_2

Request Examples

CURL

curl -X GET "https://api.uspeedo.com/api/v1/usms/USMSTemplate?id=template_id_1&id=template_id_2" \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic $(echo -n 'YOUR_ACCESSKEY_ID:YOUR_ACCESSKEY_SECRET' | base64)"

Golang

package main

import (
    "encoding/base64"
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    baseURL := "https://api.uspeedo.com/api/v1/usms/USMSTemplate"
    
    // Build query parameters
    params := url.Values{}
    params.Add("id", "template_id_1")
    params.Add("id", "template_id_2")
    
    fullURL := baseURL + "?" + params.Encode()
    
    // Create request
    req, _ := http.NewRequest("GET", fullURL, nil)
    req.Header.Set("Content-Type", "application/json")
    
    // Set HTTP Basic authentication
    accesskeyId := "YOUR_ACCESSKEY_ID"
    accesskeySecret := "YOUR_ACCESSKEY_SECRET"
    auth := base64.StdEncoding.EncodeToString([]byte(accesskeyId + ":" + accesskeySecret))
    req.Header.Set("Authorization", "Basic "+auth)
    
    // Send request
    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        fmt.Printf("Request failed: %v\n", err)
        return
    }
    defer resp.Body.Close()
    
    // Read response
    body, _ := io.ReadAll(resp.Body)
    fmt.Printf("Response status code: %d\n", resp.StatusCode)
    fmt.Printf("Response content: %s\n", string(body))
}

Java

import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.util.Base64;

public class QueryUSMSTemplate {
    public static void main(String[] args) {
        try {
            String baseURL = "https://api.uspeedo.com/api/v1/usms/USMSTemplate";
            String[] templateIds = {"template_id_1", "template_id_2"};
            
            // Build query parameters
            StringBuilder queryParams = new StringBuilder();
            for (String id : templateIds) {
                if (queryParams.length() > 0) {
                    queryParams.append("&");
                }
                queryParams.append("id=").append(URLEncoder.encode(id, StandardCharsets.UTF_8));
            }
            
            String url = baseURL + "?" + queryParams.toString();
            
            // Create connection
            URL apiUrl = new URL(url);
            HttpURLConnection conn = (HttpURLConnection) apiUrl.openConnection();
            conn.setRequestMethod("GET");
            conn.setRequestProperty("Content-Type", "application/json");
            
            // Set HTTP Basic authentication
            String accesskeyId = "YOUR_ACCESSKEY_ID";
            String accesskeySecret = "YOUR_ACCESSKEY_SECRET";
            String auth = accesskeyId + ":" + accesskeySecret;
            String encodedAuth = Base64.getEncoder().encodeToString(auth.getBytes(StandardCharsets.UTF_8));
            conn.setRequestProperty("Authorization", "Basic " + encodedAuth);
            
            // Read response
            int responseCode = conn.getResponseCode();
            System.out.println("Response status code: " + responseCode);
            
            BufferedReader in = new BufferedReader(new InputStreamReader(conn.getInputStream()));
            String inputLine;
            StringBuffer response = new StringBuffer();
            while ((inputLine = in.readLine()) != null) {
                response.append(inputLine);
            }
            in.close();
            
            System.out.println("Response content: " + response.toString());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

Python

import requests
import base64

def query_usms_template(template_ids):
    base_url = "https://api.uspeedo.com/api/v1/usms/USMSTemplate"
    
    # Build query parameters
    params = [("id", tid) for tid in template_ids]
    
    # Set HTTP Basic authentication
    accesskey_id = "YOUR_ACCESSKEY_ID"
    accesskey_secret = "YOUR_ACCESSKEY_SECRET"
    credentials = base64.b64encode(f"{accesskey_id}:{accesskey_secret}".encode()).decode()
    
    headers = {
        "Content-Type": "application/json",
        "Authorization": f"Basic {credentials}"
    }
    
    # Send request
    response = requests.get(base_url, params=params, headers=headers)
    
    print(f"Response status code: {response.status_code}")
    print(f"Response content: {response.text}")
    
    return response.json() if response.status_code == 200 else None

if __name__ == "__main__":
    template_ids = ["template_id_1", "template_id_2"]
    query_usms_template(template_ids)

PHP

<?php

function queryUSMSTemplate($templateIds) {
    $baseURL = "https://api.uspeedo.com/api/v1/usms/USMSTemplate";
    
    // Build query parameters
    $queryParams = array();
    foreach ($templateIds as $id) {
        $queryParams[] = "id=" . urlencode($id);
    }
    $url = $baseURL . "?" . implode("&", $queryParams);
    
    // Set HTTP Basic authentication
    $accesskeyId = "YOUR_ACCESSKEY_ID";
    $accesskeySecret = "YOUR_ACCESSKEY_SECRET";
    $auth = base64_encode($accesskeyId . ":" . $accesskeySecret);
    
    // Initialize cURL
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_HTTPHEADER, array(
        "Content-Type: application/json",
        "Authorization: Basic " . $auth
    ));
    
    // Execute request
    $response = curl_exec($ch);
    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    curl_close($ch);
    
    echo "Response status code: " . $httpCode . "\n";
    echo "Response content: " . $response . "\n";
    
    return json_decode($response, true);
}

$templateIds = array("template_id_1", "template_id_2");
queryUSMSTemplate($templateIds);
?>

Response Format

Success Response

{
  "RetCode": 0,
  "Message": "success",
  "Data": [
    {
      "TemplateId": "template_id_1",
      "TemplateName": "MyTemplate",
      "Template": "Your verification code is {1}",
      "Purpose": 1,
      "Status": "approved",
      "Remark": "For user login verification"
    },
    {
      "TemplateId": "template_id_2",
      "TemplateName": "AnotherTemplate",
      "Template": "Your order {1} has been shipped",
      "Purpose": 2,
      "Status": "pending",
      "Remark": "Order notification"
    }
  ]
}

Response Field Description

Field Name	Type	Description
RetCode	int	Return code, 0 indicates success
Message	string	Return message
Data	array	Template information list, each element contains: TemplateId (template ID), TemplateName (template name), Template (template content), Purpose (purpose), Status (status), Remark (remarks), etc.

Error Response

{
  "RetCode": 215392,
  "Message": "Invalid parameter [id]"
}

Common Error Codes

Error Code	Description
0	Success
215392	Parameter error
215396	Template not found
215400	Server error