https://sandbox.voice.miraiminds.co.
How suppression works
We check numbers at dial time, in the same database statement that hands contacts to the dialler. This has three consequences:- Late additions work. A number added while a campaign is running is suppressed from that moment on, even though it was uploaded in the original list.
- Suppression is not deletion. The contact stays in the campaign with
status: "suppressed"and shows up in the report, so you can prove the number was uploaded and not called. - Suppressed contacts are never billed. We never dial them, so there are no minutes to charge.
POST /v2/calls. A
direct single call is an explicit instruction to ring one number now. If we
refused it because the number is on the list, transactional calls would be
dropped without any notice, such as a delivery confirmation to a customer who
opted out of marketing. If you want single calls checked as well, check the
list yourself before you place them.
The entry object
Add a number
201 Created
200 OK with "added": false instead of
201:
200 OK — already on the list
added. If you only need the number
suppressed, you can ignore it. Both responses mean the number will not be
dialled.
List numbers
200 OK
limit from 1
to 100 (default 20), and cursor from next_cursor.
Remove a number
+ becomes %2B.
204 No Content. If the number was not on the
list, you get 404 not_found.
Keeping it in sync
The list is a set of numbers and the operations are idempotent, so the simplest integration is also correct: on every opt-out event in your own system,POST
the number. You don’t need to read the list first or diff it against yours.
- Suppress on the call, not after the campaign. If your agent hears “stop calling me”, add the number to the list from the webhook handler that same minute.
- Suppress before you upload. Scrub each contact list before you upload it, and keep the DNC list current. If you forget to scrub a campaign’s list, the DNC list still keeps those numbers from being dialled.
- Never remove in bulk. Remove numbers one at a time, deliberately, and log a reason for each removal.