:doc:`ChimeSDKVoice <../../chime-sdk-voice>` / Client / list_phone_number_orders

************************
list_phone_number_orders
************************



.. py:method:: ChimeSDKVoice.Client.list_phone_number_orders(**kwargs)

  

  Lists the phone numbers for an administrator's Amazon Chime SDK account.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListPhoneNumberOrders>`_  


  **Request Syntax**
  ::

    response = client.list_phone_number_orders(
        NextToken='string',
        MaxResults=123
    )
    
  :type NextToken: string
  :param NextToken: 

    The token used to retrieve the next page of results.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return in a single call.

    

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

    
    ::

      {
          'PhoneNumberOrders': [
              {
                  'PhoneNumberOrderId': 'string',
                  'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn',
                  'Status': 'Processing'|'Successful'|'Failed'|'Partial'|'PendingDocuments'|'Submitted'|'FOC'|'ChangeRequested'|'Exception'|'CancelRequested'|'Cancelled',
                  'OrderType': 'New'|'Porting',
                  'OrderedPhoneNumbers': [
                      {
                          'E164PhoneNumber': 'string',
                          'Status': 'Processing'|'Acquired'|'Failed'
                      },
                  ],
                  'CreatedTimestamp': datetime(2015, 1, 1),
                  'UpdatedTimestamp': datetime(2015, 1, 1),
                  'FocDate': datetime(2015, 1, 1)
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **PhoneNumberOrders** *(list) --* 

        The phone number order details.

        
        

        - *(dict) --* 

          The details of an Amazon Chime SDK phone number order.

          
          

          - **PhoneNumberOrderId** *(string) --* 

            The ID of the phone order.

            
          

          - **ProductType** *(string) --* 

            The phone number order product type.

            
          

          - **Status** *(string) --* 

            The status of the phone number order.

            
          

          - **OrderType** *(string) --* 

            The type of phone number being ordered, local or toll-free.

            
          

          - **OrderedPhoneNumbers** *(list) --* 

            The ordered phone number details, such as the phone number in E.164 format and the phone number status.

            
            

            - *(dict) --* 

              A phone number for which an order has been placed.

              
              

              - **E164PhoneNumber** *(string) --* 

                The phone number, in E.164 format.

                
              

              - **Status** *(string) --* 

                The phone number status.

                
          
        
          

          - **CreatedTimestamp** *(datetime) --* 

            The phone number order creation time stamp, in ISO 8601 format.

            
          

          - **UpdatedTimestamp** *(datetime) --* 

            The updated phone number order time stamp, in ISO 8601 format.

            
          

          - **FocDate** *(datetime) --* 

            The Firm Order Commitment (FOC) date for phone number porting orders. This field is null if a phone number order is not a porting order.

            
      
    
      

      - **NextToken** *(string) --* 

        The token used to retrieve the next page of results.

        
  
  **Exceptions**
  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.UnauthorizedClientException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.ForbiddenException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.BadRequestException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.ThrottledClientException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.ServiceFailureException`

  