UpdatePhoneNumber
Updates phone number details, such as product type, calling name, or phone number name for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type, calling name, or phone number name in one action.
For numbers outside the U.S., you must use the Amazon Chime SDK SIP Media Application Dial-In product type.
Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
Request Syntax
POST /phone-numbers/phoneNumberId HTTP/1.1
Content-type: application/json
{
"CallingName": "string",
"Name": "string",
"ProductType": "string"
}URI Request Parameters
The request uses the following URI parameters.
- phoneNumberId
-
The phone number ID.
Pattern:
.*\S.*Required: Yes
Request Body
The request accepts the following data in JSON format.
- CallingName
-
The outbound calling name associated with the phone number.
Type: String
Pattern:
^$|^[a-zA-Z0-9 ]{2,15}$Required: No
- Name
-
Specifies the updated name assigned to one or more phone numbers.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
^$|^[a-zA-Z0-9\,\.\_\-]+(\s+[a-zA-Z0-9\,\.\_\-]+)*$Required: No
- ProductType
-
The product type.
Type: String
Valid Values:
VoiceConnector | SipMediaApplicationDialInRequired: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"PhoneNumber": {
"Associations": [
{
"AssociatedTimestamp": "string",
"Name": "string",
"Value": "string"
}
],
"CallingName": "string",
"CallingNameStatus": "string",
"Capabilities": {
"InboundCall": boolean,
"InboundMMS": boolean,
"InboundSMS": boolean,
"OutboundCall": boolean,
"OutboundMMS": boolean,
"OutboundSMS": boolean
},
"Country": "string",
"CreatedTimestamp": "string",
"DeletionTimestamp": "string",
"E164PhoneNumber": "string",
"Name": "string",
"OrderId": "string",
"PhoneNumberId": "string",
"ProductType": "string",
"Status": "string",
"Type": "string",
"UpdatedTimestamp": "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.
- PhoneNumber
-
The updated phone number details.
Type: PhoneNumber object
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
- ConflictException
-
Multiple instances of the same request were made simultaneously.
HTTP Status Code: 409
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
