Amazon Web Services, Inc.

AmazonConnectCampaignService

Provide APIs to create and manage Amazon Connect Campaigns.

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Provide APIs to create and manage Amazon Connect Campaigns.

Endpoints 22

  • PUTCreate campaign/campaignsCreates a campaign for the specified Amazon Connect account. This API is idempotent.
  • GETDescribe campaign/campaigns/:idDescribes the specific campaign.
  • DELETEDelete campaign/campaigns/:idDeletes a campaign from the specified Amazon Connect account.
  • GETGet connect instance config/connect-instance/:connectInstanceId/configGet the specific Connect instance config.
  • DELETEDelete connect instance config/connect-instance/:connectInstanceId/configDeletes a connect instance config from the specified AWS account.
  • GETGet instance onboarding job status/connect-instance/:connectInstanceId/onboardingGet the specific instance onboarding job status.
  • PUTStart instance onboarding job/connect-instance/:connectInstanceId/onboardingOnboard the specific Amazon Connect instance to Connect Campaigns.
  • DELETEDelete instance onboarding job/connect-instance/:connectInstanceId/onboardingDelete the Connect Campaigns onboarding job for the specified Amazon Connect instance.
  • GETGet campaign state/campaigns/:id/stateGet state of a campaign for the specified Amazon Connect account.
  • POSTGet campaign state batch/campaigns-stateGet state of campaigns for the specified Amazon Connect account.
  • POSTList campaigns/campaigns-summaryProvides summary information about the campaigns under the specified Amazon Connect account.
  • GETList tags for resource/tags/:arnList tags for a resource.
  • POSTTag resource/tags/:arnTag a resource.
  • DELETEUntag resource/tags/:arn?tagKeys=Untag a resource.
  • POSTPause campaign/campaigns/:id/pausePauses a campaign for the specified Amazon Connect account.
  • PUTPut dial request batch/campaigns/:id/dial-requestsCreates dials requests for the specified campaign Amazon Connect account. This API is idempotent.
  • POSTResume campaign/campaigns/:id/resumeStops a campaign for the specified Amazon Connect account.
  • POSTStart campaign/campaigns/:id/startStarts a campaign for the specified Amazon Connect account.
  • POSTStop campaign/campaigns/:id/stopStops a campaign for the specified Amazon Connect account.
  • POSTUpdate campaign dialer config/campaigns/:id/dialer-configUpdates the dialer config of a campaign. This API is idempotent.
  • POSTUpdate campaign name/campaigns/:id/nameUpdates the name of a campaign. This API is idempotent.
  • POSTUpdate campaign outbound call config/campaigns/:id/outbound-call-configUpdates the outbound call config of a campaign. This API is idempotent.

API details

Base URL
https://connect-campaigns.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
22 operations on 16 pathsPOST 10GET 5DELETE 4PUT 3
Description format
AWS Smithy model, API version 2021-01-30

How to test the AmazonConnectCampaignService in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AmazonConnectCampaignService collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create campaign” (PUT /campaigns), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AmazonConnectCampaignService?

Provide APIs to create and manage Amazon Connect Campaigns. It is listed under Developer tools and has 22 endpoints.

Who publishes the AmazonConnectCampaignService?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AmazonConnectCampaignService?

Requests go to https://connect-campaigns.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AmazonConnectCampaignService?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AmazonConnectCampaignService have?

22 operations on 16 paths (10 POST, 5 GET, 4 DELETE, 3 PUT).

Is forking the AmazonConnectCampaignService free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.