Skip to main content

Retrieve All Media By Type

GET 
/api/v2/instance/:instanceId/media

Fetches all media of a specified type associated with a particular instance.

Request​

Path Parameters

    instanceId stringrequired

    ID of the instance.

Query Parameters

    ttl TTL

    Default value: 600000

    Set a maximum time to wait for the request to be responded to.

    type string

    Possible values: [document, image, video, audio, sticker]

    document | image | video | audio | sticker

    keyRemoteJid string

    The ID of the chat that received the media; group or simple chat.

Responses​

MediaResponse

Schema
  • Array [
    • mediaId stringrequired
    type stringrequired
    filename stringrequired
    mimetype stringrequired
    path stringrequired
    createdAt stringrequired
    deletedAt stringrequired
    bucketBucketId stringrequired
    Message object
    messageId stringrequired
    keyId stringrequired
    keyFromMe booleanrequired
    keyRemoteJid stringrequired
    keyParticipant stringrequired
    pushName stringrequired
    contentType stringrequired
    isGroup booleanrequired
    content objectrequired
    source stringrequired
    messageTimestamp stringrequired
    createdAt date-timerequired
    deletedAt date-timerequired
    typeOfDeletion stringrequired

    Possible values: [everyone, forMe]

  • ]
Loading...