Generating media URL
GET/api/v2/instance/:instanceId/bucket/media/url
Generating media URL
Request
Path Parameters
instanceId stringrequired
ID of the instance.
Query Parameters
expiry string
Time, in seconds, required for the URL to expire - default = 0
mediaId stringrequired
ID of the media.
Responses
- 200
- 400
- 403
- 404
Success - status 200
- application/json
- Schema
- Example (from schema)
Schema
mediaId stringrequired
type stringrequired
filename stringrequired
mimetype stringrequired
path stringrequired
createdAt stringrequired
deletedAt stringrequired
bucketBucketId stringrequired
mediaURL stringrequired
Bucket object
bucketId stringrequired
bucketName 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
]
{
"mediaId": "string",
"type": "string",
"filename": "string",
"mimetype": "string",
"path": "string",
"createdAt": "string",
"deletedAt": "string",
"bucketBucketId": "string",
"mediaURL": "string",
"Bucket": {
"bucketId": "string",
"bucketName": "string"
},
"Message": {
"messageId": "string",
"keyId": "string",
"keyFromMe": true,
"keyRemoteJid": "string",
"keyParticipant": "string",
"pushName": "string",
"contentType": "string",
"isGroup": true,
"content": {},
"source": "string",
"messageTimestamp": "string",
"createdAt": "2024-04-14T14:11:05.746Z",
"deletedAt": "2024-04-14T14:11:05.746Z",
"typeOfDeletion": "everyone"
}
}
BadRequestException
- application/json
- Schema
- Example (from schema)
Schema
message string[]required
Default value: string,[object Object]
error stringrequired
statusCode numberrequired
{
"message": [
"string"
],
"error": "string",
"statusCode": 0
}
ForbiddenException
- application/json
- Schema
- Example (from schema)
Schema
message string[]required
Default value: string,[object Object]
error stringrequired
statusCode numberrequired
{
"message": [
"string"
],
"error": "string",
"statusCode": 0
}
NotFoundException
- application/json
- Schema
- Example (from schema)
Schema
message string[]required
Default value: string,[object Object]
error stringrequired
statusCode numberrequired
{
"message": [
"string"
],
"error": "string",
"statusCode": 0
}
Loading...