EndUserMessagingSocial / Client / list_whatsapp_message_templates

list_whatsapp_message_templates

EndUserMessagingSocial.Client.list_whatsapp_message_templates(**kwargs)

Lists WhatsApp message templates for a specific WhatsApp Business Account.

See also: AWS API Documentation

Request Syntax

response = client.list_whatsapp_message_templates(
    id='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • id (string) –

    [REQUIRED]

    The ID of the WhatsApp Business Account to list templates for.

  • nextToken (string) – The token for the next page of results.

  • maxResults (integer) – The maximum number of results to return per page (1-100).

Return type:

dict

Returns:

Response Syntax

{
    'templates': [
        {
            'templateName': 'string',
            'metaTemplateId': 'string',
            'templateStatus': 'string',
            'templateQualityScore': 'string',
            'templateLanguage': 'string',
            'templateCategory': 'string',
            'templateSource': 'string',
            'correctCategory': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • templates (list) –

      A list of template summaries.

      • (dict) –

        Provides a summary of a WhatsApp message template’s key attributes.

        • templateName (string) –

          The name of the template.

        • metaTemplateId (string) –

          The numeric ID assigned to the template by Meta.

        • templateStatus (string) –

          The current status of the template (for example, APPROVED, PENDING, or REJECTED).

        • templateQualityScore (string) –

          The quality score assigned to the template by Meta.

        • templateLanguage (string) –

          The language code of the template (for example, en_US).

        • templateCategory (string) –

          The category of the template (for example, UTILITY or MARKETING).

        • templateSource (string) –

          The source of the template. A value of AUTO_GENERATED indicates that the template was created automatically from a message that you sent. This field is not present for templates that you created manually.

        • correctCategory (string) –

          The category that the template content actually belongs to, when it differs from the template’s current category. This field is present only when the template has been flagged as miscategorized.

    • nextToken (string) –

      The token to retrieve the next page of results, if any.

Exceptions