Amazon Chime SDK Chime Phone Number Orders API
The Chime Phone Number Orders API from Amazon Chime SDK — 2 operation(s) for chime phone number orders.
The Chime Phone Number Orders API from Amazon Chime SDK — 2 operation(s) for chime phone number orders.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/amazon-chime:amazon-chime-phone-number-orders-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.1.0
info:
title: Amazon Chime SDK Meetings Phone Number Orders API
version: '2021-07-15'
description: Generated from AWS's published Smithy model for Amazon Chime SDK Meetings. 3 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://voice-chime.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
paths:
/phone-number-orders:
post:
operationId: CreatePhoneNumberOrder
summary: Create Phone Number Order
description: Creates an order for phone numbers to be provisioned. For numbers outside the U.S., you must use the Amazon
Chime SDK SIP media application dial-in product type.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePhoneNumberOrderResponse'
'403':
description: AccessDeniedException; ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'400':
description: BadRequestException; ResourceLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeBadRequestException'
'500':
description: ServiceFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeServiceFailureException'
'503':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeServiceUnavailableException'
'429':
description: ThrottledClientException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeThrottledClientException'
'401':
description: UnauthorizedClientException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeUnauthorizedClientException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePhoneNumberOrderRequest'
tags:
- Phone Number Orders
get:
operationId: ListPhoneNumberOrders
summary: List Phone Number Orders
description: Lists the phone numbers for an administrator's Amazon Chime SDK account.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListPhoneNumberOrdersResponse'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeBadRequestException'
'403':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeForbiddenException'
'500':
description: ServiceFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeServiceFailureException'
'503':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeServiceUnavailableException'
'429':
description: ThrottledClientException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeThrottledClientException'
'401':
description: UnauthorizedClientException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeUnauthorizedClientException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListPhoneNumberOrdersRequest'
tags:
- Phone Number Orders
/phone-number-orders/{PhoneNumberOrderId}:
get:
operationId: GetPhoneNumberOrder
summary: Get Phone Number Order
description: 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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetPhoneNumberOrderResponse'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeBadRequestException'
'403':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeForbiddenException'
'404':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeNotFoundException'
'500':
description: ServiceFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeServiceFailureException'
'503':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeServiceUnavailableException'
'429':
description: ThrottledClientException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeThrottledClientException'
'401':
description: UnauthorizedClientException
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceChimeUnauthorizedClientException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetPhoneNumberOrderRequest'
tags:
- Phone Number Orders
components:
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: chime
schemas:
AccessDeniedException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
- Gone
- Validation
Message:
type: string
CreatePhoneNumberOrderRequest:
type: object
properties:
ProductType:
type: string
enum:
- VoiceConnector
- SipMediaApplicationDialIn
description: The phone number product type.
E164PhoneNumbers:
type: array
items:
type: string
description: List of phone numbers, in E.164 format.
Name:
type: string
description: Specifies the name assigned to one or more phone numbers.
required:
- ProductType
- E164PhoneNumbers
CreatePhoneNumberOrderResponse:
type: object
properties:
PhoneNumberOrder:
$ref: '#/components/schemas/PhoneNumberOrder'
GetPhoneNumberOrderRequest:
type: object
properties:
PhoneNumberOrderId:
type: string
description: The ID of the phone number order .
required:
- PhoneNumberOrderId
GetPhoneNumberOrderResponse:
type: object
properties:
PhoneNumberOrder:
$ref: '#/components/schemas/PhoneNumberOrder'
ListPhoneNumberOrdersRequest:
type: object
properties:
NextToken:
type: string
description: The token used to retrieve the next page of results.
MaxResults:
type: integer
description: The maximum number of results to return in a single call.
ListPhoneNumberOrdersResponse:
type: object
properties:
PhoneNumberOrders:
type: array
items:
$ref: '#/components/schemas/PhoneNumberOrder'
description: The phone number order details.
NextToken:
type: string
description: The token used to retrieve the next page of results.
OrderedPhoneNumber:
type: object
properties:
E164PhoneNumber:
type: string
description: The phone number, in E.164 format.
Status:
type: string
enum:
- Processing
- Acquired
- Failed
description: The phone number status.
PhoneNumberOrder:
type: object
properties:
PhoneNumberOrderId:
type: string
description: The ID of the phone order.
ProductType:
type: string
enum:
- VoiceConnector
- SipMediaApplicationDialIn
description: The phone number order product type.
Status:
type: string
enum:
- Processing
- Successful
- Failed
- Partial
- PendingDocuments
- Submitted
- FOC
- ChangeRequested
- Exception
- CancelRequested
- Cancelled
description: The status of the phone number order.
OrderType:
type: string
enum:
- New
- Porting
description: The type of phone number being ordered, local or toll-free.
OrderedPhoneNumbers:
type: array
items:
$ref: '#/components/schemas/OrderedPhoneNumber'
description: The ordered phone number details, such as the phone number in E.164 format and the phone number status.
CreatedTimestamp:
type: string
format: date-time
description: The phone number order creation time stamp, in ISO 8601 format.
UpdatedTimestamp:
type: string
format: date-time
description: The updated phone number order time stamp, in ISO 8601 format.
FocDate:
type: string
description: The Firm Order Commitment (FOC) date for phone number porting orders. This field is null if a phone
number order is not a porting order.
VoiceChimeBadRequestException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
- Gone
- Validation
Message:
type: string
VoiceChimeForbiddenException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
- Gone
- Validation
Message:
type: string
VoiceChimeNotFoundException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
- Gone
- Validation
Message:
type: string
VoiceChimeServiceFailureException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
- Gone
- Validation
Message:
type: string
VoiceChimeServiceUnavailableException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
- Gone
- Validation
Message:
type: string
VoiceChimeThrottledClientException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
- Gone
- Validation
Message:
type: string
VoiceChimeUnauthorizedClientException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
- Gone
- Validation
Message:
type: string
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/chime-sdk-voice/service/2022-08-03/chime-sdk-voice-2022-08-03.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)