GetWhatsAppMessageTemplate
Retrieves a specific WhatsApp message template.
Request Syntax
GET /v1/whatsapp/template?id=id&metaTemplateId=metaTemplateId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- id
-
The ID of the WhatsApp Business Account associated with this template.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
.*(^waba-.*$)|(^arn:.*:waba/[0-9a-zA-Z]+$).*Required: Yes
- metaTemplateId
-
The numeric ID of the template assigned by Meta.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[0-9]+Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"template": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- template
-
The complete template definition as a JSON string (maximum 6000 characters).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 6000.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- DependencyException
-
Thrown when performing an action because a dependency would be broken.
HTTP Status Code: 502
- InternalServiceException
-
The request processing has failed because of an unknown error, exception, or failure.
HTTP Status Code: 500
- InvalidParametersException
-
One or more parameters provided to the action are not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The resource was not found.
HTTP Status Code: 404
- ThrottledRequestException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The request contains an invalid parameter value.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
