:doc:`EndUserMessagingSocial <../../socialmessaging>` / Client / list_whatsapp_template_library

******************************
list_whatsapp_template_library
******************************



.. py:method:: EndUserMessagingSocial.Client.list_whatsapp_template_library(**kwargs)

  

  Lists templates available in Meta's template library for WhatsApp messaging.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/socialmessaging-2024-01-01/ListWhatsAppTemplateLibrary>`_  


  **Request Syntax**
  ::

    response = client.list_whatsapp_template_library(
        nextToken='string',
        maxResults=123,
        id='string',
        filters={
            'string': 'string'
        }
    )
    
  :type nextToken: string
  :param nextToken: 

    The token for the next page of results.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return per page (1-100).

    

  
  :type id: string
  :param id: **[REQUIRED]** 

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

    

  
  :type filters: dict
  :param filters: 

    Map of filters to apply (searchKey, topic, usecase, industry, language).

    

  
    - *(string) --* 

    
      - *(string) --* 

      


  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'metaLibraryTemplates': [
              {
                  'templateName': 'string',
                  'templateLanguage': 'string',
                  'templateCategory': 'string',
                  'templateTopic': 'string',
                  'templateUseCase': 'string',
                  'templateIndustry': [
                      'string',
                  ],
                  'templateHeader': 'string',
                  'templateBody': 'string',
                  'templateButtons': [
                      {
                          'type': 'string',
                          'text': 'string',
                          'phoneNumber': 'string',
                          'url': 'string',
                          'otpType': 'string',
                          'zeroTapTermsAccepted': True|False,
                          'supportedApps': [
                              {
                                  'string': 'string'
                              },
                          ]
                      },
                  ],
                  'templateId': 'string',
                  'templateBodyExampleParams': [
                      'string',
                  ]
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **metaLibraryTemplates** *(list) --* 

        A list of templates from Meta's library.

        
        

        - *(dict) --* 

          Defines the complete structure and content of a template in Meta's library.

          
          

          - **templateName** *(string) --* 

            The name of the template.

            
          

          - **templateLanguage** *(string) --* 

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

            
          

          - **templateCategory** *(string) --* 

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

            
          

          - **templateTopic** *(string) --* 

            The topic or subject matter of the template.

            
          

          - **templateUseCase** *(string) --* 

            The intended use case for the template.

            
          

          - **templateIndustry** *(list) --* 

            The industries the template is designed for.

            
            

            - *(string) --* 
        
          

          - **templateHeader** *(string) --* 

            The header text of the template.

            
          

          - **templateBody** *(string) --* 

            The body text of the template.

            
          

          - **templateButtons** *(list) --* 

            The buttons included in the template.

            
            

            - *(dict) --* 

              Defines a button in a template from Meta's library.

              
              

              - **type** *(string) --* 

                The type of button (for example, QUICK_REPLY, CALL, or URL).

                
              

              - **text** *(string) --* 

                The text displayed on the button (maximum 40 characters).

                
              

              - **phoneNumber** *(string) --* 

                The phone number in E.164 format for CALL-type buttons.

                
              

              - **url** *(string) --* 

                The URL for URL-type buttons.

                
              

              - **otpType** *(string) --* 

                The type of one-time password for OTP buttons.

                
              

              - **zeroTapTermsAccepted** *(boolean) --* 

                When true, indicates acceptance of zero-tap terms for the button.

                
              

              - **supportedApps** *(list) --* 

                List of supported applications for this button type.

                
                

                - *(dict) --* 
                  

                  - *(string) --* 
                    

                    - *(string) --* 
              
            
            
          
        
          

          - **templateId** *(string) --* 

            The ID of the template in Meta's library.

            
          

          - **templateBodyExampleParams** *(list) --* 

            Example parameter values for the template body, used to demonstrate how dynamic content appears in the template.

            
            

            - *(string) --* 
        
      
    
      

      - **nextToken** *(string) --* 

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

        
  
  **Exceptions**
  
  *   :py:class:`EndUserMessagingSocial.Client.exceptions.ValidationException`

  
  *   :py:class:`EndUserMessagingSocial.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`EndUserMessagingSocial.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`EndUserMessagingSocial.Client.exceptions.InvalidParametersException`

  
  *   :py:class:`EndUserMessagingSocial.Client.exceptions.ThrottledRequestException`

  
  *   :py:class:`EndUserMessagingSocial.Client.exceptions.InternalServiceException`

  
  *   :py:class:`EndUserMessagingSocial.Client.exceptions.DependencyException`

  