Queries message templates.
Operation description
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| cams:ListChatappTemplate | list | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Name | string | No | The name of the template. | hello_whatsapp |
| Language | string | No | The language that is used in the message template. For more information, see Language codes. | en |
| AuditStatus | string | No | The review state of the template. Valid values:
| pass |
| Page | object | No | The pagination settings. | |
| Size | integer | Yes | The number of entries per page. Default value: 10. | 10 |
| Index | integer | Yes | The page number. Default value: 1. | 1 |
CustWabaIddeprecated | string | No | The WhatsApp Business Account (WABA) ID of the RAM user within the independent software vendor (ISV) account. Note
CustWabaId is an obsolete parameter. Use CustSpaceId instead.
| 65921621816**** |
| CustSpaceId | string | Yes | The space ID of the RAM user within the ISV account. | 28251486512358**** |
| TemplateType | string | No | The type of the message template.
| |
| Code | string | No | The code of the message template. | 838888822***** |
| Category | string | No | The category of the message template. | AUTHENTICATION |
| IsvCode | string | No | The ISV verification code. This parameter is used to verify whether the RAM user is authorized by the ISV account. | skdi3kksloslikdkkdk |
Response parameters
Examples
Sample success responses
JSONformat
{
"AccessDeniedDetail": "None",
"Message": "User not authorized to operate on the specified resource.",
"RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
"ListTemplate": [
{
"TemplateCode": "744c4b5c79c9432497a075bdfca3****",
"AuditStatus": "pass",
"Category": "TRANSACTIONAL",
"Language": "en",
"LastUpdateTime": 1711006633000,
"TemplateName": "hello_whatsapp",
"TemplateType": "WHATSAPP",
"Reason": "None"
}
],
"Total": 1,
"Code": "OK",
"Success": false
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | Product.Unsubscript | You have not subscribed to the specified product. | You have not subscribed to the specified product. |
| 400 | Ram.PermissionDeny | You are not authorized to perform the operation. | - |
| 400 | System.LimitControl | The system is under flow control. | The system is under flow control. |
| 400 | Unknown.ResourceOwnerId | The resource does not belong to the current user. | The resource does not belong to the current user. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-07-24 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2024-05-29 | The Error code has changed. The request parameters of the API has changed | View Change Details |
| 2023-09-14 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2023-07-04 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2023-03-29 | The Error code has changed. The response structure of the API has changed | View Change Details |
