Search File Batch Send Results

Tool Name: airdroid_business_file_batch_send_result_search

Risk Level: Low Risk

Execution Mode: Synchronous

Category: File Management

Quick Start

In one sentence: Read one page of per-device delivery results for an existing batch-send task.

What you need: TaskId returned by Batch Send Files. It must be an 8-4-4-4-12 hexadecimal UUID with hyphens.

Success criteria: ErrorMessage is empty. Also inspect each Devices[].status; an accepted send task is not proof that every device received the file.

What to do next: If Pagination.page_index < Pagination.last_page, request the next page with a larger PageIndex; otherwise inspect device rows that are not Success.

Minimal request example:

{
  "TaskId": "8f0f14f3-1c85-4b3c-98f0-5b2519e7caa2"
}

Minimal response example:

{
  "Task": {
    "task_id": "8f0f14f3-1c85-4b3c-98f0-5b2519e7caa2",
    "file_name": "warehouse-safety-guide.pdf",
    "file_size": 2843912,
    "created_at": "2026-07-20 09:05:14",
    "summary": {
      "succeeded": 2,
      "failed": 0,
      "distributing": 0
    }
  },
  "Devices": [
    {
      "device_id": "a8f3d91c72b44e5fa103c892d0b74561",
      "device_name": "Chicago Warehouse Tablet 01",
      "status": "Success",
      "error_code": 0,
      "pushed_at": "2026-07-20 09:05:21",
      "responded_at": "2026-07-20 09:06:03"
    }
  ],
  "Pagination": {
    "total": 2,
    "page_size": 100,
    "page_index": 1,
    "last_page": 1
  },
  "Hint": "",
  "Retryable": false,
  "OriginalStatusCode": 200,
  "StatusCode": 200,
  "ErrorMessage": ""
}

Recipes

Recipe 1: Read the First Result Page

When to use: Batch Send Files returned an accepted TaskId and you need the current per-device delivery rows.

{
  "TaskId": "8f0f14f3-1c85-4b3c-98f0-5b2519e7caa2",
  "PageIndex": 1,
  "PageSize": 100,
  "Filter": {}
}

Recipe 2: Request the Next Page

When to use: A prior successful response reports Pagination.page_index lower than Pagination.last_page.

{
  "TaskId": "8f0f14f3-1c85-4b3c-98f0-5b2519e7caa2",
  "PageIndex": 2,
  "PageSize": 100,
  "Filter": {}
}

Use the same task and filter with the next 1-based page number. A PageIndex greater than the returned last_page is rejected with StatusCode -1; the tool does not clamp it.

Recipe 3: Inspect Devices Still Sending

When to use: You want the rows whose delivery status is exactly Sending.

{
  "TaskId": "8f0f14f3-1c85-4b3c-98f0-5b2519e7caa2",
  "PageIndex": 1,
  "PageSize": 100,
  "Filter": {
    "status": "Sending"
  }
}

1. Overview

1.1 Description

This read-only tool returns a paginated snapshot of per-device delivery results for one batch-send task. It does not create or run a batch send.

1.2 When to Use

• Check the current delivery results for a batch-send task.
• Find devices in a supported delivery status, such as Sending or Insufficient storage available.
• Read additional result pages for the same task.

Do not use this tool to start a send or to query another task type.

1.3 Execution Mode and Response

This is a synchronous read. It returns the current Task, one page of Devices, and Pagination immediately. It does not automatically retrieve every page.

1.4 Prerequisites

1.5 Prerequisite Tool

1.6 Scope

Use this tool only with the TaskId from a batch-send task.

2. Inputs

2.1 Parameter List

2.2 Parameter Details

`TaskId`

Use the TaskId field returned by Batch Send Files after task acceptance.

• Type: string
• Format: UUID with 8-4-4-4-12 hexadecimal groups separated by hyphens
• Invalid format: returns StatusCode -1
• No matching send task: returns a non-empty ErrorMessage; it can still have StatusCode 200

`PageIndex`

PageIndex is 1-based and defaults to 1. It must be a whole number greater than or equal to 1. Zero, negative, decimal, and non-integer values return StatusCode -1.

`PageSize`

PageSize defaults to 100 and must be a whole number from 1 through 200. Values outside that range, decimal values, and invalid values return StatusCode -1; they are not silently replaced by the default.

`Filter`

The DSL type is object. The runtime accepts either an object or a string containing a JSON object. Omit it, use {}, or use an empty string for no filter; results remain paginated. Its fields narrow the request only and are not added to Devices[].

For a string value, malformed JSON returns StatusCode -1, ErrorMessage Filter must be a JSON object., and Retryable false. A JSON-encoded value that decodes to a non-object (such as []) is treated as no filter, not as a validation error. A raw value that is neither a string nor an object returns the same Filter must be a JSON object. validation error. An object that cannot be JSON-serialized returns Filter is not JSON-serializable. with StatusCode -1.

Supported fields are status, device_id, device_name, group_id, and group_name.

• Use eq for one exact value.
• Use in for status or ID lists.
• Use like for a case-insensitive name substring on device_name or group_name.
• status must exactly match a device row status, not a console summary label such as Succeeded or Distributing.
• All removes status filtering.

Supported status values:

Examples:

{
  "device_name": {
    "like": "Kiosk"
  },
  "group_name": {
    "eq": "Warehouse"
  }
}

2.3 Parameter Combination Logic

TaskId is required. PageIndex, PageSize, and Filter are optional. Filtered results are still paginated. When a successful response has more pages, increment PageIndex while keeping the same task and intended filter.

3. Outputs

3.1 Response Examples

The Quick Start response is a successful query response.

Validation error response:

{
  "Task": {},
  "Devices": [],
  "Pagination": {},
  "OriginalStatusCode": 0,
  "StatusCode": -1,
  "ErrorMessage": "TaskId format is invalid.",
  "Hint": "Use the UUID TaskId returned by 'Batch Send Files' (8-4-4-4-12 hex with hyphens).",
  "Retryable": false
}

3.2 Field Descriptions

Devices[] does not include group_id or group_name.

3.3 Status Values

Devices[].status uses the exact values listed for Filter.status in Filter. Do not substitute summary labels such as Succeeded or Distributing.

3.4 Pagination

Request the next page only when page_index < last_page. PageIndex greater than last_page returns StatusCode -1 with Task, Devices, and Pagination cleared.

4. Examples

4.1 Basic Example: Successful Deliveries

{
  "TaskId": "8f0f14f3-1c85-4b3c-98f0-5b2519e7caa2",
  "PageIndex": 1,
  "PageSize": 100,
  "Filter": {
    "status": "Success"
  }
}

An empty ErrorMessage means the query completed. The Success filter does not prove that unreturned pages or nonmatching devices also succeeded.

4.2 Advanced Example: Filter by Group Name

{
  "TaskId": "8f0f14f3-1c85-4b3c-98f0-5b2519e7caa2",
  "PageIndex": 1,
  "PageSize": 100,
  "Filter": {
    "group_name": {
      "eq": "Warehouse"
    }
  }
}

group_name narrows the device list server-side but is not returned in Devices[].

4.3 Error Example: Wrong Task Type or Unknown Task

Use only the UUID returned by Batch Send Files. A UUID that does not identify a matching send task returns empty Task, Devices, and Pagination, with a non-empty ErrorMessage and a Hint. This business failure can have StatusCode 200, so do not treat StatusCode alone as success.

5. Error Handling

5.1 StatusCode Semantics

5.2 Caller-Visible Errors

5.3 Retry Decision

This read-only query is idempotent. Do not infer retry eligibility from StatusCode alone: use the returned Retryable and Hint. A wrong TaskId or a task-not-found result is not retryable.

6. Best Practices

6.1 Preserve the Accepted TaskId

Store the TaskId from the Batch Send Files acceptance response and use it unchanged as text. Task creation is not proof of delivery.

6.2 Keep Responses Focused

Use Filter and a suitable PageSize within 1 through 200 to retrieve only the result rows needed for inspection. The tool always returns one page.

6.3 Interpret Results Per Device

Treat Task.summary as counts and Devices[].status as the per-device result. Inspect the complete intended page set before concluding a batch-wide outcome.

7. Related Tools

No additional related-tool chain is defined for this query.

8. Tool Chains

8.1 Submit and Inspect Delivery Results

Batch Send Files -> Search File Batch Send Results

Pass Batch Send Files.TaskId to this tool, then inspect the paginated Devices[] delivery rows.