List of Templates
Overview
The List Templates API allows businesses to retrieve all RCS templates associated with their account (appId).
Each template object includes details such as content, title, description, media, card alignment, height, width, and approval status.
Authentication
This API requires Bearer Token Authentication.
Include a valid token in the request header:
Refer to Authentication for details on generating and managing tokens.
- API Endpoints: -
/v2/rcs/<appId>/templates - Authentication: - This API requires Bearer token authentication. See Authentication for more details.
- Method: -
GET
Example Request
cURL
curl -X GET "https://api.aclwhatsapp.com/access-api/v2/rcs/test_appid/templates" \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9" \
-H "Content-Type: application/json"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The request was successful. The response body contains an array of templates (Template[]). | Template[] |
| 400 | Bad Request | Invalid query parameters were provided in the request. | BadRequest |
| 401 | Unauthorized | Missing or invalid Authorization header. Ensure that a valid Bearer token is provided. | None |
| 403 | Forbidden | The provided token does not have permission to access this resource. | None |
| 429 | Too Many Requests | API rate limit exceeded. Retry after the duration specified in the Retry-After header. | None |
| 500 | Internal Server Error | Something went wrong while processing the request on the server. | InternalServerError |
| 502 | Bad Gateway | The upstream service failed to respond correctly. | None |
| 503 | Service Unavailable | The API service is temporarily unavailable — typically due to maintenance or heavy load. | None |
| 504 | Gateway Timeout | The server did not receive a timely response from the upstream service. | None |
Template[]
JSON Representation
[
{
"component": {
object (MessageContent)
},
"name": string,
"type": enum (TemplateType),
"status": enum (TemplateStatus),
"ttl": string
}
]
See MessageContent, TemplateType and TemplateStatus for more details.
Fields
| Fields | |
|---|---|
| component | object (MessageContent) The content of the message template. See MessageContent for more details. |
| name | string The unique name of the template. |
| type | enum (TemplateType) The type of the template — text_message, rich_card, or carousel. See TemplateType. |
| status | enum (TemplateStatus) The approval status of the template — approved, pending, rejected, or expired. See TemplateStatus. |
| ttl | string (Timestamp format) (Optional) The timestamp in UTC when the media within this template is considered expired. |
BadRequest
JSON Representation
{
"error": {
"code": 400,
"message": string
}
}
Fields
| Fields | |
|---|---|
| error.code | integer The HTTP status code for the error. Always returns 400 for Bad Request responses. |
| error.message | string A detailed message describing which parameter in the body or query is invalid. |
InternalServerError
JSON Representation
{
"error": {
"message": "Something went wrong.",
"code": 500
}
}
Fields
| Fields | |
|---|---|
| error.code | integer The HTTP status code for the error. Always returns 500 for internal server errors. |
| error.message | string A message indicating that something went wrong while processing the request. |