BatchDeletePhoneNumber
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.
Request Syntax
POST /phone-numbers?operation=batch-delete HTTP/1.1
Content-type: application/json
{
"PhoneNumberIds": [ "string
" ]
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- PhoneNumberIds
-
List of phone number IDs.
Type: Array of strings
Array Members: Minimum number of 1 item.
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"PhoneNumberErrors": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"PhoneNumberId": "string"
}
]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- PhoneNumberErrors
-
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.
Type: Array of PhoneNumberError objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
The input parameters don't match the service's restrictions.
HTTP Status Code: 400
- ForbiddenException
-
The client is permanently forbidden from making the request.
HTTP Status Code: 403
- NotFoundException
-
The requested resource couldn't be found.
HTTP Status Code: 404
- ServiceFailureException
-
The service encountered an unexpected error.
HTTP Status Code: 500
- ServiceUnavailableException
-
The service is currently unavailable.
HTTP Status Code: 503
- ThrottledClientException
-
The number of customer requests exceeds the request rate limit.
HTTP Status Code: 429
- UnauthorizedClientException
-
The client isn't authorized to request a resource.
HTTP Status Code: 401
Examples
In the following example or examples, the Authorization header contents(
AUTHPARAMS
) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see
Signature Version 4 Signing Process
in the
AWS General Reference.
You only need to learn how to sign HTTP requests if you intend to manually create them. When
you use the AWS Command Line Interface (AWS
CLI)
Example
This example moves multiple phone numbers into the Deletion queue .
Sample Request
POST /phone-numbers?operation=batch-delete HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190918T195348Z Authorization: AUTHPARAMS Content-Length: 56 {"PhoneNumberIds": ["%2B12065550100", "%2B12065550101"]}
Sample Response
HTTP/1.1 200 OK x-amzn-RequestId: f6ac5632-e71a-4755-997b-971c4dbff22c Content-Type: application/json Content-Length: 24 Date: Wed, 18 Sep 2019 19:53:49 GMT Connection: keep-alive {"PhoneNumberErrors":[]}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: