BounceBan: Dump Bulk Results

Get the verification results of a bulk email verification task as JSON, optionally filtered by result.

Tool ID: bounceban_dump_bulk_results

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_dump_bulk_results',
  {
    "id": "id_123"
  },
);

console.log(result.toolResponse.raw);

CLI

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

Example response

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

{
  "data": {
    "result": "ok",
    "status": "importing",
    "cursor": "cursor_123"
  }
}

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

Input reference

Retrieve verification results for a bulk email verification task using a task ID in JSON format. Results are available within 90 days of verification. When making a request with the state parameter included, you might not receive all the verified results if the task is not yet finished. To obtain a comprehensive list of the verified emails that have been processed so far, you should omit the state parameter from your request.

Name	Type	Required	Default	Details
`payload.id`	`string`	Yes	—	Bulk email verification task ID.
`payload.state`	`"" \| "deliverable" \| "risky" \| "undeliverable" \| "unknown"`	No	`""`	Specifies emails to retrieve based on verification state (`deliverable`, `undeliverable` , `risky`, or `unknown`). If not set, all emails will be returned. When making a request with the `state` parameter included, you might not receive all the verified results if the task is not yet finished. To obtain a comprehensive list of the verified emails that have been processed so far, you should omit the `state` parameter from your request. Allowed: “, `deliverable`, `risky`, `undeliverable`, See the live schema for the complete constraint.
`payload.cursor`	`string`	No	—	(Optional) Provide this parameter to retrieve results from the next page. You can obtain the cursor value from the previous rquest response. If `retrieve_all` is set to `1`, the `page_size` and `cursor` parameters will be ignored.
`payload.page_size`	`integer`	No	`"100"`	(Optional) Specify the number of emails to return per request. Default: 100. Maximum: 3,000. Minimum: 100. If `retrieve_all` is set to `1`, the `page_size` and `cursor` parameters will be ignored. Minimum: 100. Maximum: 3000.
`payload.retrieve_all`	`"" \| "1"`	No	`""`	(Optional) Retrieve all emails for the task by setting this parameter to `1`. Default: Disabled (empty). Important Notes: If `retrieve_all` is set to `1`, the `page_size` and `cursor` parameters will be ignored. This parameter is only effective if the total number of emails for the task is less than or equal to 20,000. Allowed: “, `1`.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.result`	`"ok" \| "err"`	No	—	> `ok` Indicates the request is successful. > `err` The bulk task has not finished yet, please try again later. Allowed: `ok`, `err`.
`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.cursor`	`string`	No	—	Use this value to retrieve next page.
`result.data.items`	`array`	No	—	Detailed verification results for each email.
`result.data.items[].status`	`"success" \| "verifying" \| "queue"`	No	—	Verification status for this task. > `success` indicates the task is finished and the final verification result can be returned. > `verifying` indicates the email is still being verified. > `queue` indicates the email is still being in queue. Allowed: `success`, `verifying`, `queue`.
`result.data.items[].email`	`string`	No	—	The email address submitted for verification.
`result.data.items[].result`	`"deliverable" \| "risky" \| "undeliverable" \| "unknown"`	No	—	The state (verification result) for the email. Allowed: `deliverable`, `risky`, `undeliverable`, `unknown`.
`result.data.items[].score`	`integer`	No	—	The score (0 ~ 100) represents the deliverability of an email - the higher, the better. Minimum: 0. Maximum: 100.
`result.data.items[].is_disposable`	`boolean`	No	—	Whether the email is disposable.
`result.data.items[].is_accept_all`	`boolean`	No	—	Whether the email is accept-all.
`result.data.items[].is_role`	`boolean`	No	—	Whether the email is role based.
`result.data.items[].is_free`	`boolean`	No	—	Whether the email is a free email.
`result.data.items[].mx_records`	`array`	No	—	All MX records for the email.
`result.data.items[].smtp_provider`	`string`	No	—	SMTP provider based on the main MX record, e.g. if the MX record for an email is `alt1.aspmx.l.google.com`, then the smtp provider will be `Google`.
`result.data.items[].mode`	`string`	No	—	Verification mode.
`result.data.items[].verify_at`	`string`	No	—	The time the verification task finished. Format: `date-time`.
`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