Skip to content

Commit

Permalink
new route mediaData
Browse files Browse the repository at this point in the history
  • Loading branch information
jrCleber committed Sep 13, 2024
1 parent 776351e commit e640198
Showing 1 changed file with 59 additions and 0 deletions.
59 changes: 59 additions & 0 deletions docs/swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1593,6 +1593,56 @@ paths:
instanceId: 1

/chat/retrieverMediaMessage/{instanceName}:
post:
tags:
- Chat Controller
summary: Retrieve Media Message
deprecated: true
description: |
Retrieve a specific media message from a given chat instance. This endpoint requires the `instanceName` as a path parameter and `keyId` of the media message in the request body.
parameters:
- name: instanceName
in: path
required: true
schema:
type: string
description: The name of the chat instance from which the media message will be retrieved.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
keyId:
type: string
description: The unique identifier of the media message to be retrieved.
required:
- keyId
example:
keyId: "3A778B978B5D9995F574"
responses:
'200':
description: Media message retrieved successfully. The response is a binary file of the media.
content:
application/octet-stream:
schema:
type: string
format: binary
'404':
description: Media message not found or instance not found.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Error message detailing why the media message or instance was not found.
example:
error: "Media message or instance not found"

/chat/mediaData/{instanceName}:
post:
tags:
- Chat Controller
Expand All @@ -1606,6 +1656,15 @@ paths:
schema:
type: string
description: The name of the chat instance from which the media message will be retrieved.
- name: binary
in: query
schema:
type: string
default: false
enum:
- true
- false
required: false
requestBody:
required: true
content:
Expand Down

0 comments on commit e640198

Please sign in to comment.