From Bright Pattern Documentation
Jump to: navigation, search
 
 
Line 3: Line 3:
  
 
== URL ==
 
== URL ==
http[s]://<host>:<port>/admin/ws/t/<tenant_url>/donotcalllist/add/<do_not_call_list_name>
+
http[s]://<host>/admin/ws/t/<tenant_url>/donotcalllist/add/<do_not_call_list_name>
 
 
 
== Method ==
 
== Method ==
 
POST
 
POST
Line 12: Line 11:
  
 
=== Example ===
 
=== Example ===
{|border="1" style="border-collapse:collapse" cellpadding="5"
+
[
|
+
''[''
+
“123456789“,
 
+
''“123456789“,''
+
 
+
''''
+
“9999999999”
 
+
''“9999999999” ''
+
]
 
 
'']''
 
  
 
or
 
or
  
''[''
+
[
 
+
''[ “123456789“, “optional comment”],''
+
[ “123456789“, “optional comment”],
 
+
''''
+
 
+
''[“9999999999”, “optional comment”] ''
+
[“9999999999”, “optional comment”]
 
+
'']''
+
]
|}
 
  
 
== Returns==  
 
== Returns==  
Line 44: Line 40:
  
 
=== Example===  
 
=== Example===  
{|border="1" style="border-collapse:collapse" cellpadding="5"
+
{ “added”:9999 }
|
 
''{ “added”:9999 }''
 
|}
 
  
 
== Errors ==
 
== Errors ==
Line 61: Line 54:
  
  
<center>[[list-management-api-specification/Getallrecords|< Previous]]  |  [[list-management-api-specification/ReplacerecordsinDNC|Next >]]</center>
+
 
 
</translate>
 
</translate>

Latest revision as of 23:23, 17 September 2018

• 3.10 • 3.11 • 3.12 • 3.13 • 3.14 • 3.15 • 3.16 • 3.17 • 3.18

Add records to DNC

This adds new records to the specified Do Not Call (DNC) list, and returns the number of added records. Optional comments are inserted in 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/add/<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



< Previous | Next >