Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetCampaignStateBatch

Returns the state of listed of outbound campaigns.

Request Syntax


POST /campaigns-state HTTP/1.1
Content-type: application/json

{
   "campaignIds": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

campaignIds

The identifiers of the campaigns.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: ^[a-zA-Z0-9\-:/]*$

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "failedRequests": [ 
      { 
         "campaignId": "string",
         "failureCode": "string"
      }
   ],
   "successfulRequests": [ 
      { 
         "campaignId": "string",
         "state": "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.

failedRequests

Failed requests.

Type: Array of FailedCampaignStateResponse objects

Array Members: Minimum number of 0 items. Maximum number of 25 items.

successfulRequests

Successful requests.

Type: Array of SuccessfulCampaignStateResponse objects

Array Members: Minimum number of 0 items. Maximum number of 25 items.

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

InternalServerException

This exception occurs when there is an internal failure in the outbound campaigns.

HTTP Status Code: 500

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