Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

Describes the specified origination phone number, or all the phone numbers in your account.

If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers.

If you specify a phone number ID that isn't valid, an error is returned.

post/#X-Amz-Target=PinpointSMSVoiceV2.DescribePhoneNumbers

Headers

X-Amz-Target'PinpointSMSVoiceV2.DescribePhoneNumbers' required

Request body

PhoneNumberIdsPhoneNumberIdOrArn[]
<p>The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.</p> <important> <p>If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p> </important>
NextTokenstring

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

MaxResultsinteger

The maximum number of results to return per each request.

Owner'SELF' | 'SHARED'

Use <code>SELF</code> to filter the list of phone numbers to ones your account owns or use <code>SHARED</code> to filter on phone numbers shared with your account. The <code>Owner</code> and <code>PhoneNumberIds</code> parameters can't be used at the same time.

Response

Success

NextTokenstring

The token to be used for the next set of paginated results. If this field is empty then there are no more results.