New REST API Methods to Manage Black Lists and Contact Lists in SIP Caller

Black lists and contact lists can now be fully managed through the SIP Caller REST API. You can create, edit, and delete them, and add or remove their numbers, directly from your own systems.

Until now, both were only available from the Web Console under Settings. In August, the Create and Update Campaign endpoints let you automate the whole campaign lifecycle, but the lists those campaigns depend on still had to be maintained by hand. This release fills that gap.

Black Lists

Black lists hold the numbers that should never be called, such as customers who opted out, or numbers flagged by your compliance team. Any campaign can reference one or more black lists.

The new endpoints let you:

• List black lists, with filtering by name, sorting, and pagination
• Create and edit a black list
• Delete one or multiple black lists in a single request
• List the numbers in a black list, with partial number lookup
• Add numbers to a black list, each with an optional description
• Delete numbers from a black list

For example, adding a number to a black list the moment a customer asks not to be contacted again takes a single request:

Contact Lists

Contact lists are reusable lists of numbers to call. Each number can carry its own variable values, such as a customer name, a due balance, or an appointment date, which you can use to play personalized prompts on every call. Contact lists require the Professional or Enterprise Edition.

The same set of operations is available for contact lists:

• List contact lists, with filtering by name, sorting, and pagination. Each list includes its variable names (varNames)
• Create and edit a contact list
• Delete one or multiple contact lists in a single request
• List the numbers in a contact list, along with their variable values
• Add numbers to a contact list, including their variable values
• Delete numbers from a contact list

Here is how to add a number along with its customer name and due balance:

The values in varValues follow the same order as the variable names given in varNames.

Add Numbers from a Contact List to a Campaign

A contact list is only useful once its numbers reach a campaign. A new endpoint does the same thing as the Add numbers from an existing contact list option in the console: it copies every number in a contact list, along with its variable values, into a campaign in a single request.

The response tells you how many numbers the contact list had, how many were added to the campaign, and how many were skipped as duplicates:

This endpoint follows the same rules as the other methods to add numbers through the API:

• Static campaigns can receive numbers while they're in Draft state. Dynamic campaigns can also keep receiving them once they're Active or Paused.
• In a Draft campaign, the same number with the same variable values is only added once. The same number with different variable values is added, since it's assumed to carry a different message.
• In an Active or Paused dynamic campaign, duplicates are allowed. These campaigns are often long-running, so a repeated number is treated as a new call, for example to reach the same customer again.

No more exporting a list only to re-upload it as a CSV file. Maintain your contact list once, and load it into as many campaigns as you need.

Endpoints at a Glance

Operation	Black Lists	Contact Lists
List	GET /blackLists	GET /contactLists
Create	POST /blackLists	POST /contactLists
Edit	PUT /blackLists/{id}	PUT /contactLists/{id}
Delete	DELETE /blackLists	DELETE /contactLists
List numbers	GET /blackLists/{id}/numbers	GET /contactLists/{id}/numbers
Add numbers	POST /blackLists/{id}/numbers	POST /contactLists/{id}/numbers
Delete numbers	DELETE /blackLists/{id}/numbers	DELETE /contactLists/{id}/numbers
Add to a campaign	—	POST /campaigns/{id}/numbers/copyFromContactList

All paths are relative to https://api.sipcaller.com/v1/accounts/ACCOUNT_ID.

A Note on Edits

Edit requests must include a lastUpdatedAt field containing the updatedAt value returned the last time you retrieved, created, or edited the list. This prevents one process from silently overwriting changes made by another, for example when a team member renames a list in the console while an integration is updating it.

Why This Matters

With these endpoints, the lists behind your campaigns can stay in sync with the systems where your data actually lives:

• Keep opt-outs current, automatically. Push do-not-call requests from your CRM, your website, or your IVR to a black list as soon as they happen, so they're honored across every campaign that uses it.
• Refresh contact lists on a schedule. Rebuild a contact list every night with the latest customers and their up-to-date balances, appointment dates, or policy numbers, then load it straight into your next campaigns.
• Provision new accounts end-to-end. Resellers and platforms built on SIP Caller can now set up black lists and contact lists for each new customer, alongside their campaigns, without any manual step.

Example Use Case

A collections team runs a nightly job that:

1. Syncs the day's opt-out requests from their CRM to the company's black list.
2. Rebuilds the "Overdue Accounts" contact list with each customer's name and amount due.
3. Creates the next day's collections campaign, referencing the black list through blackListIds.
4. Loads the campaign's numbers from the contact list with copyFromContactList.
5. Activates the campaign when business hours begin.

Every step, from the lists to the calls, now runs through the API, with no manual step in the console.

Updated API Documentation

The API documentation now covers all the new Black List and Contact List endpoints, including adding numbers from a contact list to a campaign, with full request and response examples for each one.

Start Automating Today

👉 Log in to your SIP Caller console and try the new API methods.

👉 Need help integrating? Contact our team and we'll be happy to assist you.