BatchDeletePhoneNumberCommand

Suggest an Edit

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

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ChimeSDKVoiceClient, BatchDeletePhoneNumberCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
// const { ChimeSDKVoiceClient, BatchDeletePhoneNumberCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
const client = new ChimeSDKVoiceClient(config);
const input = { // BatchDeletePhoneNumberRequest
  PhoneNumberIds: [ // NonEmptyStringList // required
    "STRING_VALUE",
  ],
};
const command = new BatchDeletePhoneNumberCommand(input);
const response = await client.send(command);
// { // BatchDeletePhoneNumberResponse
//   PhoneNumberErrors: [ // PhoneNumberErrorList
//     { // PhoneNumberError
//       PhoneNumberId: "STRING_VALUE",
//       ErrorCode: "BadRequest" || "Conflict" || "Forbidden" || "NotFound" || "PreconditionFailed" || "ResourceLimitExceeded" || "ServiceFailure" || "AccessDenied" || "ServiceUnavailable" || "Throttled" || "Throttling" || "Unauthorized" || "Unprocessable" || "VoiceConnectorGroupAssociationsExist" || "PhoneNumberAssociationsExist" || "Gone",
//       ErrorMessage: "STRING_VALUE",
//     },
//   ],
// };

BatchDeletePhoneNumberCommand Input

See BatchDeletePhoneNumberCommandInput for more details

Parameter
Type
Description
PhoneNumberIds
Required
string[] | undefined

List of phone number IDs.

BatchDeletePhoneNumberCommand Output

See BatchDeletePhoneNumberCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
PhoneNumberErrors
PhoneNumberError[] | undefined

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.

Throws

Name
Fault
Details
BadRequestException
client

The input parameters don't match the service's restrictions.

ForbiddenException
client

The client is permanently forbidden from making the request.

NotFoundException
client

The requested resource couldn't be found.

ServiceFailureException
server

The service encountered an unexpected error.

ServiceUnavailableException
server

The service is currently unavailable.

ThrottledClientException
client

The number of customer requests exceeds the request rate limit.

UnauthorizedClientException
client

The client isn't authorized to request a resource.

ChimeSDKVoiceServiceException
Base exception class for all service exceptions from ChimeSDKVoice service.