• Tools
  • Tools
loading...
No Results
Home > Documentation

Batch Send Files

Tool Name: airdroid_business_file_batch_send

Risk Level: Write (medium-risk)

Execution Mode: Asynchronous submission

Category: File Management

Quick Start (Copy & Use)

Summary: Queue 1-10 public files for delivery to selected devices, groups, or both.

Prerequisites: Files and at least one of DeviceIds or GroupIds. Only Android targets receive the task; Windows targets are silently excluded after device/group expansion.

Success Criteria: StatusCode == 200, ErrorMessage is empty, and TaskId is non-empty. This means task creation, not per-device delivery.

What to Do Next: Query Search File Batch Send Results with TaskId.

Minimal Request Example:

{
  "Files": [{"url": "https://cdn.contoso.com/guides/warehouse-safety-guide.pdf", "filename": "warehouse-safety-guide.pdf"}],
  "DeviceIds": ["a8f3d91c72b44e5fa103c892d0b74561"],
  "GroupIds": [],
  "IsCover": false,
  "RequireWifi": false
}

Minimal Response Example:

{
  "TaskId": "8f0f14f3-1c85-4b3c-98f0-5b2519e7caa2",
  "Hint": "",
  "Retryable": false,
  "OriginalStatusCode": 200,
  "StatusCode": 200,
  "ErrorMessage": ""
}

Recipes (Common Recipes)

Recipe 1: Device Delivery Without Overwrite

When to use: Send a file while preserving a same-named file already on the device.

{
  "Files": [{"url": "https://cdn.contoso.com/guides/warehouse-safety-guide.pdf", "filename": "warehouse-safety-guide.pdf"}],
  "DeviceIds": ["a8f3d91c72b44e5fa103c892d0b74561"],
  "GroupIds": [],
  "IsCover": false,
  "RequireWifi": false
}

Recipe 2: Group Delivery Requiring Wi-Fi

When to use: Devices should download only while connected to Wi-Fi.

{
  "Files": [{"url": "https://cdn.contoso.com/guides/warehouse-safety-guide.pdf", "filename": "warehouse-safety-guide.pdf"}],
  "DeviceIds": [],
  "GroupIds": [4103],
  "IsCover": true,
  "RequireWifi": true
}

Recipe 3: Read Delivery Results

When to use: The submit response returned TaskId.

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

1. Overview

1.1 Description

Creates a batch-send task. The runtime reads each file's reachable URL to derive metadata before submitting the task.

1.2 When to Use

  • Send one or more files to selected Android devices.
  • Target devices directly, by groups, or by both.

1.3 Execution Mode and Response

The action returns TaskId after acceptance. Task creation does not prove delivery. Windows IDs in direct targets or expanded groups are excluded; if no Android target remains, the request fails and no task is created.

1.4 Prerequisites

Condition Description
File URLs Each file needs a public HTTP/HTTPS url and non-blank filename.
Targets At least one of DeviceIds or GroupIds must remain populated.
Android targets This operation supports Android only.

1.5 Prerequisite Tools

Tool Purpose
List Devices / Search Devices Obtain device_id values.
List Groups / Resolve Group ID by Name Obtain group IDs.

1.6 Similar Tools

Use Search File Batch Send Results to read delivery results; it does not create a delivery task.

2. Inputs

2.1 Parameter List

Parameter Type Required Default Description
Files object-array Yes - 1-10 {url, filename} objects.
DeviceIds string-array No "" Direct target IDs.
GroupIds number-array No "" Target group IDs.
IsCover bool No false true overwrites same-named files.
RequireWifi bool No false true requires Wi-Fi for download.

2.2 Parameter Details

`Files`

Provide 1-10 objects. Every item has a non-blank public HTTP/HTTPS url and non-blank filename; the DSL limits filename to 255 characters. The tool reads URL metadata, so URLs must be reachable and provide a direct file download with Content-Length if metadata extraction needs it.

`DeviceIds` and `GroupIds`

Either list may be empty, but not both. Duplicate normalized device or group IDs are rejected. Obtain IDs from the prerequisite tools. Windows targets are excluded server-side.

`IsCover` and `RequireWifi`

IsCover=true replaces a same-named file. RequireWifi=true restricts download to Wi-Fi.

2.3 Parameter Combination Logic

  • DeviceIds and GroupIds can be supplied together.
  • No Android targets after filtering is a failure.
  • The submit action returns one TaskId, even though completion is per device.

3. Outputs

3.1 Response Examples

The Quick Start response is the successful task receipt.

Validation failure:

{
  "TaskId": "",
  "Hint": "Provide target device IDs via 'Search Devices' or group IDs via 'List Groups'.",
  "Retryable": false,
  "OriginalStatusCode": 0,
  "StatusCode": -1,
  "ErrorMessage": "At least one of DeviceIds or GroupIds must be provided."
}

3.2 Field Descriptions

Field Type Description
TaskId string Accepted batch-send task ID; use with Search File Batch Send Results.
StatusCode number 200 completed the submit step, -1 is validation, 500 is system/network error.
ErrorMessage string Empty means acceptance; non-empty means no successful task receipt.
Hint / Retryable string / bool Caller-visible recovery guidance.
OriginalStatusCode number Upstream HTTP status; 0 means no response.

3.3 Task Completion

TaskId is not a delivery result. Inspect the matching result tool for per-device status and pagination.

4. Examples

4.1 Too Many Files

More than 10 Files items returns StatusCode -1; split the file list into batches of at most 10.

4.2 Unreachable File URL

Metadata timeout or network failure returns StatusCode 500 and may set Retryable to true; verify the URL is publicly accessible before retrying.

4.3 No Android Targets

If Windows filtering leaves no Android device, task creation fails. Do not use an acceptance response as proof that excluded Windows devices received files.

5. Error Handling

5.1 StatusCode Semantics

StatusCode Agent action
-1 Correct files or targets; do not retry unchanged.
200 with non-empty ErrorMessage Follow Hint; no successful task receipt is available.
500 For the write submission, verify whether a task was created before repeating it.

5.2 Common Errors

ErrorMessage Resolution
Files must be a non-empty list. Supply 1-10 file objects.
DeviceIds contains duplicates. Remove duplicate device IDs.
At least one of DeviceIds or GroupIds must be provided. Provide direct device and/or group targets.

5.3 Retry Decision

The action is not idempotent: each successful call creates another TaskId, even with unchanged files and targets. Do not repeat a successful or uncertain write without checking task state.

6. Best Practices

6.1 Target Scope

Select Android targets intentionally. Treat silent Windows exclusion as a target filter, not a successful Windows delivery.

6.2 File Safety

Use IsCover=true only when replacing a same-named target file is intended.

6.3 Idempotency

Not idempotent. A repeated successful request creates a new delivery task.

7. Related Tools

Tool Role
Search Devices Obtain device IDs.
List Groups Obtain group IDs.
Search File Batch Send Results Read delivery results by TaskId.

8. Tool Chains

8.1 Send and Inspect

Search Devices or List Groups -> Batch Send Files -> Search File Batch Send Results

Pass the accepted TaskId to the final tool and inspect its per-device pages.

Updated on: Aug 5, 2026
Was This Page Helpful?
Discussion

Leave a Reply. Cancel reply

Your email address will not be published. Required fields are marked*

Product-related questions?Contact Our Support Team to Get a Quick Solution>
On this page
  • Quick Start (Copy & Use)
  • Recipes (Common Recipes)
    • Recipe 1: Device Delivery Without Overwrite
    • Recipe 2: Group Delivery Requiring Wi-Fi
    • Recipe 3: Read Delivery Results
  • 1. Overview
    • 1.1 Description
    • 1.2 When to Use
    • 1.3 Execution Mode and Response
    • 1.4 Prerequisites
    • 1.5 Prerequisite Tools
    • 1.6 Similar Tools
  • 2. Inputs
    • 2.1 Parameter List
    • 2.2 Parameter Details
    • 2.3 Parameter Combination Logic
  • 3. Outputs
    • 3.1 Response Examples
    • 3.2 Field Descriptions
    • 3.3 Task Completion
  • 4. Examples
    • 4.1 Too Many Files
    • 4.2 Unreachable File URL
    • 4.3 No Android Targets
  • 5. Error Handling
    • 5.1 StatusCode Semantics
    • 5.2 Common Errors
    • 5.3 Retry Decision
  • 6. Best Practices
    • 6.1 Target Scope
    • 6.2 File Safety
    • 6.3 Idempotency
  • 7. Related Tools
  • 8. Tool Chains
    • 8.1 Send and Inspect
loading...
No Results