Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14171791756.1 KB

Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group.

For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.

post/phone-number/list

Query parameters

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

Request body

TargetArnstring

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to. If <code>TargetArn</code> input is not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same Amazon Web Services Region as the request.

MaxResultsinteger

The maximum number of results to return per page.

NextTokenstring

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

PhoneNumberCountryCodesPhoneNumberCountryCode[]

The ISO country code.

PhoneNumberTypesPhoneNumberType[]

The type of phone number.

PhoneNumberPrefixstring

The prefix of the phone number. If provided, it must contain <code>+</code> as part of the country code.

Response

Success

NextTokenstring

If there are additional results, this is the token for the next set of results.