CommentAttachment

The voice or video recording on a comment.

4 fieldsapplication/jsonDownload JSON Schema ↓

Fields

Required means the key is present; nullable means its value may be null. These are different. Examples are synthetic, complete for the documented fields, and not real customer data.

typestringrequired

AUDIO for a voice comment, VIDEO for a video.

Example "AUDIO"

mimeTypestring | nullrequirednullable

MIME type of the recorded file.

Example "audio/mp4"

transcriptstring | nullrequirednullable

Transcript of the recording; null when it hasn't been transcribed or is silent.

Example "Slow down when you get to price."

downloadUrlstring | nullrequirednullable

Temporary presigned S3 URL for the recording. Expires 6 hours after the response is issued; download or persist the file rather than storing the URL. Temporary signing credentials may cause earlier expiry.

Example "https://example.com/temporary-comment.m4a?signature=EXAMPLE"

Complete example

CommentAttachment · complete example

{
  "type": "AUDIO",
  "mimeType": "audio/mp4",
  "transcript": "Slow down when you get to price.",
  "downloadUrl": "https://example.com/temporary-comment.m4a?signature=EXAMPLE"
}

All response types →

On this page