(Created new topic from branched topic Documentation:ServicePattern:list-management-api-specification:ReplacerecordsinDNC:3.15) |
|||
| Line 3: | Line 3: | ||
== URL == | == URL == | ||
| − | http[s]:// | + | http[s]://<host>/admin/ws/t/<tenant_url>/donotcalllist/replaceAll/<do_not_call_list_name> |
== Method == | == Method == | ||
| Line 12: | Line 12: | ||
=== Example === | === Example === | ||
| − | + | [ | |
| − | + | ||
| − | + | “123456789“, | |
| − | + | ||
| − | + | … | |
| − | + | ||
| − | + | “9999999999” | |
| − | + | ||
| − | + | ] | |
| − | |||
| − | |||
| − | |||
or | or | ||
| − | + | [ | |
| − | + | ||
| − | + | [ “123456789“, “optional comment”], | |
| − | + | ||
| − | + | … | |
| − | + | ||
| − | + | [“9999999999”, “optional comment”] | |
| − | + | ||
| − | + | ] | |
| − | |||
== Returns == | == Returns == | ||
| Line 45: | Line 41: | ||
=== Example === | === Example === | ||
| − | + | { “added”:9999 } | |
| − | |||
| − | |||
| − | |||
== Errors == | == Errors == | ||
| Line 62: | Line 55: | ||
| − | |||
</translate> | </translate> | ||
Latest revision as of 23:25, 17 September 2018
Contents
- Introduction
- API Specification
- 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
- 1 Replace records in DNC
Replace records in DNC
This deletes existing records in the specified Do Not Call (DNC) list, adds records supplied in the request, and returns the number of added records. Optional comments are inserted in the comment field of geographic (postal) DNC record or campaign name field of internal DNC record. This method is supported for internal, geographic postal, area codes, and record exclusion DNC lists.
URL
http[s]://<host>/admin/ws/t/<tenant_url>/donotcalllist/replaceAll/<do_not_call_list_name>
Method
POST
Request body
Records to be added, without or with comments (content type: application/json)
Example
[ “123456789“, … “9999999999” ]
or
[ [ “123456789“, “optional comment”], … [“9999999999”, “optional comment”] ]
Returns
200 – Records added
Body
Number of added records (content type: application/json); note that the number of added records may be different from the number of records in the request, as any duplicates, if found, will be ignored
Example
{ “added”:9999 }
Errors
400 – Bad request (incorrect format)
401 – Authentication failed
403 – Authentication succeeded, but authorization failed (no privileges)
404 – Do Not Call list is not found or URL is invalid