ChimeSDKVoice / Client / update_phone_number

update_phone_number

ChimeSDKVoice.Client.update_phone_number(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.update_phone_number(
    PhoneNumberId='string',
    ProductType='VoiceConnector'|'SipMediaApplicationDialIn',
    CallingName='string'
)

Parameters:

• PhoneNumberId (string) – [REQUIRED]

• ProductType (string) –

• CallingName (string) –

Return type:

dict

Returns:

Response Syntax

{
    'PhoneNumber': {
        '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'
    }
}

Response Structure

• (dict) –

  • PhoneNumber (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) –

Exceptions

• ChimeSDKVoice.Client.exceptions.UnauthorizedClientException

• ChimeSDKVoice.Client.exceptions.NotFoundException

• ChimeSDKVoice.Client.exceptions.ForbiddenException

• ChimeSDKVoice.Client.exceptions.BadRequestException

• ChimeSDKVoice.Client.exceptions.ThrottledClientException

• ChimeSDKVoice.Client.exceptions.ConflictException

• ChimeSDKVoice.Client.exceptions.ServiceUnavailableException

• ChimeSDKVoice.Client.exceptions.ServiceFailureException