From Bright Pattern Documentation
(Created new topic from branched topic Documentation:ServicePattern:list-management-api-specification:Getcampaigns:3.15) |
|||
| Line 3: | Line 3: | ||
== URL == | == URL == | ||
| − | http[s]:// | + | http[s]://<host>/admin/ws/t/<tenant_url>/campaign/getAll/ |
== Method == | == Method == | ||
| Line 12: | Line 12: | ||
=== Example === | === Example === | ||
| − | + | [ | |
| − | + | { | |
| − | [ | + | "name": "CAMPAIGN1", |
| − | { | + | "lists": ["LIST1", "LIST2"], |
| − | + | "state": “RUNNING” | |
| − | + | }, | |
| − | + | … | |
| − | }, | + | ] |
| − | … | ||
| − | ] | ||
| − | |||
If enabled campaigns do not exist, an empty array is returned. | If enabled campaigns do not exist, an empty array is returned. | ||
| Line 37: | Line 34: | ||
| − | + | ||
</translate> | </translate> | ||
Latest revision as of 22:44, 17 September 2018
Contents
- Introduction
- API Specification
- General Information
- 1 Get campaigns
- Add a record
- Add a number of records
- Update a record
- Query a record
- Delete all records
- Get completed records
- Get updated records
- Get all records
- Add records to DNC
- Replace records in DNC
List Management API Specification
Get campaigns
This returns the list of enabled campaigns, their current states, and calling lists associated with such campaigns.
URL
http[s]://<host>/admin/ws/t/<tenant_url>/campaign/getAll/
Method
GET
Returns
200 – Names of campaigns with current states and associated calling lists (content type: application/json)
Example
[
{
"name": "CAMPAIGN1",
"lists": ["LIST1", "LIST2"],
"state": “RUNNING”
},
…
]
If enabled campaigns do not exist, an empty array is returned.
Errors
400 – Bad request (missing mandatory fields or incorrect format)
401 – Authentication failed
403 – Authentication succeeded, but authorization failed (no privileges)