CreateCampaign
Creates an outbound campaign.
Note
-
For users to be able to view or edit a campaign at a later date by using the Amazon Connect user interface, you must add the instance ID as a tag.
-
After a campaign is saved, you can't change the dialer type for an agentless campaign, and you can't change the dialer type to agentless for progressive and predictive campaigns.
Request Syntax
PUT /campaigns HTTP/1.1
Content-type: application/json
{
"connectInstanceId": "string
",
"dialerConfig": { ... },
"name": "string
",
"outboundCallConfig": {
"answerMachineDetectionConfig": {
"awaitAnswerMachinePrompt": boolean
,
"enableAnswerMachineDetection": boolean
},
"connectContactFlowId": "string
",
"connectQueueId": "string
",
"connectSourcePhoneNumber": "string
"
},
"tags": {
"string
" : "string
"
}
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- connectInstanceId
-
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
^[a-zA-Z0-9_\-.]*$
Required: Yes
- dialerConfig
-
Dialer configuration for an outbound campaign.
Type: DialerConfig object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
- name
-
The name of the campaign.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 127.
Required: Yes
- outboundCallConfig
-
Outbound call configuration for an outbound campaign.
Type: OutboundCallConfig object
Required: Yes
-
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[a-zA-Z+-=._:/]+$
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"id": "string",
"tags": {
"string" : "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- arn
-
The Amazon Resource Name (ARN).
Type: String
Length Constraints: Minimum length of 20. Maximum length of 500.
- id
-
The identifier of the campaign.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
^[\S]*$
-
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[a-zA-Z+-=._:/]+$
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- ConflictException
-
The request could not be processed because of conflict in the current state of the resource.
HTTP Status Code: 409
- InternalServerException
-
This exception occurs when there is an internal failure in the outbound campaigns.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource does not exist.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
The service quota for your Amazon Connect has been exceeded. Contact AWS Support.
HTTP Status Code: 402
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by an AWSservice.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: