BounceBan: Get Bulk Status

Check a bulk email verification task’s progress and its summary counts by verification result.

Tool ID: bounceban_get_bulk_status

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'bounceban_get_bulk_status',
  {
    "id": "id_123"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute bounceban_get_bulk_status --input '{
  "id": "id_123"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "id": "id_123",
    "status": "importing",
    "total_count": 123
  }
}

Use deepline describe bounceban_get_bulk_status --json for the latest machine-readable contract.

Input reference

You can use this API to get the latest progress and stats for a bulk email verification task using a task ID.

Name	Type	Required	Default	Details
`payload.id`	`string`	Yes	—	Bulk email verification task id.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.id`	`string`	No	—	Bulk email verification task id.
`result.data.status`	`"importing" \| "verifying" \| "finished"`	No	—	Bulk email verification task status. > `importing` indicates the list of emails are being imported for verification. > `verifying` indicates all the emails are imported and are being verified. > `finished` indicates verification for the whole list has finished. Allowed: `importing`, `verifying`, `finished`.
`result.data.total_count`	`integer`	No	—	If `status` is `importing` or `verifying`, it represents the number of emails for verification. If `status` is `finished`, it represents the number of emails verified.
`result.data.finished_count`	`integer`	No	—	It represents the number of emails imported when `status` is `importing`, and the number of emails verified when `status` is `verifying`.
`result.data.pushed_count`	`integer`	No	—	It represents the number of emails pushed via webhook events. Only returned when `status` is `verifying` or `finished`, and a webhook was submitted when creating the bulk verification task.
`result.data.deliverable_count`	`integer`	No	—	It represents the number of emails that are `deliverable`. Only returned when `status` is `finished`.
`result.data.undeliverable_count`	`integer`	No	—	It represents the number of emails that are `undeliverable`. Only returned when `status` is `finished`.
`result.data.risky_count`	`integer`	No	—	It represents the number of emails that are `risky`. Only returned when `status` is `finished`.
`result.data.unknown_count`	`integer`	No	—	It represents the number of emails that are `unknown`. Only returned when `status` is `finished`.
`result.data.catchall_count`	`integer`	No	—	It represents the number of emails that are `catchall`. Only returned when `status` is `finished`.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation