(Created new topic from branched topic Documentation:ServicePattern:list-management-api-specification:GeneralInformation:3.15) |
m |
||
| Line 8: | Line 8: | ||
| − | + | ||
</translate> | </translate> | ||
Latest revision as of 22:36, 17 September 2018
Contents
- Introduction
- API Specification
- 1 General Information
- 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
General Information
HTTP digest access authentication is used to authenticate the access attempts. The provided username is checked against the list of users configured at the contact center (tenant) level. Moreover, the session is established provided that the supplied credentials are authenticated and that the user’s role indicate the user's authorization to perform operations with calling (i.e., the user must have a role with the Manage lists privilege enabled).
Standard HTTP response codes whose meaning conforms to the original specification (RFC 2616) are not discussed in this guide. For specification of such responses, see section 10 of http://www.ietf.org/rfc/rfc2616.txt. This document only specifies the response codes whose description deviates from the original specification (e.g., is defined more narrowly or has a different meaning).
Note: In Bright Pattern Contact Center version 3.8, the /tenantmgmt part of the API’s URL has been replaced with /admin. If you have used the List Management API with previous versions of the Bright Pattern Contact Center platform, you need to update the applications that use this API to the new URL (unless these applications are programmed to handle re-direct messages).