Amazon Web Services Phone Number API

openapi: 3.2.0
info:
  title: Amazon Web Services connect Phone Number API
  description: 'Amazon Connect is a cloud-based contact center solution that you use to set up and manage a customer contact center and provide reliable customer engagement at any scale.


    Amazon Connect provides metrics and real-time reporting that enable you to optimize contact routing. You can also resolve customer issues more efficiently by getting customers in touch with the appropriate agents.


    There are limits to the number of Amazon Connect resources that you can create. There are also limits to the number of requests that you can make per second. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.


    You can connect programmatically to an Amazon Web Services service by using an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints.'
tags:
- name: Phone Number
paths:
  /phone-number/{PhoneNumberId}/contact-flow:
    DELETE:
      summary: Amazon Web Services Disassociatephonenumbercontactflow
      description: Removes the flow association from a phone number claimed to your Amazon Connect instance. If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.
      operationId: amazonWebServicesDisassociatePhoneNumberContactFlow
      tags:
      - Phone Number
  /phone-number/claim:
    POST:
      summary: Amazon Web Services Claimphonenumber
      description: Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created. For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide. You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation. If you plan to claim and release numbers frequently during a 30 day period, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until 30 days past the oldest number released has expired. By default you can claim and release up to 200% of your maximum number of active phone numbers during any 30 day period. If you claim and release phone numbers using the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 30 days past the oldest number released has expired. For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 30 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
      operationId: amazonWebServicesClaimPhoneNumber
      tags:
      - Phone Number
  /phone-number/{PhoneNumberId}:
    PUT:
      summary: Amazon Web Services Updatephonenumber
      description: Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region. After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn't migrate the flow configuration of the phone number, too. You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation.
      operationId: amazonWebServicesUpdatePhoneNumber
      tags:
      - Phone Number
  /phone-number/import:
    POST:
      summary: Amazon Web Services Importphonenumber
      description: Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.
      operationId: amazonWebServicesImportPhoneNumber
      tags:
      - Phone Number
  /phone-number/list:
    POST:
      summary: Amazon Web Services Listphonenumbersv2
      description: 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. When given an instance ARN, ListPhoneNumbersV2 returns only the phone numbers claimed to the instance. When given a traffic distribution group ARN ListPhoneNumbersV2 returns only the phone numbers claimed to the traffic distribution group.
      operationId: amazonWebServicesListPhoneNumbersV2
      tags:
      - Phone Number
  /phone-number/search-available:
    POST:
      summary: Amazon Web Services Searchavailablephonenumbers
      description: Searches for available phone numbers that you can claim 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 the traffic distribution group.
      operationId: amazonWebServicesSearchAvailablePhoneNumbers
      tags:
      - Phone Number
  /phone-number/{PhoneNumberId}/metadata:
    PUT:
      summary: Amazon Web Services Updatephonenumbermetadata
      description: Updates a phone number’s metadata. To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.
      operationId: amazonWebServicesUpdatePhoneNumberMetadata
      tags:
      - Phone Number