Amazon Chime SDK Chime Phone Numbers API

openapi: 3.1.0
info:
  title: Amazon Chime SDK Meetings Phone Numbers API
  version: '2021-07-15'
  description: Generated from AWS's published Smithy model for Amazon Chime SDK Meetings. 6 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-numbers?operation=batch-delete:
    post:
      operationId: BatchDeletePhoneNumber
      summary: Batch Delete Phone Number
      description: Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon
        Chime SDK Voice Connectors before they can be deleted. Phone numbers remain in the Deletion queue for 7 days before
        they are deleted permanently.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchDeletePhoneNumberResponse'
        '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/BatchDeletePhoneNumberRequest'
      tags:
      - Phone Numbers
  /phone-numbers?operation=batch-update:
    post:
      operationId: BatchUpdatePhoneNumber
      summary: Batch Update Phone Number
      description: Updates phone number product types, calling names, or phone number names. You can update one attribute
        at a time for each UpdatePhoneNumberRequestItem. For example, you can update the product type, the calling name, or
        phone name. You cannot have a duplicate phoneNumberId in a request.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchUpdatePhoneNumberResponse'
        '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/BatchUpdatePhoneNumberRequest'
      tags:
      - Phone Numbers
  /phone-numbers/{PhoneNumberId}:
    delete:
      operationId: DeletePhoneNumber
      summary: Delete Phone Number
      description: Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any
        users or Amazon Chime SDK Voice Connectors before it can be deleted. Deleted phone numbers remain in the Deletion
        queue queue for 7 days before they are deleted permanently.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '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/DeletePhoneNumberRequest'
      tags:
      - Phone Numbers
    get:
      operationId: GetPhoneNumber
      summary: Get Phone Number
      description: Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPhoneNumberResponse'
        '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/GetPhoneNumberRequest'
      tags:
      - Phone Numbers
    post:
      operationId: UpdatePhoneNumber
      summary: Update Phone Number
      description: Updates phone number details, such as product type, calling name, or phone number name for the specified
        phone number ID. You can update one phone number detail at a time. For example, you can update either the product
        type, calling name, or phone number name in one action. For numbers outside the U.S., you must use the Amazon Chime
        SDK SIP Media Application Dial-In product type. Updates to outbound calling names can take 72 hours to complete. Pending
        updates to outbound calling names must be complete before you can request another update.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePhoneNumberResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeBadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeConflictException'
        '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/UpdatePhoneNumberRequest'
      tags:
      - Phone Numbers
  /phone-numbers:
    get:
      operationId: ListPhoneNumbers
      summary: List Phone Numbers
      description: Lists the phone numbers for the specified Amazon Chime SDK account, Amazon Chime SDK user, Amazon Chime
        SDK Voice Connector, or Amazon Chime SDK Voice Connector group.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPhoneNumbersResponse'
        '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/ListPhoneNumbersRequest'
      tags:
      - Phone Numbers
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:
    BatchDeletePhoneNumberRequest:
      type: object
      properties:
        PhoneNumberIds:
          type: array
          items:
            type: string
          description: List of phone number IDs.
      required:
      - PhoneNumberIds
    BatchDeletePhoneNumberResponse:
      type: object
      properties:
        PhoneNumberErrors:
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumberError'
          description: If the action fails for one or more of the phone numbers in the request, a list of the phone numbers
            is returned, along with error codes and error messages.
    BatchUpdatePhoneNumberRequest:
      type: object
      properties:
        UpdatePhoneNumberRequestItems:
          type: array
          items:
            $ref: '#/components/schemas/UpdatePhoneNumberRequestItem'
          description: Lists the phone numbers in the update request.
      required:
      - UpdatePhoneNumberRequestItems
    BatchUpdatePhoneNumberResponse:
      type: object
      properties:
        PhoneNumberErrors:
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumberError'
          description: A list of failed phone numbers and their error messages.
    DeletePhoneNumberRequest:
      type: object
      properties:
        PhoneNumberId:
          type: string
          description: The phone number ID.
      required:
      - PhoneNumberId
    GetPhoneNumberRequest:
      type: object
      properties:
        PhoneNumberId:
          type: string
          description: The phone number ID.
      required:
      - PhoneNumberId
    GetPhoneNumberResponse:
      type: object
      properties:
        PhoneNumber:
          $ref: '#/components/schemas/PhoneNumber'
    ListPhoneNumbersRequest:
      type: object
      properties:
        Status:
          type: string
          description: The status of your organization's phone numbers.
        ProductType:
          type: string
          enum:
          - VoiceConnector
          - SipMediaApplicationDialIn
          description: The phone number product types.
        FilterName:
          type: string
          enum:
          - VoiceConnectorId
          - VoiceConnectorGroupId
          - SipRuleId
          description: The filter to limit the number of results.
        FilterValue:
          type: string
          description: The filter value.
        MaxResults:
          type: integer
          description: The maximum number of results to return in a single call.
        NextToken:
          type: string
          description: The token used to return the next page of results.
    ListPhoneNumbersResponse:
      type: object
      properties:
        PhoneNumbers:
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumber'
          description: The phone number details.
        NextToken:
          type: string
          description: The token used to return the next page of results.
    PhoneNumber:
      type: object
      properties:
        PhoneNumberId:
          type: string
          description: The phone number's ID.
        E164PhoneNumber:
          type: string
          description: The phone number, in E.164 format.
        PhoneNumberArn:
          type: string
        Country:
          type: string
          description: 'The phone number''s country. Format: ISO 3166-1 alpha-2.'
        Type:
          type: string
          enum:
          - Local
          - TollFree
          description: The phone number's type.
        ProductType:
          type: string
          enum:
          - VoiceConnector
          - SipMediaApplicationDialIn
          description: The phone number's product type.
        Status:
          type: string
          enum:
          - Cancelled
          - PortinCancelRequested
          - PortinInProgress
          - AcquireInProgress
          - AcquireFailed
          - Unassigned
          - Assigned
          - ReleaseInProgress
          - DeleteInProgress
          - ReleaseFailed
          - DeleteFailed
          description: The phone number's status.
        Capabilities:
          $ref: '#/components/schemas/PhoneNumberCapabilities'
        Associations:
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumberAssociation'
          description: The phone number's associations.
        CallingName:
          type: string
          description: The outbound calling name associated with the phone number.
        CallingNameStatus:
          type: string
          enum:
          - Unassigned
          - UpdateInProgress
          - UpdateSucceeded
          - UpdateFailed
          description: The outbound calling name status.
        CreatedTimestamp:
          type: string
          format: date-time
          description: The phone number creation timestamp, in ISO 8601 format.
        UpdatedTimestamp:
          type: string
          format: date-time
          description: The updated phone number timestamp, in ISO 8601 format.
        DeletionTimestamp:
          type: string
          format: date-time
          description: The deleted phone number timestamp, in ISO 8601 format.
        OrderId:
          type: string
          description: The phone number's order ID.
        Name:
          type: string
          description: The name of the phone number.
    PhoneNumberAssociation:
      type: object
      properties:
        Value:
          type: string
          description: Contains the ID for the entity specified in Name.
        Name:
          type: string
          enum:
          - VoiceConnectorId
          - VoiceConnectorGroupId
          - SipRuleId
          description: Defines the association with an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice
            Connector group ID.
        AssociatedTimestamp:
          type: string
          format: date-time
          description: The timestamp of the phone number association, in ISO 8601 format.
    PhoneNumberCapabilities:
      type: object
      properties:
        InboundCall:
          type: boolean
          description: Allows or denies inbound calling for the specified phone number.
        OutboundCall:
          type: boolean
          description: Allows or denies outbound calling for the specified phone number.
        InboundSMS:
          type: boolean
          description: Allows or denies inbound SMS messaging for the specified phone number.
        OutboundSMS:
          type: boolean
          description: Allows or denies outbound SMS messaging for the specified phone number.
        InboundMMS:
          type: boolean
          description: Allows or denies inbound MMS messaging for the specified phone number.
        OutboundMMS:
          type: boolean
          description: Allows or denies inbound MMS messaging for the specified phone number.
    PhoneNumberError:
      type: object
      properties:
        PhoneNumberId:
          type: string
          description: The phone number ID for which the action failed.
        ErrorCode:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
          - Gone
          - Validation
          description: The error code.
        ErrorMessage:
          type: string
          description: The error message.
    UpdatePhoneNumberRequest:
      type: object
      properties:
        PhoneNumberId:
          type: string
          description: The phone number ID.
        ProductType:
          type: string
          enum:
          - VoiceConnector
          - SipMediaApplicationDialIn
          description: The product type.
        CallingName:
          type: string
          description: The outbound calling name associated with the phone number.
        Name:
          type: string
          description: Specifies the updated name assigned to one or more phone numbers.
      required:
      - PhoneNumberId
    UpdatePhoneNumberRequestItem:
      type: object
      properties:
        PhoneNumberId:
          type: string
          description: The phone number ID to update.
        ProductType:
          type: string
          enum:
          - VoiceConnector
          - SipMediaApplicationDialIn
          description: The product type to update.
        CallingName:
          type: string
          description: The outbound calling name to update.
        Name:
          type: string
          description: The name of the phone number.
      required:
      - PhoneNumberId
    UpdatePhoneNumberResponse:
      type: object
      properties:
        PhoneNumber:
          $ref: '#/components/schemas/PhoneNumber'
    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
    VoiceChimeConflictException:
      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)