# Query USMS Template Application Status - QueryUSMSTemplate

## Overview

Call the QueryUSMSTemplate interface to query the status of the SMS template application






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `QueryUSMSTemplate`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.scloudsg.com/uaccount/api_manage)                                             | **Yes** |
| **Signature**  | string  | User signature generated based on public key and API command, see [Signature Algorithm](/docs/api/summary/signature.md)  | **Yes** |

### Request Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **ProjectId** | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the [GetProjectList interface](/docs/api/summary/get_project_list). |**Yes**|
| **TemplateId** | string | Template ID |**Yes**|

### Response Field

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **RetCode** | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. |**Yes**|
| **Action** | string | Operation command name. |**Yes**|
| **Message** | string | Returns an error message, providing detailed description when `RetCode` is non-zero. |No|
| **Data** | [*OutTemplate*](#outtemplate) | Details of the SMS template, for field descriptions see OutTemplate. |No|

#### Data Model


#### OutTemplate

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **TemplateId** | string | SMS Template ID |**Yes**|
| **Purpose** | int | Template type, options: 1-Verification code type 2-Notification type 3-Member promotion type |**Yes**|
| **TemplateName** | string | USMS Template Name |**Yes**|
| **Template** | string | USMS Template Content |**Yes**|
| **UnsubscribeInfo** | string | Unsubscribe Information; the general input method is "Reply T to unsubscribe", which is a mandatory field when the purpose is 3 (i.e., member promotion category). |**Yes**|
| **Status** | int | SMS Template Status; Status Description: 0-Pending Review, 1-Under Review, 2-Approved, 3-Not Approved, 4-Disabled |**Yes**|
| **Remark** | string | Template Description |**Yes**|
| **ErrDesc** | string | Audit Failure Reason |**Yes**|
| **CreateTime** | int | Creation Time |**Yes**|
| **Instruction** | string | Template Variable Property Description |No|

## Example

### Request Example
    
```
https://api.scloudsg.com/?Action=QueryUSMSTemplate
&ProjectId=pro-xxxxx
&TemplateId=UTA190715D9108C
```

### Response Example
    
```json
{
  "Action": "QueryUSMSTemplateResponse",
  "Data": {
    "CreateTime": 1566783067,
    "ErrDesc": "",
    "Status": 2,
    "Template": "您的验证码为{1}，请在{2}分钟内使用，勿透露给他人。",
    "TemplateId": "UTA190715D9108C",
    "TemplateName": "验证码模板01"
  },
  "Message": "",
  "RetCode": 0
}
```