GetPhoneNumberOrderCommand

Suggest an Edit

Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ChimeSDKVoiceClient, GetPhoneNumberOrderCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
// const { ChimeSDKVoiceClient, GetPhoneNumberOrderCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
const client = new ChimeSDKVoiceClient(config);
const input = { // GetPhoneNumberOrderRequest
  PhoneNumberOrderId: "STRING_VALUE", // required
};
const command = new GetPhoneNumberOrderCommand(input);
const response = await client.send(command);
// { // GetPhoneNumberOrderResponse
//   PhoneNumberOrder: { // PhoneNumberOrder
//     PhoneNumberOrderId: "STRING_VALUE",
//     ProductType: "VoiceConnector" || "SipMediaApplicationDialIn",
//     Status: "Processing" || "Successful" || "Failed" || "Partial" || "PendingDocuments" || "Submitted" || "FOC" || "ChangeRequested" || "Exception" || "CancelRequested" || "Cancelled",
//     OrderType: "New" || "Porting",
//     OrderedPhoneNumbers: [ // OrderedPhoneNumberList
//       { // OrderedPhoneNumber
//         E164PhoneNumber: "STRING_VALUE",
//         Status: "Processing" || "Acquired" || "Failed",
//       },
//     ],
//     CreatedTimestamp: new Date("TIMESTAMP"),
//     UpdatedTimestamp: new Date("TIMESTAMP"),
//   },
// };

GetPhoneNumberOrderCommand Input

See GetPhoneNumberOrderCommandInput for more details

Parameter
Type
Description
PhoneNumberOrderId
Required
string | undefined

The ID of the phone number order .

GetPhoneNumberOrderCommand Output

See GetPhoneNumberOrderCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
PhoneNumberOrder
PhoneNumberOrder | undefined

The phone number order details.

Throws

Name
Fault
Details
BadRequestException
client

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

ForbiddenException
client

The client is permanently forbidden from making the request.

NotFoundException
client

The requested resource couldn't be found.

ServiceFailureException
server

The service encountered an unexpected error.

ServiceUnavailableException
server

The service is currently unavailable.

ThrottledClientException
client

The number of customer requests exceeds the request rate limit.

UnauthorizedClientException
client

The client isn't authorized to request a resource.

ChimeSDKVoiceServiceException
Base exception class for all service exceptions from ChimeSDKVoice service.