Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

list_phone_numbers

ChimeSDKVoice.Client.list_phone_numbers(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.list_phone_numbers(
    Status='string',
    ProductType='VoiceConnector'|'SipMediaApplicationDialIn',
    FilterName='VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId',
    FilterValue='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • Status (string) --
  • ProductType (string) --
  • FilterName (string) --
  • FilterValue (string) --
  • MaxResults (integer) --
  • NextToken (string) --
Return type

dict

Returns

Response Syntax

{
    'PhoneNumbers': [
        {
            'PhoneNumberId': 'string',
            'E164PhoneNumber': 'string',
            'Country': 'string',
            'Type': 'Local'|'TollFree',
            'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn',
            'Status': 'Cancelled'|'PortinCancelRequested'|'PortinInProgress'|'AcquireInProgress'|'AcquireFailed'|'Unassigned'|'Assigned'|'ReleaseInProgress'|'DeleteInProgress'|'ReleaseFailed'|'DeleteFailed',
            'Capabilities': {
                'InboundCall': True|False,
                'OutboundCall': True|False,
                'InboundSMS': True|False,
                'OutboundSMS': True|False,
                'InboundMMS': True|False,
                'OutboundMMS': True|False
            },
            'Associations': [
                {
                    'Value': 'string',
                    'Name': 'VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId',
                    'AssociatedTimestamp': datetime(2015, 1, 1)
                },
            ],
            'CallingName': 'string',
            'CallingNameStatus': 'Unassigned'|'UpdateInProgress'|'UpdateSucceeded'|'UpdateFailed',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1),
            'DeletionTimestamp': datetime(2015, 1, 1),
            'OrderId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --
    • PhoneNumbers (list) --
      • (dict) --
        • PhoneNumberId (string) --
        • E164PhoneNumber (string) --
        • Country (string) --
        • Type (string) --
        • ProductType (string) --
        • Status (string) --
        • Capabilities (dict) --
          • InboundCall (boolean) --
          • OutboundCall (boolean) --
          • InboundSMS (boolean) --
          • OutboundSMS (boolean) --
          • InboundMMS (boolean) --
          • OutboundMMS (boolean) --
        • Associations (list) --
          • (dict) --
            • Value (string) --
            • Name (string) --
            • AssociatedTimestamp (datetime) --
        • CallingName (string) --
        • CallingNameStatus (string) --
        • CreatedTimestamp (datetime) --
        • UpdatedTimestamp (datetime) --
        • DeletionTimestamp (datetime) --
        • OrderId (string) --
    • NextToken (string) --

Exceptions

  • ChimeSDKVoice.Client.exceptions.UnauthorizedClientException
  • ChimeSDKVoice.Client.exceptions.ForbiddenException
  • ChimeSDKVoice.Client.exceptions.BadRequestException
  • ChimeSDKVoice.Client.exceptions.NotFoundException
  • ChimeSDKVoice.Client.exceptions.ThrottledClientException
  • ChimeSDKVoice.Client.exceptions.ServiceUnavailableException
  • ChimeSDKVoice.Client.exceptions.ServiceFailureException