Sign in
phones

Get one file delivery

Returns a single delivery by id and its current status. Poll this to wait on a specific push: the list endpoint pages the newest records and can drop a delivery that ages past the page on a busy phone.

get/phones/{phone_id}/deliveries/{delivery_id}

Path parameters

phone_idstring required

phone the delivery belongs to

phone the delivery belongs to

delivery_idstring uuid required

delivery to fetch

delivery to fetch

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

bytes_transferredinteger

Bytes the phone has downloaded so far. Absent until the phone reports progress.

created_atstring date-time required

When the push was dispatched.

errorstring

Failure detail for failed deliveries.

file_idstring

Library file that was pushed. Absent once that file has been deleted; the filename and size below are snapshots taken at push time and survive it.

filenamestring required

Delivered file's display name.

idstring required

Delivery identifier.

mime_typestring required

Delivered file's MIME type.

phone_idstring required

Phone the file was pushed to.

size_bytesinteger required

Delivered file's size in bytes.

status'dispatching' | 'dispatched' | 'delivered' | 'failed' required

dispatching while the push is being published, dispatched while the phone downloads, then delivered or failed once it reports back.

Example response

{
  "$schema": "/api/v1/FileDeliverySummary.json"
}

Changes

Changed in 3 of the 19 revisions of this API.13

  • e2261ff54e621See the full diff
    • ○

      the endpoint scheme security bearerAuth was removed from the API

      api-security-removed

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 108ab4b4105111See the full diff
    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a0204e0956bc1See the full diff
    • ○

      endpoint added

      endpoint-added