GetPhoneNumberSettings - Amazon Chime SDK


Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.

Request Syntax

GET /settings/phone-number HTTP/1.1

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "CallingName": "string", "CallingNameUpdatedTimestamp": "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.


The default outbound calling name for the account.

Type: String

Pattern: ^$|^[a-zA-Z0-9 ]{2,15}$


The updated outbound calling name timestamp, in ISO 8601 format.

Type: Timestamp


For information about the errors that are common to all actions, see Common Errors.


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

HTTP Status Code: 400


The client is permanently forbidden from making the request.

HTTP Status Code: 403


The service encountered an unexpected error.

HTTP Status Code: 500


The service is currently unavailable.

HTTP Status Code: 503


The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429


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: