batch_delete_phone_number

batch_delete_phone_number(**kwargs)

Moves phone numbers into the Deletion queue . Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted.

Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

See also: AWS API Documentation

Request Syntax

response = client.batch_delete_phone_number(
    PhoneNumberIds=[
        'string',
    ]
)

Parameters

PhoneNumberIds (list) --

[REQUIRED]

List of phone number IDs.

• (string) --

Return type

dict

Returns

Response Syntax

{
    'PhoneNumberErrors': [
        {
            'PhoneNumberId': 'string',
            'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

• (dict) --
  • PhoneNumberErrors (list) --

    If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

    • (dict) --

      If the phone number action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

      • PhoneNumberId (string) --

        The phone number ID for which the action failed.

      • ErrorCode (string) --

        The error code.

      • ErrorMessage (string) --

        The error message.

Exceptions

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