EndUserMessagingSocial / Paginator / ListWhatsAppMessageTemplates

ListWhatsAppMessageTemplates

class EndUserMessagingSocial.Paginator.ListWhatsAppMessageTemplates

paginator = client.get_paginator('list_whatsapp_message_templates')

paginate(**kwargs)

Creates an iterator that will paginate through responses from EndUserMessagingSocial.Client.list_whatsapp_message_templates().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    id='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• id (string) –

  [REQUIRED]

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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) –

    A token to resume pagination.