:doc:`Chime <../../chime>` / Client / create_phone_number_order

*************************
create_phone_number_order
*************************



.. py:method:: Chime.Client.create_phone_number_order(**kwargs)

  

  Creates an order for phone numbers to be provisioned. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreatePhoneNumberOrder>`_  


  **Request Syntax**
  ::

    response = client.create_phone_number_order(
        ProductType='BusinessCalling'|'VoiceConnector'|'SipMediaApplicationDialIn',
        E164PhoneNumbers=[
            'string',
        ]
    )
    
  :type ProductType: string
  :param ProductType: **[REQUIRED]** 

    The phone number product type.

    

  
  :type E164PhoneNumbers: list
  :param E164PhoneNumbers: **[REQUIRED]** 

    List of phone numbers, in E.164 format.

    

  
    - *(string) --* 

    

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

    
    ::

      {
          'PhoneNumberOrder': {
              'PhoneNumberOrderId': 'string',
              'ProductType': 'BusinessCalling'|'VoiceConnector'|'SipMediaApplicationDialIn',
              'Status': 'Processing'|'Successful'|'Failed'|'Partial',
              'OrderedPhoneNumbers': [
                  {
                      'E164PhoneNumber': 'string',
                      'Status': 'Processing'|'Acquired'|'Failed'
                  },
              ],
              'CreatedTimestamp': datetime(2015, 1, 1),
              'UpdatedTimestamp': datetime(2015, 1, 1)
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **PhoneNumberOrder** *(dict) --* 

        The phone number order details.

        
        

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

          The phone number order ID.

          
        

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

          The phone number order product type.

          
        

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

          The status of the phone number order.

          
        

        - **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.

          
    
  
  **Exceptions**
  
  *   :py:class:`Chime.Client.exceptions.BadRequestException`

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

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

  
  *   :py:class:`Chime.Client.exceptions.UnauthorizedClientException`

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

  
  *   :py:class:`Chime.Client.exceptions.ResourceLimitExceededException`

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

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

  