From Bright Pattern Documentation
| Line 1: | Line 1: | ||
<translate>= Replace Records in DNC= | <translate>= Replace Records in DNC= | ||
| − | The method replaces all records in the specified Do Not Call (DNC) list and returns the number of newly inserted records. Duplicates are ignored. An optional comment field value is inserted in the comment field of a | + | The method replaces all records in the specified Do Not Call (DNC) list and returns the number of newly inserted records. Duplicates are ignored. An optional comment field value is inserted in the comment field of a geographic (postal) DNC record, campaign name field of an internal DNC record, and in the comment field of area codes DNC record. This method is supported for internal, geographic postal area codes, and accounts' [[contact-center-administrator-guide/DoNotCallLists|DNC lists]]. |
== Request == | == Request == | ||
| Line 10: | Line 10: | ||
=== Body Content Type === | === Body Content Type === | ||
| − | + | JSON object | |
=== Body === | === Body === | ||
[ | [ | ||
| − | + | "123456789", | |
… | … | ||
| − | + | "9999999999" | |
] | ] | ||
| Line 22: | Line 22: | ||
[ | [ | ||
| − | [ | + | [ "123456789", "optional comment"], |
… | … | ||
| − | [ | + | ["9999999999", "optional comment"] |
] | ] | ||
Latest revision as of 20:48, 13 April 2020
Replace Records in DNC
The method replaces all records in the specified Do Not Call (DNC) list and returns the number of newly inserted records. Duplicates are ignored. An optional comment field value is inserted in the comment field of a geographic (postal) DNC record, campaign name field of an internal DNC record, and in the comment field of area codes DNC record. This method is supported for internal, geographic postal area codes, and accounts' DNC lists.
Request
URL
http[s]://<host>/configapi/v2/donotcalllist/replaceAll/<do_not_call_list_name>
Method
POST
Body Content Type
JSON object
Body
[ "123456789", … "9999999999" ]
or
[ [ "123456789", "optional comment"], … ["9999999999", "optional comment"] ]
Result
Response Codes
| Code | Description |
| 200 | Success |
| 400 | Bad request (format not understood) |
| 401 | Authentication failed |
| 403 | User authenticated but does not have sufficient privileges, or modification of this type of list is not allowed. |
| 404 | Calling List is not found or invalid URL |
Body
{ "added": 9999 }