Do Not Call API

Use the Do Not Call API to set the Do Not Call (DNC) import rule configuration for Outbound Option so that the campaign dialer doesn't dial the numbers in the DNC list.

The DNC import is automatically scheduled to start when the file is available. After the import is complete, the file is RENAMED or DELETED based on the boolean value for the renameFileAfterImport field.

URL

https://<server>/unifiedconfig/config/dnc

Operations

  • create: Sets the configuration in the database. Returns the refURL if the configuration is set.

  • delete: Deletes the specific DNC configuration using the URL https://<server>/unifiedconfig/config/dnc/<id>. This does not delete the DNC import file that is present at the location of the filePath.

  • list: Retrieves a list available DNC import rules.

  • get: Returns the DNC import configuration from the database using the URL https://<server>/unifiedconfig/config/dnc/<id>.

  • update: Updates the specific DNC import configuration with the new values using the URL https://<server>/unifiedconfig/config/dnc/<id>.

Parameters

  • name: Name of the DNC import. See Shared Parameters.

  • filePath: Path to a file on the logger or accessible from the logger. Maximum length of 255 characters.

  • overwrite: Whether the new DNC import overwrites the phone numbers from the previous DNC import. True or false. Default is false.

  • renameFileAfterImport: Whether to delete the DNC import file after the import is complete. True or false. Default is true. If the parameter is set to true, the DNC file is renamed. If the parameter is set to false, the DNC import file is deleted.

Search and Sort Parameters

The following table shows the parameters that are searched and the parameters that are sortable.

Search parameters

Sort parameters

  • name

  • name

See Search and Sort.

Example Get Response

Code Snippet
Copy
<dnc>
    <refURL>/unifiedconfig/config/dnc/unifiedconfig/config/dnc/5001</refURL>
    <name>dnc1</name>
    <filePath>\\CCE-ROGGER-A\C$\Users\boston\Desktop\dnc.txt</filePath>
    <overwrite>false</overwrite>
    <renameFileAfterImport>true</renameFileAfterImport>
</dnc>