mirror of
https://github.com/EvolutionAPI/evolution-api.git
synced 2025-07-24 09:28:39 -06:00
adjusts in swagger
This commit is contained in:
Davidson Gomes
parent
d5eeb68714
commit
857031ff5a
@ -1368,6 +1368,181 @@ paths:
|
|||||||
description: Successful response
|
description: Successful response
|
||||||
content:
|
content:
|
||||||
application/json: {}
|
application/json: {}
|
||||||
|
/group/updateGroupSubject/{instanceName}:
|
||||||
|
put:
|
||||||
|
tags:
|
||||||
|
- Group Controller
|
||||||
|
summary: Update the group's display picture.
|
||||||
|
requestBody:
|
||||||
|
required: true
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
subject:
|
||||||
|
type: string
|
||||||
|
description: "- required - The new name of the group."
|
||||||
|
parameters:
|
||||||
|
- name: groupJid
|
||||||
|
in: query
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
description: "- required - The unique identifier of the group."
|
||||||
|
example: "120363046555718472@g.us"
|
||||||
|
- name: instanceName
|
||||||
|
in: path
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
required: true
|
||||||
|
description: "- required"
|
||||||
|
example: "evolution"
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: Successful response
|
||||||
|
content:
|
||||||
|
application/json: {}
|
||||||
|
/group/updateGroupDescription/{instanceName}:
|
||||||
|
put:
|
||||||
|
tags:
|
||||||
|
- Group Controller
|
||||||
|
summary: Update the group's display picture.
|
||||||
|
requestBody:
|
||||||
|
required: true
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
description:
|
||||||
|
type: string
|
||||||
|
description: "- required - The new description of the group."
|
||||||
|
parameters:
|
||||||
|
- name: groupJid
|
||||||
|
in: query
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
description: "- required - The unique identifier of the group."
|
||||||
|
example: "120363046555718472@g.us"
|
||||||
|
- name: instanceName
|
||||||
|
in: path
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
required: true
|
||||||
|
description: "- required"
|
||||||
|
example: "evolution"
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: Successful response
|
||||||
|
content:
|
||||||
|
application/json: {}
|
||||||
|
/group/inviteCode/{instanceName}:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- Group Controller
|
||||||
|
summary: Update the group's display picture.
|
||||||
|
parameters:
|
||||||
|
- name: groupJid
|
||||||
|
in: query
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
description: "- required - The unique identifier of the group."
|
||||||
|
example: "120363046555718472@g.us"
|
||||||
|
- name: instanceName
|
||||||
|
in: path
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
required: true
|
||||||
|
description: "- required"
|
||||||
|
example: "evolution"
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: Successful response
|
||||||
|
content:
|
||||||
|
application/json: {}
|
||||||
|
/group/revokeInviteCode/{instanceName}:
|
||||||
|
put:
|
||||||
|
tags:
|
||||||
|
- Group Controller
|
||||||
|
summary: Update the group's display picture.
|
||||||
|
parameters:
|
||||||
|
- name: groupJid
|
||||||
|
in: query
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
description: "- required - The unique identifier of the group."
|
||||||
|
example: "120363046555718472@g.us"
|
||||||
|
- name: instanceName
|
||||||
|
in: path
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
required: true
|
||||||
|
description: "- required"
|
||||||
|
example: "evolution"
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: Successful response
|
||||||
|
content:
|
||||||
|
application/json: {}
|
||||||
|
/group/sendInvite/{instanceName}:
|
||||||
|
post:
|
||||||
|
tags:
|
||||||
|
- Group Controller
|
||||||
|
summary: Update the group's display picture.
|
||||||
|
requestBody:
|
||||||
|
required: true
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
groupJid:
|
||||||
|
type: string
|
||||||
|
description: "The unique identifier of the group."
|
||||||
|
description:
|
||||||
|
type: string
|
||||||
|
description: "The new description of the group."
|
||||||
|
numbers:
|
||||||
|
type: array
|
||||||
|
description: "List of participant phone numbers to be invited."
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
parameters:
|
||||||
|
- name: instanceName
|
||||||
|
in: path
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
required: true
|
||||||
|
description: "- required"
|
||||||
|
example: "evolution"
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: Successful response
|
||||||
|
content:
|
||||||
|
application/json: {}
|
||||||
|
/group/inviteInfo/{instanceName}:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- Group Controller
|
||||||
|
summary: Retrieve details about a specific group.
|
||||||
|
parameters:
|
||||||
|
- name: inviteCode
|
||||||
|
in: query
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
description: "- required - The invite code of the group."
|
||||||
|
- name: instanceName
|
||||||
|
in: path
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
required: true
|
||||||
|
description: "- required"
|
||||||
|
example: "evolution"
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: Successful response
|
||||||
|
content:
|
||||||
|
application/json: {}
|
||||||
/group/findGroupInfos/{instanceName}:
|
/group/findGroupInfos/{instanceName}:
|
||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
@ -1392,6 +1567,29 @@ paths:
|
|||||||
description: Successful response
|
description: Successful response
|
||||||
content:
|
content:
|
||||||
application/json: {}
|
application/json: {}
|
||||||
|
/group/fetchAllGroups/{instanceName}:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- Group Controller
|
||||||
|
summary: Retrieve details about a specific group.
|
||||||
|
parameters:
|
||||||
|
- name: getParticipants
|
||||||
|
in: query
|
||||||
|
schema:
|
||||||
|
type: boolean
|
||||||
|
description: "- required - Indicates whether to retrieve the participants of the group."
|
||||||
|
- name: instanceName
|
||||||
|
in: path
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
required: true
|
||||||
|
description: "- required"
|
||||||
|
example: "evolution"
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: Successful response
|
||||||
|
content:
|
||||||
|
application/json: {}
|
||||||
/group/participants/{instanceName}:
|
/group/participants/{instanceName}:
|
||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
@ -1416,56 +1614,6 @@ paths:
|
|||||||
description: Successful response
|
description: Successful response
|
||||||
content:
|
content:
|
||||||
application/json: {}
|
application/json: {}
|
||||||
/group/inviteCode/{instanceName}:
|
|
||||||
get:
|
|
||||||
tags:
|
|
||||||
- Group Controller
|
|
||||||
summary: Retrieve the group's invite link.
|
|
||||||
parameters:
|
|
||||||
- name: groupJid
|
|
||||||
in: query
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
description: "- required - The unique identifier of the group."
|
|
||||||
example: "120363046555718472@g.us"
|
|
||||||
- name: instanceName
|
|
||||||
in: path
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
required: true
|
|
||||||
description: "- required"
|
|
||||||
example: "evolution"
|
|
||||||
responses:
|
|
||||||
"200":
|
|
||||||
description: Successful response
|
|
||||||
content:
|
|
||||||
application/json: {}
|
|
||||||
/group/revokeInviteCode/{instanceName}:
|
|
||||||
put:
|
|
||||||
tags:
|
|
||||||
- Group Controller
|
|
||||||
summary: Invalidate the existing group invite link.
|
|
||||||
requestBody:
|
|
||||||
content: {}
|
|
||||||
parameters:
|
|
||||||
- name: groupJid
|
|
||||||
in: query
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
description: "- required - The unique identifier of the group."
|
|
||||||
example: "120363046555718472@g.us"
|
|
||||||
- name: instanceName
|
|
||||||
in: path
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
required: true
|
|
||||||
description: "- required"
|
|
||||||
example: "evolution"
|
|
||||||
responses:
|
|
||||||
"200":
|
|
||||||
description: Successful response
|
|
||||||
content:
|
|
||||||
application/json: {}
|
|
||||||
/group/updateParticipant/{instanceName}:
|
/group/updateParticipant/{instanceName}:
|
||||||
put:
|
put:
|
||||||
tags:
|
tags:
|
||||||
@ -1500,6 +1648,63 @@ paths:
|
|||||||
description: Successful response
|
description: Successful response
|
||||||
content:
|
content:
|
||||||
application/json: {}
|
application/json: {}
|
||||||
|
/group/updateSetting/{instanceName}:
|
||||||
|
put:
|
||||||
|
tags:
|
||||||
|
- Group Controller
|
||||||
|
summary: Update the status or role of a participant in the group.
|
||||||
|
requestBody:
|
||||||
|
required: true
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
action:
|
||||||
|
type: string
|
||||||
|
enum: ["announcement", "not_announcement", "locked", "unlocked"]
|
||||||
|
description: "- required - The action to be taken on the participant."
|
||||||
|
parameters:
|
||||||
|
- name: instanceName
|
||||||
|
in: path
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
required: true
|
||||||
|
description: "- required"
|
||||||
|
example: "evolution"
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: Successful response
|
||||||
|
content:
|
||||||
|
application/json: {}
|
||||||
|
/group/toggleEphemeral/{instanceName}:
|
||||||
|
put:
|
||||||
|
tags:
|
||||||
|
- Group Controller
|
||||||
|
summary: Update the status or role of a participant in the group.
|
||||||
|
requestBody:
|
||||||
|
required: true
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
expiration:
|
||||||
|
type: number
|
||||||
|
description: "- required - The action to be taken on the participant."
|
||||||
|
parameters:
|
||||||
|
- name: instanceName
|
||||||
|
in: path
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
required: true
|
||||||
|
description: "- required"
|
||||||
|
example: "evolution"
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: Successful response
|
||||||
|
content:
|
||||||
|
application/json: {}
|
||||||
/group/leaveGroup/{instanceName}:
|
/group/leaveGroup/{instanceName}:
|
||||||
delete:
|
delete:
|
||||||
tags:
|
tags:
|
||||||
@ -1552,13 +1757,23 @@ paths:
|
|||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
enabled:
|
|
||||||
type: boolean
|
|
||||||
description: "Indicates whether the webhook is active."
|
|
||||||
url:
|
url:
|
||||||
type: string
|
type: string
|
||||||
format: uri
|
format: uri
|
||||||
description: "The endpoint URL where the webhook data will be sent."
|
description: "The endpoint URL where the webhook data will be sent."
|
||||||
|
webhook_by_events:
|
||||||
|
type: boolean
|
||||||
|
description: "Indicates whether to send the webhook data by events."
|
||||||
|
webhook_base64:
|
||||||
|
type: boolean
|
||||||
|
description: "Indicates whether to send the webhook data in Base64 format."
|
||||||
|
events:
|
||||||
|
type: array
|
||||||
|
enum: [ "APPLICATION_STARTUP", "QRCODE_UPDATED", "MESSAGES_SET", "MESSAGES_UPSERT", "MESSAGES_UPDATE", "MESSAGES_DELETE", "SEND_MESSAGE", "CONTACTS_SET", "CONTACTS_UPSERT", "CONTACTS_UPDATE", "PRESENCE_UPDATE", "CHATS_SET", "CHATS_UPSERT", "CHATS_UPDATE", "CHATS_DELETE", "GROUPS_UPSERT", "GROUP_UPDATE", "GROUP_PARTICIPANTS_UPDATE", "CONNECTION_UPDATE", "CALL", "NEW_JWT_TOKEN" ]
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
description: "List of events to be sent to the webhook."
|
||||||
|
|
||||||
parameters:
|
parameters:
|
||||||
- name: instanceName
|
- name: instanceName
|
||||||
in: path
|
in: path
|
||||||
|
|||||||
@ -48,7 +48,7 @@ const typebotSchema = new Schema<TypebotRaw>({
|
|||||||
prefilledVariables: {
|
prefilledVariables: {
|
||||||
remoteJid: { type: String, required: false },
|
remoteJid: { type: String, required: false },
|
||||||
pushName: { type: String, required: false },
|
pushName: { type: String, required: false },
|
||||||
additionalData: { type: Schema.Types.Mixed, required: false }
|
additionalData: { type: Schema.Types.Mixed, required: false },
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user