The Amazon Chime SDK Identity, Media Pipelines, Meetings, and Messaging APIs are now published on the new Amazon Chime SDK API Reference. For more information, see the Amazon Chime SDK API Reference.
BatchUpdatePhoneNumber
Updates phone number product types or calling names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem
. For example, you can update the product type or the calling name.
For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.
Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
Request Syntax
POST /phone-numbers?operation=batch-update HTTP/1.1
Content-type: application/json
{
"UpdatePhoneNumberRequestItems": [
{
"CallingName": "string
",
"PhoneNumberId": "string
",
"ProductType": "string
"
}
]
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- UpdatePhoneNumberRequestItems
-
The request containing the phone number IDs and product types or calling names to update.
Type: Array of UpdatePhoneNumberRequestItem objects
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
-
One or more of the resources in the request does not exist in the system.
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 client exceeded its request rate limit.
HTTP Status Code: 429
- UnauthorizedClientException
-
The client is not currently authorized to make the request.
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: Update Product Types
This example updates the product type for multiple phone numbers.
Sample Request
POST /phone-numbers?operation=batch-update 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: 20190918T195200Z Authorization: AUTHPARAMS Content-Length: 177 {"UpdatePhoneNumberRequestItems": [{"PhoneNumberId": "%2B12065550100", "ProductType": "BusinessCalling"}, {"PhoneNumberId": "%2B12065550101", "ProductType": "Voice Connector"}]}
Sample Response
HTTP/1.1 200 OK x-amzn-RequestId: 78f4ee00-d8e0-4a13-b24e-147557576368 Content-Type: application/json Content-Length: 24 Date: Wed, 18 Sep 2019 19:52:01 GMT Connection: keep-alive {"PhoneNumberErrors":[]}
Example: Update Outbound Calling Names
This example updates the outbound calling name for multiple phone numbers.
Sample Request
POST /phone-numbers?operation=batch-update 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: 20191028T183405Z Authorization: AUTHPARAMS Content-Length: 171 {"UpdatePhoneNumberRequestItems": [{"PhoneNumberId": "%2B12065550100", "CallingName": "phonenumber1"}, {"PhoneNumberId": "%2B12065550101", "CallingName": "phonenumber2"}]}
Sample Response
HTTP/1.1 200 OK x-amzn-RequestId: 32f678c1-21d2-43ab-ac8f-cd922c1ab42e Content-Type: application/json Content-Length: 24 Date: Mon, 28 Oct 2019 18:34:05 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: