Documents

Generate a temporary download link for a document

Changed on

Generates a temporary pre-signed URL that can be used to download the document directly from the storage backend without authentication.

get/documents/{id}/download_link

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/documents/{id}/download_link
  • Auth: HTTP bearer

Path parameters

idstring uuid required
Example:550e8400-e29b-41d4-a716-446655440000

Uniquely identifies the document

Response

Successfully generated download link

Example response

{
  "data": {
    "url": "https://s3.amazonaws.com/bucket/path/to/document?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..."
  }
}

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status