Open documentation ↗Overview
<p>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.</p> <p>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.</p> <p>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 <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <p>You can connect programmatically to an Amazon Web Services service by using an endpoint. For a list of Amazon Connect endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect Endpoints</a>.</p>
Amazon Connect Service is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 171 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Cloud Platforms
- Version
- 2017-08-08
- Endpoints
- 171
- OpenAPI
- Specification ↗
- Spec updated
- 2020-03-11
Endpoints
| Method | Path | What it does |
|---|---|---|
| PUT | /instance/{InstanceId}/approved-origin | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Associates an approved origin to an Amazon Connect instance.</p> |
| POST | /instance/{InstanceId}/bot | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Revokes authorization from the specified instance to access the specified |
| PUT | /instance/{InstanceId}/bot | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Allows the specified Amazon Connect instance to access the specified Amazo |
| PUT | /default-vocabulary/{InstanceId}/{LanguageCode} | Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given |
| PUT | /instance/{InstanceId}/storage-config | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Associates a storage resource type for the first time. You can only associ |
| PUT | /instance/{InstanceId}/lambda-function | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Allows the specified Amazon Connect instance to access the specified Lambd |
| PUT | /instance/{InstanceId}/lex-bot | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Allows the specified Amazon Connect instance to access the specified Amazo |
| PUT | /phone-number/{PhoneNumberId}/contact-flow | <p>Associates a flow with a phone number claimed to your Amazon Connect instance.</p> <important> <p>If the number is claimed to a traffic distribution group, a |
| POST | /queues/{InstanceId}/{QueueId}/associate-quick-connects | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Associates a set of quick connects with a queue.</p> |
| POST | /routing-profiles/{InstanceId}/{RoutingProfileId}/associate-queues | Associates a set of queues with a routing profile. |
| PUT | /instance/{InstanceId}/security-key | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Associates a security key to the instance.</p> |
| POST | /phone-number/claim | <p>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 Re |
| GET | /agent-status/{InstanceId} | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Lists agent statuses.</p> |
| PUT | /agent-status/{InstanceId} | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Creates an agent status for the specified Amazon Connect instance.</p> |
| PUT | /contact-flows/{InstanceId} | <p>Creates a flow for the specified Amazon Connect instance.</p> <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/ |
| PUT | /contact-flow-modules/{InstanceId} | Creates a flow module for the specified Amazon Connect instance. |
| PUT | /hours-of-operations/{InstanceId} | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Creates hours of operation. </p> |
| GET | /instance | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Return a list of instances which are in active state, creation-in-progress |
| PUT | /instance | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Initiates an Amazon Connect instance with all the supported channels enabl |
| GET | /instance/{InstanceId}/integration-associations | Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance. |
| PUT | /instance/{InstanceId}/integration-associations | Creates an Amazon Web Services resource association with an Amazon Connect instance. |
| POST | /contact/create-participant | Adds a new participant into an on-going chat contact. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-customize-fl |
| PUT | /queues/{InstanceId} | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Creates a new queue for the specified Amazon Connect instance.</p> <import |
| GET | /quick-connects/{InstanceId} | Provides information about the quick connects for the specified Amazon Connect instance. |
| PUT | /quick-connects/{InstanceId} | Creates a quick connect for the specified Amazon Connect instance. |
| PUT | /routing-profiles/{InstanceId} | Creates a new routing profile. |
| GET | /rules/{InstanceId} | List all rules for the specified Amazon Connect instance. |
| POST | /rules/{InstanceId} | <p>Creates a rule for the specified Amazon Connect instance.</p> <p>Use the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/connect-rules-langu |
| PUT | /security-profiles/{InstanceId} | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Creates a security profile.</p> |
| GET | /instance/{InstanceId}/task/template | Lists task templates for the specified Amazon Connect instance. |
| PUT | /instance/{InstanceId}/task/template | Creates a new task template in the specified Amazon Connect instance. |
| PUT | /traffic-distribution-group | <p>Creates a traffic distribution group given an Amazon Connect instance that has been replicated. </p> <p>For more information about creating traffic distribut |
| GET | /instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases | Lists the use cases for the integration association. |
| PUT | /instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases | Creates a use case for an integration association. |
| PUT | /users/{InstanceId} | <p>Creates a user account for the specified Amazon Connect instance.</p> <p>For information about how to create user accounts using the Amazon Connect console, |
| PUT | /user-hierarchy-groups/{InstanceId} | Creates a new user hierarchy group. |
| POST | /vocabulary/{InstanceId} | Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Co |
| GET | /contact-flows/{InstanceId}/{ContactFlowId} | <p>Describes the specified flow.</p> <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-lan |
| DELETE | /contact-flows/{InstanceId}/{ContactFlowId} | Deletes a flow for the specified Amazon Connect instance. |
| GET | /contact-flow-modules/{InstanceId}/{ContactFlowModuleId} | Describes the specified flow module. |
| DELETE | /contact-flow-modules/{InstanceId}/{ContactFlowModuleId} | Deletes the specified flow module. |
| GET | /hours-of-operations/{InstanceId}/{HoursOfOperationId} | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Describes the hours of operation.</p> |
| POST | /hours-of-operations/{InstanceId}/{HoursOfOperationId} | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates the hours of operation.</p> |
| DELETE | /hours-of-operations/{InstanceId}/{HoursOfOperationId} | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Deletes an hours of operation.</p> |
| GET | /instance/{InstanceId} | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Returns the current state of the specified instance identifier. It tracks |
| DELETE | /instance/{InstanceId} | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Deletes the Amazon Connect instance.</p> <p>Amazon Connect enforces a limi |
| DELETE | /instance/{InstanceId}/integration-associations/{IntegrationAssociationId} | Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it. |
| GET | /quick-connects/{InstanceId}/{QuickConnectId} | Describes the quick connect. |
| DELETE | /quick-connects/{InstanceId}/{QuickConnectId} | Deletes a quick connect. |
| GET | /rules/{InstanceId}/{RuleId} | Describes a rule for the specified Amazon Connect instance. |
| PUT | /rules/{InstanceId}/{RuleId} | <p>Updates a rule for the specified Amazon Connect instance.</p> <p>Use the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/connect-rules-langu |
| DELETE | /rules/{InstanceId}/{RuleId} | Deletes a rule for the specified Amazon Connect instance. |
| GET | /security-profiles/{InstanceId}/{SecurityProfileId} | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Gets basic information about the security profle.</p> |
| POST | /security-profiles/{InstanceId}/{SecurityProfileId} | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates a security profile.</p> |
| DELETE | /security-profiles/{InstanceId}/{SecurityProfileId} | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Deletes a security profile.</p> |
| GET | /instance/{InstanceId}/task/template/{TaskTemplateId} | Gets details about a specific task template in the specified Amazon Connect instance. |
| POST | /instance/{InstanceId}/task/template/{TaskTemplateId} | Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full |
| DELETE | /instance/{InstanceId}/task/template/{TaskTemplateId} | Deletes the task template. |
| GET | /traffic-distribution-group/{TrafficDistributionGroupId} | Gets details and status of a traffic distribution group. |
| DELETE | /traffic-distribution-group/{TrafficDistributionGroupId} | <p>Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.</p> <p>For more information |
| DELETE | /instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases/{UseCaseId} | Deletes a use case from an integration association. |
| GET | /users/{InstanceId}/{UserId} | Describes the specified user account. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID in the |
| DELETE | /users/{InstanceId}/{UserId} | <p>Deletes a user account from the specified Amazon Connect instance.</p> <p>For information about what happens to a user's data when their account is deleted, |
| GET | /user-hierarchy-groups/{InstanceId}/{HierarchyGroupId} | Describes the specified hierarchy group. |
| DELETE | /user-hierarchy-groups/{InstanceId}/{HierarchyGroupId} | Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups. |
| POST | /vocabulary-remove/{InstanceId}/{VocabularyId} | Deletes the vocabulary that has the given identifier. |
| GET | /agent-status/{InstanceId}/{AgentStatusId} | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Describes an agent status.</p> |
| POST | /agent-status/{InstanceId}/{AgentStatusId} | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates agent status.</p> |
| GET | /contacts/{InstanceId}/{ContactId} | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Describes the specified contact. </p> <important> <p>Contact information r |
| POST | /contacts/{InstanceId}/{ContactId} | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Adds or updates user-defined contact information associated with the speci |
| GET | /instance/{InstanceId}/attribute/{AttributeType} | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Describes the specified instance attribute.</p> |
| POST | /instance/{InstanceId}/attribute/{AttributeType} | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates the value for the specified attribute type.</p> |
| GET | /instance/{InstanceId}/storage-config/{AssociationId}#resourceType | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Retrieves the current storage configurations for the specified resource ty |
| POST | /instance/{InstanceId}/storage-config/{AssociationId}#resourceType | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates an existing configuration for a resource type. This API is idempot |
| DELETE | /instance/{InstanceId}/storage-config/{AssociationId}#resourceType | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Removes the storage type configurations for the specified resource type an |
| GET | /phone-number/{PhoneNumberId} | <p>Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.</p> <important> <p>If the number is c |
| PUT | /phone-number/{PhoneNumberId} | <p>Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distri |
| DELETE | /phone-number/{PhoneNumberId} | <p>Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services |
| GET | /queues/{InstanceId}/{QueueId} | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Describes the specified queue.</p> |
| GET | /routing-profiles/{InstanceId}/{RoutingProfileId} | Describes the specified routing profile. |
| GET | /user-hierarchy-structure/{InstanceId} | Describes the hierarchy structure of the specified Amazon Connect instance. |
| POST | /user-hierarchy-structure/{InstanceId} | Updates the user hierarchy structure: add, remove, and rename user hierarchy levels. |
| GET | /vocabulary/{InstanceId}/{VocabularyId} | Describes the specified vocabulary. |
| DELETE | /instance/{InstanceId}/approved-origin#origin | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Revokes access to integrated applications from Amazon Connect.</p> |
| DELETE | /instance/{InstanceId}/lambda-function#functionArn | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Remove the Lambda function from the dropdown options available in the rele |
| DELETE | /instance/{InstanceId}/lex-bot#botName&lexRegion | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Revokes authorization from the specified instance to access the specified |
| DELETE | /phone-number/{PhoneNumberId}/contact-flow#instanceId | <p>Removes the flow association from a phone number claimed to your Amazon Connect instance.</p> <important> <p>If the number is claimed to a traffic distributi |
| POST | /queues/{InstanceId}/{QueueId}/disassociate-quick-connects | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Disassociates a set of quick connects from a queue.</p> |
| POST | /routing-profiles/{InstanceId}/{RoutingProfileId}/disassociate-queues | Disassociates a set of queues from a routing profile. |
| DELETE | /instance/{InstanceId}/security-key/{AssociationId} | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Deletes the specified security key.</p> |
| POST | /users/{InstanceId}/{UserId}/contact | Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be |
| GET | /contact/attributes/{InstanceId}/{InitialContactId} | Retrieves the contact attributes for the specified contact. |
| POST | /metrics/current/{InstanceId} | <p>Gets the real-time metric data from the specified Amazon Connect instance.</p> <p>For a description of each metric, see <a href="https://docs.aws.amazon.com/ |
| POST | /metrics/userdata/{InstanceId} | Gets the real-time active user data from the specified Amazon Connect instance. |
| GET | /user/federate/{InstanceId} | <p>Retrieves a token for federation.</p> <note> <p>This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error |
| POST | /metrics/historical/{InstanceId} | <p>Gets historical metric data from the specified Amazon Connect instance.</p> <p>For a description of each historical metric, see <a href="https://docs.aws.ama |
| POST | /metrics/data | <p>Gets metric data from the specified Amazon Connect instance. </p> <p> <code>GetMetricDataV2</code> offers more features than <a href="https://docs.aws.amazon |
| GET | /traffic-distribution/{Id} | Retrieves the current traffic distribution for a given traffic distribution group. |
| PUT | /traffic-distribution/{Id} | <p>Updates the traffic distribution for a given traffic distribution group. </p> <p>For more information about updating a traffic distribution group, see <a hre |
| GET | /instance/{InstanceId}/approved-origins | <p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Returns a paginated list of all approved origins associated with the insta |
Showing the first 100 of 171 endpoints; the full list is in the documentation.
Questions
Does the Amazon Connect Service API need an API key?
Yes. The Amazon Connect Service API uses API key authentication; the documentation explains how to get credentials.
Does the Amazon Connect Service API support HTTPS?
Yes, the Amazon Connect Service API is served over HTTPS.
How many endpoints does the Amazon Connect Service API have?
Its OpenAPI description lists 171 endpoints in version 2017-08-08. The first 100 are shown on this page.
What are alternatives to the Amazon Connect Service API?
Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.
Similar cloud platforms APIs
Compare alternatives →Remote Settings PROD
Cloud PlatformsFirefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.
Linode API
Cloud Platforms## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se
DigitalOcean API
Cloud Platforms# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having
Vercel API
Cloud PlatformsVercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.
Platform API
Cloud PlatformsThe [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.
Azure Data Lake Storage
Cloud PlatformsAzure Data Lake Storage provides storage for Hadoop and other big data workloads.
Listed from APIs.guru (CC0).