This API will allow a 3rd party system to invoke this API to asynchronously inform Webex Campaign of the outcome of a specific transaction within a specific deployment.
The API will initially only be available for External Action channel deployments. The 3rd party systems will be able to post the transaction status to this new Notify Transaction State API; which will then allow Webex Campaign to display the External Action Success / Failure counts on the Dashboard.
Based on the domain you use to log in to Webex Campaign, the endpoint domain for your API varies. For more information, refer to the Know Your API Endpoints section.
Go to the Postman Collection section to learn how to import a Postman collection. Click the below button, If you already know how to import a postman collection.
Headers
The following table describes the request headers:
| Request Header | Description |
|---|---|
| content-Type | application/json |
| authorization | Access token or API Secret Key in Bearer format Example: Bearer $(key) |
Body Parameters
The following table describes the elements in the request body:
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| responseState | String | Yes | Specifies the response state for the notification. The expected values are: 531 - For Success 532 - For Failure |
| refTransId | String | Yes | Reference trans id to link back this notification response with the transaction triggered from Webex Campaign. |
| deploymentId | String | Yes | Specifies the deployment ID for the transaction. |
| responseTime | String | No | This is used to pass date and time (ISO Date Format) when the response was captured. The format of the date is "yyyy-MM-dd HH:mm:ss". |
| additionalInfo | String | No | Specifies additional info as key-value pair. responseCode: (Optional) This is used to pass a response code for the transaction. This value will be shown in the "Action Deployment Response Summary" report and can be used to further understand the state of a transaction. These values can be configured in the Success/ Failure Response section for an External Action. The response code values received in the API request are matched with the values in the External Action Success/ Failure Response Section. If any request does not provide a responseCode value or provides a value not defined in the Action Definition the “Response Description” will be shown as “NOT SPECIFIED” in the report. responseDesc: (Optional) This is used to pass a response description for the transaction. This value will be shown in the “Action Deployment Response Summary” report and can be used to further understand the state of a transaction. These values can be configured in the Success/ Failure Response section for an External Action. The response code values received in the API request are matched with the values in the External Action Success/ Failure Response Section. If any request does not provide a responseCode value or provides a value not defined in the Action Definition the “Response Description” will be shown as “NOT SPECIFIED” in the report. |
Request Example
{
"responseState": "532",
"refTransId": "CC02_1605176995001254571",
"deploymentId" : "API_1605176965390000881",
"additionalInfo" : "{\"responseCode\":\"403\",\"responseDesc\":\"There was an error with the authentication token\"}"
}
Response Parameters
This API will return the following response parameters:
| Parameter | Description |
|---|---|
| code | Returns the response code in case of failure. |
| description | Returns the description of the response in case of failure. |
| transaction-id | Returns the unique Transaction ID of the operation in case of success. |
Failure Response Codes
The API will return code within the response as per the following table in case of failure scenarios.
| HTTP Status Code | Code within API Response | Description |
|---|---|---|
| 200 | 1100 | The Response has been notified successfully |
| 401 | 430 | Authorization failed. This resource is not allowed to access using this TOKEN or KEY |
| 498 | Invalid token or Access token expired | |
| 405 | 405 | Method not supported |
| 429 | 429 | Too many requests. Throttle limit reached for the time window. |
| 499 | 499 | Request failed. Check the exact reason of failure in application code and description of error stream. |
| 500 | 500 | Internal server error |
| 1101 | Mandatory params cannot be null or empty | |
| 1102 | No actions are mapped for the given deployment | |
| 1103 | Action type(sync/async) is not present for the used action | |
| 1104 | Only actions having async types can be used | |
| 1105 | Only onetime and recurring deployments are allowed | |
| 1108 | Only 531 and or 532 response status is allowed |