Evolution API / Evolution Go is an open-source WhatsApp integration API
Go baileyscloud-apievo-apievo-goevolutionevolution-apievolution-gogolangwhatsappwhatsapp-botwhatsmeow
definitions:
gin.H:
additionalProperties: {}
type: object
github_com_EvolutionAPI_evolution-go_pkg_call_service.RejectCallStruct:
properties:
callCreator:
$ref: '#/definitions/types.JID'
callId:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_chat_service.BodyStruct:
properties:
chat:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_chat_service.HistorySyncRequestStruct:
properties:
count:
type: integer
messageInfo:
$ref: '#/definitions/types.MessageInfo'
type: object
github_com_EvolutionAPI_evolution-go_pkg_community_service.AddParticipantStruct:
properties:
communityJid:
type: string
groupJid:
items:
type: string
type: array
type: object
github_com_EvolutionAPI_evolution-go_pkg_community_service.CreateCommunityStruct:
properties:
communityName:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_group_service.AddParticipantStruct:
properties:
action:
$ref: '#/definitions/whatsmeow.ParticipantChange'
groupJid:
$ref: '#/definitions/types.JID'
participants:
items:
type: string
type: array
type: object
github_com_EvolutionAPI_evolution-go_pkg_group_service.CreateGroupStruct:
properties:
groupName:
type: string
participants:
items:
type: string
type: array
type: object
github_com_EvolutionAPI_evolution-go_pkg_group_service.GetGroupInfoStruct:
properties:
groupJid:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_group_service.GetGroupInviteLinkStruct:
properties:
groupJid:
type: string
reset:
type: boolean
type: object
github_com_EvolutionAPI_evolution-go_pkg_group_service.JoinGroupStruct:
properties:
code:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_group_service.LeaveGroupStruct:
properties:
groupJid:
$ref: '#/definitions/types.JID'
type: object
github_com_EvolutionAPI_evolution-go_pkg_group_service.SetGroupDescriptionStruct:
properties:
description:
type: string
groupJid:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_group_service.SetGroupNameStruct:
properties:
groupJid:
type: string
name:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_group_service.SetGroupPhotoStruct:
properties:
groupJid:
type: string
image:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_group_service.UpdateGroupSettingsStruct:
properties:
action:
description: announcement, not_announcement, locked, unlocked
type: string
groupJid:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_instance_model.AdvancedSettings:
properties:
alwaysOnline:
type: boolean
ignoreGroups:
type: boolean
ignoreStatus:
type: boolean
msgRejectCall:
type: string
readMessages:
type: boolean
rejectCall:
type: boolean
type: object
github_com_EvolutionAPI_evolution-go_pkg_instance_service.ConnectStruct:
properties:
immediate:
type: boolean
natsEnable:
type: string
phone:
type: string
rabbitmqEnable:
type: string
subscribe:
items:
type: string
type: array
webhookUrl:
type: string
websocketEnable:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_instance_service.CreateStruct:
properties:
advancedSettings:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_instance_model.AdvancedSettings'
instanceId:
type: string
name:
type: string
proxy:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_instance_service.ProxyConfig'
token:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_instance_service.ForceReconnectStruct:
properties:
number:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_instance_service.PairStruct:
properties:
phone:
type: string
subscribe:
items:
type: string
type: array
type: object
github_com_EvolutionAPI_evolution-go_pkg_instance_service.ProxyConfig:
properties:
host:
type: string
password:
type: string
port:
type: string
protocol:
type: string
username:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_instance_service.SetProxyStruct:
properties:
host:
type: string
password:
type: string
port:
type: string
protocol:
type: string
username:
type: string
required:
- host
- port
type: object
github_com_EvolutionAPI_evolution-go_pkg_label_service.ChatLabelStruct:
properties:
jid:
type: string
labelId:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_label_service.EditLabelStruct:
properties:
color:
type: integer
deleted:
type: boolean
labelId:
type: string
name:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_label_service.MessageLabelStruct:
properties:
jid:
type: string
labelId:
type: string
messageId:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_message_service.ChatPresenceStruct:
properties:
delay:
description: |-
Delay, in milliseconds, keeps the "composing"/"recording" indicator alive
for the given duration (re-sending it periodically) and then sends "paused".
Only applies when State is "composing". 0 = single fire (legacy behaviour).
type: integer
isAudio:
type: boolean
number:
type: string
state:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_message_service.DownloadMediaStruct:
properties:
message:
$ref: '#/definitions/waE2E.Message'
type: object
github_com_EvolutionAPI_evolution-go_pkg_message_service.EditMessageStruct:
properties:
chat:
type: string
message:
type: string
messageId:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_message_service.MarkPlayedStruct:
properties:
id:
items:
type: string
type: array
number:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_message_service.MarkReadStruct:
properties:
id:
items:
type: string
type: array
number:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_message_service.MessageStatusStruct:
properties:
id:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_message_service.MessageStruct:
properties:
chat:
type: string
messageId:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_message_service.ReactStruct:
properties:
fromMe:
type: boolean
id:
type: string
number:
type: string
participant:
type: string
reaction:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_newsletter_service.CreateNewsletterStruct:
properties:
description:
type: string
name:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_newsletter_service.GetNewsletterInviteStruct:
properties:
key:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_newsletter_service.GetNewsletterMessagesStruct:
properties:
before_id:
type: integer
count:
type: integer
jid:
$ref: '#/definitions/types.JID'
type: object
github_com_EvolutionAPI_evolution-go_pkg_newsletter_service.GetNewsletterStruct:
properties:
jid:
$ref: '#/definitions/types.JID'
type: object
github_com_EvolutionAPI_evolution-go_pkg_poll_model.PollResults:
properties:
optionCounts:
additionalProperties:
type: integer
description: hash -> count
type: object
pollChatJid:
type: string
pollMessageId:
type: string
totalVotes:
type: integer
voters:
items:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_poll_model.VoterInfo'
type: array
votes:
items:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_poll_model.PollVote'
type: array
type: object
github_com_EvolutionAPI_evolution-go_pkg_poll_model.PollVote:
properties:
companyId:
type: string
id:
type: string
instanceId:
type: string
pollChatJid:
type: string
pollMessageId:
type: string
receivedAt:
type: string
selectedOptions:
description: SHA-256 hashes
items:
type: string
type: array
voteMessageId:
type: string
votedAt:
type: string
voterJid:
type: string
voterName:
type: string
voterPhone:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_poll_model.VoterInfo:
properties:
jid:
type: string
name:
type: string
phone:
type: string
selectedOptions:
items:
type: string
type: array
votedAt:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.Button:
properties:
copyCode:
description: Code placed in the clipboard when type=copy.
example: PROMO2026
type: string
currency:
description: ISO currency code for type=pix (e.g. BRL).
example: BRL
type: string
displayText:
description: Label rendered inside the button (reply / copy / url / call).
Ignored for pix.
example: Quero saber mais
type: string
id:
description: Callback payload for `reply` or code-to-copy internal id for
`copy`.
example: btn_info
type: string
key:
description: Pix key value matching the keyType.
example: "12345678900"
type: string
keyType:
description: 'Pix key type. One of: phone, email, cpf, cnpj, random.'
enum:
- phone
- email
- cpf
- cnpj
- random
example: cpf
type: string
name:
description: Merchant display name shown on the Pix sheet.
example: Minha Loja
type: string
phoneNumber:
description: Destination phone number (E.164) when type=call.
example: "+5582988898565"
type: string
type:
description: 'Button kind. One of: reply, copy, url, call, pix.'
enum:
- reply
- copy
- url
- call
- pix
example: reply
type: string
url:
description: Target URL when type=url.
example: https://evolutionapi.com
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.ButtonStruct:
properties:
buttons:
description: Buttons array. See combination rules on the parent type description.
items:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.Button'
type: array
delay:
description: Typing delay (milliseconds) applied before sending the message.
example: 1200
type: integer
description:
description: Body description text (required).
example: Confira as condicoes abaixo
type: string
footer:
description: Footer text (required).
example: Evolution GO
type: string
formatJid:
description: If false, skips automatic formatting/validation of `number` into
a JID.
type: boolean
imageUrl:
description: Optional image URL used as header for reply-only buttons.
type: string
mentionAll:
description: Mention every participant (groups only).
type: boolean
mentionedJid:
description: JIDs to mention inside the body text.
items:
type: string
type: array
number:
description: Destination phone number.
example: "5582988898565"
type: string
quoted:
allOf:
- $ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.QuotedStruct'
description: Quoted (reply-to) context.
title:
description: Header title (required).
example: Oferta especial
type: string
videoUrl:
description: Optional video URL used as header for reply-only buttons.
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.CarouselButtonStruct:
properties:
copyCode:
description: Code placed in the clipboard when type=COPY.
example: PROMO2026
type: string
displayText:
description: Label rendered inside the button.
example: Quero saber mais
type: string
id:
description: 'Context-dependent: REPLY payload, URL target (type=URL) or phone
number (type=CALL).'
example: card1_info
type: string
type:
description: 'Button kind (case-insensitive). One of: REPLY (default), URL,
CALL, COPY.'
enum:
- REPLY
- URL
- CALL
- COPY
- reply
- url
- call
- copy
example: REPLY
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.CarouselCardBodyStruct:
properties:
text:
description: Main text of the card.
example: Card 1 - Oferta especial
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.CarouselCardHeaderStruct:
properties:
imageUrl:
description: Public URL to an image. Downloaded, uploaded to WhatsApp servers
and used as card media.
example: https://picsum.photos/seed/card1/600/400
type: string
subtitle:
description: Optional subtitle rendered below the title.
example: Somente hoje
type: string
title:
description: Optional visible title above the media.
example: Oferta do dia
type: string
videoUrl:
description: Public URL to a video. Used only when `imageUrl` is empty.
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.CarouselCardStruct:
properties:
body:
allOf:
- $ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.CarouselCardBodyStruct'
description: Card body text (required).
buttons:
description: Buttons shown on the card. See CarouselButtonStruct for combination
rules.
items:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.CarouselButtonStruct'
type: array
footer:
description: Optional footer rendered under the body.
example: Por tempo limitado
type: string
header:
allOf:
- $ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.CarouselCardHeaderStruct'
description: Card header (media + title/subtitle).
type: object
github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.CarouselStruct:
properties:
body:
description: Optional message body shown above the cards.
example: Confira nossas novidades!
type: string
cards:
description: Cards displayed in order. At least one card is required.
items:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.CarouselCardStruct'
type: array
delay:
description: Typing delay (milliseconds) applied before sending the message.
example: 1200
type: integer
footer:
description: Optional message footer shown below the cards.
example: Evolution GO
type: string
formatJid:
description: If false, skips automatic formatting/validation of `number` into
a JID.
type: boolean
number:
description: Destination phone number.
example: "5582988898565"
type: string
quoted:
allOf:
- $ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.QuotedStruct'
description: Quoted (reply-to) context.
type: object
github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.ContactStruct:
properties:
delay:
type: integer
formatJid:
type: boolean
id:
type: string
mentionAll:
type: boolean
mentionedJid:
items:
type: string
type: array
number:
type: string
quoted:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.QuotedStruct'
vcard:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_utils.VCardStruct'
type: object
github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.LinkStruct:
properties:
delay:
type: integer
description:
type: string
formatJid:
type: boolean
id:
type: string
imgUrl:
type: string
mentionAll:
type: boolean
mentionedJid:
items:
type: string
type: array
number:
type: string
quoted:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.QuotedStruct'
text:
type: string
title:
type: string
url:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.ListStruct:
properties:
buttonText:
description: Label of the button that opens the list. Defaults to "Ver Menu"
when empty.
example: Abrir cardapio
type: string
delay:
description: Typing delay (milliseconds) applied before sending the message.
example: 1200
type: integer
description:
description: Body description text (required).
example: Escolha o plano ideal para voce
type: string
footerText:
description: Footer text (required).
example: Evolution GO
type: string
formatJid:
description: If false, skips automatic formatting/validation of `number` into
a JID.
type: boolean
mentionAll:
description: Mention every participant (groups only).
type: boolean
mentionedJid:
description: JIDs to mention inside the body text.
items:
type: string
type: array
number:
description: Destination phone number.
example: "5582988898565"
type: string
quoted:
allOf:
- $ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.QuotedStruct'
description: Quoted (reply-to) context.
sections:
description: Sections with rows. At least one section with one row is required.
items:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.Section'
type: array
title:
description: Header title (required).
example: Nossos planos
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.LocationStruct:
properties:
address:
type: string
delay:
type: integer
formatJid:
type: boolean
id:
type: string
latitude:
type: number
longitude:
type: number
mentionAll:
type: boolean
mentionedJid:
items:
type: string
type: array
name:
type: string
number:
type: string
quoted:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.QuotedStruct'
type: object
github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.MediaStruct:
properties:
caption:
type: string
delay:
type: integer
filename:
type: string
formatJid:
type: boolean
forwardingScore:
type: integer
id:
type: string
mentionAll:
type: boolean
mentionedJid:
items:
type: string
type: array
number:
type: string
quoted:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.QuotedStruct'
type:
type: string
url:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.PollStruct:
properties:
delay:
type: integer
formatJid:
type: boolean
id:
type: string
maxAnswer:
type: integer
mentionAll:
type: boolean
mentionedJid:
items:
type: string
type: array
number:
type: string
options:
items:
type: string
type: array
question:
type: string
quoted:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.QuotedStruct'
type: object
github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.QuotedStruct:
properties:
messageId:
type: string
participant:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.Row:
properties:
description:
description: Optional secondary line below the title.
example: R$ 29,90/mes
type: string
rowId:
description: Callback payload returned when the user taps the row. Auto-generated
if empty.
example: plan_basic
type: string
title:
description: Row main label.
example: Plano Basico
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.Section:
properties:
rows:
description: Rows inside this section.
items:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.Row'
type: array
title:
description: Section heading (optional; rendered as a group separator).
example: Planos
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.StatusTextStruct:
properties:
id:
type: string
text:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.StickerStruct:
properties:
delay:
type: integer
formatJid:
type: boolean
id:
type: string
mentionAll:
type: boolean
mentionedJid:
items:
type: string
type: array
number:
type: string
quoted:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.QuotedStruct'
sticker:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.TextStruct:
properties:
delay:
type: integer
formatJid:
type: boolean
forwardingScore:
type: integer
id:
type: string
mentionAll:
type: boolean
mentionedJid:
items:
type: string
type: array
number:
type: string
quoted:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.QuotedStruct'
text:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_user_service.BlockStruct:
properties:
number:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_user_service.CheckUserStruct:
properties:
formatJid:
type: boolean
number:
items:
type: string
type: array
type: object
github_com_EvolutionAPI_evolution-go_pkg_user_service.GetAvatarStruct:
properties:
number:
type: string
preview:
type: boolean
type: object
github_com_EvolutionAPI_evolution-go_pkg_user_service.PrivacyStruct:
properties:
callAdd:
$ref: '#/definitions/types.PrivacySetting'
groupAdd:
$ref: '#/definitions/types.PrivacySetting'
lastSeen:
$ref: '#/definitions/types.PrivacySetting'
online:
$ref: '#/definitions/types.PrivacySetting'
profile:
$ref: '#/definitions/types.PrivacySetting'
readReceipts:
$ref: '#/definitions/types.PrivacySetting'
status:
$ref: '#/definitions/types.PrivacySetting'
type: object
github_com_EvolutionAPI_evolution-go_pkg_user_service.SetProfilePictureStruct:
properties:
image:
type: string
type: object
github_com_EvolutionAPI_evolution-go_pkg_utils.VCardStruct:
properties:
fullName:
type: string
organization:
type: string
phone:
type: string
type: object
types.AddressingMode:
enum:
- pn
- lid
type: string
x-enum-varnames:
- AddressingModePN
- AddressingModeLID
types.BotEditType:
enum:
- first
- inner
- last
type: string
x-enum-varnames:
- EditTypeFirst
- EditTypeInner
- EditTypeLast
types.BroadcastRecipient:
properties:
lid:
$ref: '#/definitions/types.JID'
pn:
$ref: '#/definitions/types.JID'
type: object
types.DeviceSentMeta:
properties:
destinationJID:
description: The destination user. This should match the MessageInfo.Recipient
field.
type: string
phash:
type: string
type: object
types.EditAttribute:
enum:
- ""
- "1"
- "2"
- "3"
- "7"
- "8"
type: string
x-enum-comments:
EditAttributeAdminEdit: only used in newsletters
x-enum-descriptions:
- ""
- ""
- ""
- only used in newsletters
- ""
- ""
x-enum-varnames:
- EditAttributeEmpty
- EditAttributeMessageEdit
- EditAttributePinInChat
- EditAttributeAdminEdit
- EditAttributeSenderRevoke
- EditAttributeAdminRevoke
types.JID:
properties:
device:
format: int32
type: integer
integrator:
format: int32
type: integer
rawAgent:
format: int32
type: integer
server:
type: string
user:
type: string
type: object
types.MessageInfo:
properties:
addressingMode:
allOf:
- $ref: '#/definitions/types.AddressingMode'
description: The addressing mode of the message (phone number or LID)
broadcastListOwner:
allOf:
- $ref: '#/definitions/types.JID'
description: |-
When sending a read receipt to a broadcast list message, the Chat is the broadcast list
and Sender is you, so this field contains the recipient of the read receipt.
broadcastRecipients:
items:
$ref: '#/definitions/types.BroadcastRecipient'
type: array
category:
type: string
chat:
allOf:
- $ref: '#/definitions/types.JID'
description: The chat where the message was sent.
deviceSentMeta:
allOf:
- $ref: '#/definitions/types.DeviceSentMeta'
description: Metadata for direct messages sent from another one of the user's
own devices.
edit:
$ref: '#/definitions/types.EditAttribute'
id:
type: string
isFromMe:
description: Whether the message was sent by the current user instead of someone
else.
type: boolean
isGroup:
description: Whether the chat is a group chat or broadcast list.
type: boolean
mediaType:
type: string
msgBotInfo:
$ref: '#/definitions/types.MsgBotInfo'
msgMetaInfo:
$ref: '#/definitions/types.MsgMetaInfo'
multicast:
type: boolean
pushName:
type: string
recipientAlt:
allOf:
- $ref: '#/definitions/types.JID'
description: The alternative address of the recipient of the message for DMs.
sender:
allOf:
- $ref: '#/definitions/types.JID'
description: The user who sent the message.
senderAlt:
allOf:
- $ref: '#/definitions/types.JID'
description: The alternative address of the user who sent the message
serverID:
type: integer
timestamp:
type: string
type:
type: string
verifiedName:
$ref: '#/definitions/types.VerifiedName'
type: object
types.MsgBotInfo:
properties:
editSenderTimestampMS:
type: string
editTargetID:
type: string
editType:
$ref: '#/definitions/types.BotEditType'
type: object
types.MsgMetaInfo:
properties:
deprecatedLIDSession:
type: boolean
targetChat:
$ref: '#/definitions/types.JID'
targetID:
description: Bot things
type: string
targetSender:
$ref: '#/definitions/types.JID'
threadMessageID:
type: string
threadMessageSenderJID:
$ref: '#/definitions/types.JID'
type: object
types.PrivacySetting:
enum:
- ""
- all
- contacts
- contact_allowlist
- contact_blacklist
- match_last_seen
- known
- none
- on_standard
- "off"
type: string
x-enum-varnames:
- PrivacySettingUndefined
- PrivacySettingAll
- PrivacySettingContacts
- PrivacySettingContactAllowlist
- PrivacySettingContactBlacklist
- PrivacySettingMatchLastSeen
- PrivacySettingKnown
- PrivacySettingNone
- PrivacySettingOnStandard
- PrivacySettingOff
types.VerifiedName:
properties:
certificate:
$ref: '#/definitions/waVnameCert.VerifiedNameCertificate'
details:
$ref: '#/definitions/waVnameCert.VerifiedNameCertificate_Details'
type: object
types.WebAuthnResponse:
properties:
id:
type: string
rawId:
items:
type: integer
type: array
response:
$ref: '#/definitions/types.WebAuthnResponseData'
type:
type: string
type: object
types.WebAuthnResponseData:
properties:
authenticatorData:
items:
type: integer
type: array
clientDataJSON:
items:
type: integer
type: array
signature:
items:
type: integer
type: array
userHandle:
items:
type: integer
type: array
type: object
waAICommon.AIMediaCollectionMessage:
properties:
collectionID:
type: string
expectedMediaCount:
type: integer
hasGlobalCaption:
type: boolean
type: object
waAICommon.AIMediaCollectionMetadata:
properties:
collectionID:
type: string
uploadOrderIndex:
type: integer
type: object
waAICommon.AIMetadataOperation:
properties:
hatchMetadataSync:
$ref: '#/definitions/waAICommon.HatchMetadataSync'
type: object
waAICommon.AIRegenerateMetadata:
properties:
messageKey:
$ref: '#/definitions/waCommon.MessageKey'
responseTimestampMS:
type: integer
type: object
waAICommon.AIRichResponseUnifiedResponse:
properties:
data:
items:
type: integer
type: array
type: object
waAICommon.AISubscriptionRequestType:
enum:
- 0
- 1
- 2
- 3
format: int32
type: integer
x-enum-varnames:
- AISubscriptionRequestType_UNSPECIFIED
- AISubscriptionRequestType_THINK_HARD
- AISubscriptionRequestType_IMAGE_GEN
- AISubscriptionRequestType_VIDEO_GEN
waAICommon.AISubscriptionUpsellMetadata:
properties:
requestType:
$ref: '#/definitions/waAICommon.AISubscriptionRequestType'
type: object
waAICommon.AIThreadInfo:
properties:
clientInfo:
$ref: '#/definitions/waAICommon.AIThreadInfo_AIThreadClientInfo'
serverInfo:
$ref: '#/definitions/waAICommon.AIThreadInfo_AIThreadServerInfo'
type: object
waAICommon.AIThreadInfo_AIThreadClientInfo:
properties:
sourceChatJID:
type: string
type:
$ref: '#/definitions/waAICommon.AIThreadInfo_AIThreadClientInfo_AIThreadType'
type: object
waAICommon.AIThreadInfo_AIThreadClientInfo_AIThreadType:
enum:
- 0
- 1
- 2
- 3
format: int32
type: integer
x-enum-varnames:
- AIThreadInfo_AIThreadClientInfo_UNKNOWN
- AIThreadInfo_AIThreadClientInfo_DEFAULT
- AIThreadInfo_AIThreadClientInfo_INCOGNITO
- AIThreadInfo_AIThreadClientInfo_SIDE_CHAT
waAICommon.AIThreadInfo_AIThreadServerInfo:
properties:
title:
type: string
type: object
waAICommon.BotAgeCollectionMetadata:
properties:
ageCollectionEligible:
type: boolean
ageCollectionType:
$ref: '#/definitions/waAICommon.BotAgeCollectionMetadata_AgeCollectionType'
shouldTriggerAgeCollectionOnClient:
type: boolean
type: object
waAICommon.BotAgeCollectionMetadata_AgeCollectionType:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- BotAgeCollectionMetadata_O18_BINARY
- BotAgeCollectionMetadata_WAFFLE
waAICommon.BotAgentDeepLinkMetadata:
properties:
token:
type: string
type: object
waAICommon.BotAgentMetadata:
properties:
deepLinkMetadata:
$ref: '#/definitions/waAICommon.BotAgentDeepLinkMetadata'
type: object
waAICommon.BotCapabilityMetadata:
properties:
capabilities:
items:
$ref: '#/definitions/waAICommon.BotCapabilityMetadata_BotCapabilityType'
type: array
type: object
waAICommon.BotCapabilityMetadata_BotCapabilityType:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
format: int32
type: integer
x-enum-varnames:
- BotCapabilityMetadata_UNKNOWN
- BotCapabilityMetadata_PROGRESS_INDICATOR
- BotCapabilityMetadata_RICH_RESPONSE_HEADING
- BotCapabilityMetadata_RICH_RESPONSE_NESTED_LIST
- BotCapabilityMetadata_AI_MEMORY
- BotCapabilityMetadata_RICH_RESPONSE_THREAD_SURFING
- BotCapabilityMetadata_RICH_RESPONSE_TABLE
- BotCapabilityMetadata_RICH_RESPONSE_CODE
- BotCapabilityMetadata_RICH_RESPONSE_STRUCTURED_RESPONSE
- BotCapabilityMetadata_RICH_RESPONSE_INLINE_IMAGE
- BotCapabilityMetadata_WA_IG_1P_PLUGIN_RANKING_CONTROL
- BotCapabilityMetadata_WA_IG_1P_PLUGIN_RANKING_UPDATE_1
- BotCapabilityMetadata_WA_IG_1P_PLUGIN_RANKING_UPDATE_2
- BotCapabilityMetadata_WA_IG_1P_PLUGIN_RANKING_UPDATE_3
- BotCapabilityMetadata_WA_IG_1P_PLUGIN_RANKING_UPDATE_4
- BotCapabilityMetadata_WA_IG_1P_PLUGIN_RANKING_UPDATE_5
- BotCapabilityMetadata_WA_IG_1P_PLUGIN_RANKING_UPDATE_6
- BotCapabilityMetadata_WA_IG_1P_PLUGIN_RANKING_UPDATE_7
- BotCapabilityMetadata_WA_IG_1P_PLUGIN_RANKING_UPDATE_8
- BotCapabilityMetadata_WA_IG_1P_PLUGIN_RANKING_UPDATE_9
- BotCapabilityMetadata_WA_IG_1P_PLUGIN_RANKING_UPDATE_10
- BotCapabilityMetadata_RICH_RESPONSE_SUB_HEADING
- BotCapabilityMetadata_RICH_RESPONSE_GRID_IMAGE
- BotCapabilityMetadata_AI_STUDIO_UGC_MEMORY
- BotCapabilityMetadata_RICH_RESPONSE_LATEX
- BotCapabilityMetadata_RICH_RESPONSE_MAPS
- BotCapabilityMetadata_RICH_RESPONSE_INLINE_REELS
- BotCapabilityMetadata_AGENTIC_PLANNING
- BotCapabilityMetadata_ACCOUNT_LINKING
- BotCapabilityMetadata_STREAMING_DISAGGREGATION
- BotCapabilityMetadata_RICH_RESPONSE_GRID_IMAGE_3P
- BotCapabilityMetadata_RICH_RESPONSE_LATEX_INLINE
- BotCapabilityMetadata_QUERY_PLAN
- BotCapabilityMetadata_PROACTIVE_MESSAGE
- BotCapabilityMetadata_RICH_RESPONSE_UNIFIED_RESPONSE
- BotCapabilityMetadata_PROMOTION_MESSAGE
- BotCapabilityMetadata_SIMPLIFIED_PROFILE_PAGE
- BotCapabilityMetadata_RICH_RESPONSE_SOURCES_IN_MESSAGE
- BotCapabilityMetadata_RICH_RESPONSE_SIDE_BY_SIDE_SURVEY
- BotCapabilityMetadata_RICH_RESPONSE_UNIFIED_TEXT_COMPONENT
- BotCapabilityMetadata_AI_SHARED_MEMORY
- BotCapabilityMetadata_RICH_RESPONSE_UNIFIED_SOURCES
- BotCapabilityMetadata_RICH_RESPONSE_UNIFIED_DOMAIN_CITATIONS
- BotCapabilityMetadata_RICH_RESPONSE_UR_INLINE_REELS_ENABLED
- BotCapabilityMetadata_RICH_RESPONSE_UR_MEDIA_GRID_ENABLED
- BotCapabilityMetadata_RICH_RESPONSE_UR_TIMESTAMP_PLACEHOLDER
- BotCapabilityMetadata_RICH_RESPONSE_IN_APP_SURVEY
- BotCapabilityMetadata_AI_RESPONSE_MODEL_BRANDING
- BotCapabilityMetadata_SESSION_TRANSPARENCY_SYSTEM_MESSAGE
- BotCapabilityMetadata_RICH_RESPONSE_UR_REASONING
- BotCapabilityMetadata_RICH_RESPONSE_UR_ZEITGEIST_CITATIONS
- BotCapabilityMetadata_RICH_RESPONSE_UR_ZEITGEIST_CAROUSEL
- BotCapabilityMetadata_AI_IMAGINE_LOADING_INDICATOR
- BotCapabilityMetadata_RICH_RESPONSE_UR_IMAGINE
- BotCapabilityMetadata_AI_IMAGINE_UR_TO_NATIVE_LOADING_INDICATOR
- BotCapabilityMetadata_RICH_RESPONSE_UR_BLOKS_ENABLED
- BotCapabilityMetadata_RICH_RESPONSE_INLINE_LINKS_ENABLED
- BotCapabilityMetadata_RICH_RESPONSE_UR_IMAGINE_VIDEO
- BotCapabilityMetadata_JSON_PATCH_STREAMING
- BotCapabilityMetadata_AI_TAB_FORCE_CLIPPY
- BotCapabilityMetadata_UNIFIED_RESPONSE_EMBEDDED_SCREENS
- BotCapabilityMetadata_AI_SUBSCRIPTION_ENABLED
- BotCapabilityMetadata_UNIFIED_RESPONSE_AI_CONTENT_SEARCH_ENABLED
- BotCapabilityMetadata_UNIFIED_RESPONSE_MARKDOWN_LINKS_ENABLED
- BotCapabilityMetadata_AI_RICH_RESPONSE_MAPS_V2_ENABLED
- BotCapabilityMetadata_AI_SUBSCRIPTION_METERING_ENABLED
waAICommon.BotCommandMetadata:
properties:
commandDescription:
type: string
commandName:
type: string
commandPrompt:
type: string
type: object
waAICommon.BotDocumentMessageMetadata:
properties:
pluginType:
$ref: '#/definitions/waAICommon.BotDocumentMessageMetadata_DocumentPluginType'
type: object
waAICommon.BotDocumentMessageMetadata_DocumentPluginType:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- BotDocumentMessageMetadata_TEXT_EXTRACTION
- BotDocumentMessageMetadata_OCR_AND_IMAGES
waAICommon.BotFeedbackMessage:
properties:
kind:
$ref: '#/definitions/waAICommon.BotFeedbackMessage_BotFeedbackKind'
kindNegative:
type: integer
kindPositive:
type: integer
kindReport:
$ref: '#/definitions/waAICommon.BotFeedbackMessage_ReportKind'
messageKey:
$ref: '#/definitions/waCommon.MessageKey'
sideBySideSurveyMetadata:
$ref: '#/definitions/waAICommon.BotFeedbackMessage_SideBySideSurveyMetadata'
text:
type: string
type: object
waAICommon.BotFeedbackMessage_BotFeedbackKind:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
format: int32
type: integer
x-enum-varnames:
- BotFeedbackMessage_BOT_FEEDBACK_POSITIVE
- BotFeedbackMessage_BOT_FEEDBACK_NEGATIVE_GENERIC
- BotFeedbackMessage_BOT_FEEDBACK_NEGATIVE_HELPFUL
- BotFeedbackMessage_BOT_FEEDBACK_NEGATIVE_INTERESTING
- BotFeedbackMessage_BOT_FEEDBACK_NEGATIVE_ACCURATE
- BotFeedbackMessage_BOT_FEEDBACK_NEGATIVE_SAFE
- BotFeedbackMessage_BOT_FEEDBACK_NEGATIVE_OTHER
- BotFeedbackMessage_BOT_FEEDBACK_NEGATIVE_REFUSED
- BotFeedbackMessage_BOT_FEEDBACK_NEGATIVE_NOT_VISUALLY_APPEALING
- BotFeedbackMessage_BOT_FEEDBACK_NEGATIVE_NOT_RELEVANT_TO_TEXT
- BotFeedbackMessage_BOT_FEEDBACK_NEGATIVE_PERSONALIZED
- BotFeedbackMessage_BOT_FEEDBACK_NEGATIVE_CLARITY
- BotFeedbackMessage_BOT_FEEDBACK_NEGATIVE_DOESNT_LOOK_LIKE_THE_PERSON
- BotFeedbackMessage_BOT_FEEDBACK_NEGATIVE_HALLUCINATION_INTERNAL_ONLY
- BotFeedbackMessage_BOT_FEEDBACK_NEGATIVE
waAICommon.BotFeedbackMessage_ReportKind:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- BotFeedbackMessage_NONE
- BotFeedbackMessage_GENERIC
waAICommon.BotFeedbackMessage_SideBySideSurveyMetadata:
properties:
analyticsData:
$ref: '#/definitions/waAICommon.BotFeedbackMessage_SideBySideSurveyMetadata_SideBySideSurveyAnalyticsData'
isSelectedResponsePrimary:
type: boolean
messageIDToEdit:
type: string
metaAiAnalyticsData:
$ref: '#/definitions/waAICommon.BotFeedbackMessage_SideBySideSurveyMetadata_SidebySideSurveyMetaAiAnalyticsData'
responseOtid:
type: string
responseTimestampMSString:
type: string
selectedRequestID:
type: string
simonSessionFbid:
type: string
surveyID:
type: integer
type: object
waAICommon.BotFeedbackMessage_SideBySideSurveyMetadata_SideBySideSurveyAnalyticsData:
properties:
simonSessionFbid:
type: string
tessaEvent:
type: string
tessaSessionFbid:
type: string
type: object
waAICommon.BotFeedbackMessage_SideBySideSurveyMetadata_SidebySideSurveyMetaAiAnalyticsData:
properties:
abandonEvent:
$ref: '#/definitions/waAICommon.BotFeedbackMessage_SideBySideSurveyMetadata_SidebySideSurveyMetaAiAnalyticsData_SideBySideSurveyAbandonEventData'
cardImpressionEvent:
$ref: '#/definitions/waAICommon.BotFeedbackMessage_SideBySideSurveyMetadata_SidebySideSurveyMetaAiAnalyticsData_SideBySideSurveyCardImpressionEventData'
ctaClickEvent:
$ref: '#/definitions/waAICommon.BotFeedbackMessage_SideBySideSurveyMetadata_SidebySideSurveyMetaAiAnalyticsData_SideBySideSurveyCTAClickEventData'
ctaImpressionEvent:
$ref: '#/definitions/waAICommon.BotFeedbackMessage_SideBySideSurveyMetadata_SidebySideSurveyMetaAiAnalyticsData_SideBySideSurveyCTAImpressionEventData'
primaryResponseID:
type: string
responseEvent:
$ref: '#/definitions/waAICommon.BotFeedbackMessage_SideBySideSurveyMetadata_SidebySideSurveyMetaAiAnalyticsData_SideBySideSurveyResponseEventData'
surveyID:
type: integer
testArmName:
type: string
timestampMSString:
type: string
type: object
waAICommon.BotFeedbackMessage_SideBySideSurveyMetadata_SidebySideSurveyMetaAiAnalyticsData_SideBySideSurveyAbandonEventData:
properties:
abandonDwellTimeMSString:
type: string
type: object
waAICommon.BotFeedbackMessage_SideBySideSurveyMetadata_SidebySideSurveyMetaAiAnalyticsData_SideBySideSurveyCTAClickEventData:
properties:
clickDwellTimeMSString:
type: string
isSurveyExpired:
type: boolean
type: object
? waAICommon.BotFeedbackMessage_SideBySideSurveyMetadata_SidebySideSurveyMetaAiAnalyticsData_SideBySideSurveyCTAImpressionEventData
: properties:
isSurveyExpired:
type: boolean
type: object
? waAICommon.BotFeedbackMessage_SideBySideSurveyMetadata_SidebySideSurveyMetaAiAnalyticsData_SideBySideSurveyCardImpressionEventData
: type: object
waAICommon.BotFeedbackMessage_SideBySideSurveyMetadata_SidebySideSurveyMetaAiAnalyticsData_SideBySideSurveyResponseEventData:
properties:
responseDwellTimeMSString:
type: string
selectedResponseID:
type: string
type: object
waAICommon.BotGroupMetadata:
properties:
participantsMetadata:
items:
$ref: '#/definitions/waAICommon.BotGroupParticipantMetadata'
type: array
type: object
waAICommon.BotGroupParticipantMetadata:
properties:
botFbid:
type: string
type: object
waAICommon.BotImagineMetadata:
properties:
imagineType:
$ref: '#/definitions/waAICommon.BotImagineMetadata_ImagineType'
shortPrompt:
type: string
type: object
waAICommon.BotImagineMetadata_ImagineType:
enum:
- 0
- 1
- 2
- 3
- 4
format: int32
type: integer
x-enum-varnames:
- BotImagineMetadata_UNKNOWN
- BotImagineMetadata_IMAGINE
- BotImagineMetadata_MEMU
- BotImagineMetadata_FLASH
- BotImagineMetadata_EDIT
waAICommon.BotInfrastructureDiagnostics:
properties:
botBackend:
$ref: '#/definitions/waAICommon.BotInfrastructureDiagnostics_BotBackend'
isThinking:
type: boolean
toolsUsed:
items:
type: string
type: array
type: object
waAICommon.BotInfrastructureDiagnostics_BotBackend:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- BotInfrastructureDiagnostics_AAPI
- BotInfrastructureDiagnostics_CLIPPY
waAICommon.BotLinkedAccount:
properties:
type:
$ref: '#/definitions/waAICommon.BotLinkedAccount_BotLinkedAccountType'
type: object
waAICommon.BotLinkedAccount_BotLinkedAccountType:
enum:
- 0
format: int32
type: integer
x-enum-varnames:
- BotLinkedAccount_BOT_LINKED_ACCOUNT_TYPE_1P
waAICommon.BotLinkedAccountsMetadata:
properties:
acAuthTokens:
items:
type: integer
type: array
acErrorCode:
type: integer
accounts:
items:
$ref: '#/definitions/waAICommon.BotLinkedAccount'
type: array
type: object
waAICommon.BotMediaMetadata:
properties:
directPath:
type: string
fileEncSHA256:
type: string
fileSHA256:
type: string
mediaKey:
type: string
mediaKeyTimestamp:
type: integer
mimetype:
type: string
orientationType:
$ref: '#/definitions/waAICommon.BotMediaMetadata_OrientationType'
type: object
waAICommon.BotMediaMetadata_OrientationType:
enum:
- 1
- 2
- 3
format: int32
type: integer
x-enum-varnames:
- BotMediaMetadata_CENTER
- BotMediaMetadata_LEFT
- BotMediaMetadata_RIGHT
waAICommon.BotMemoryFact:
properties:
fact:
type: string
factID:
type: string
type: object
waAICommon.BotMemoryMetadata:
properties:
addedFacts:
items:
$ref: '#/definitions/waAICommon.BotMemoryFact'
type: array
disclaimer:
type: string
removedFacts:
items:
$ref: '#/definitions/waAICommon.BotMemoryFact'
type: array
type: object
waAICommon.BotMemuMetadata:
properties:
faceImages:
items:
$ref: '#/definitions/waAICommon.BotMediaMetadata'
type: array
type: object
waAICommon.BotMessageOrigin:
properties:
type:
$ref: '#/definitions/waAICommon.BotMessageOrigin_BotMessageOriginType'
type: object
waAICommon.BotMessageOrigin_BotMessageOriginType:
enum:
- 0
format: int32
type: integer
x-enum-varnames:
- BotMessageOrigin_BOT_MESSAGE_ORIGIN_TYPE_AI_INITIATED
waAICommon.BotMessageOriginMetadata:
properties:
origins:
items:
$ref: '#/definitions/waAICommon.BotMessageOrigin'
type: array
type: object
waAICommon.BotMessageSharingInfo:
properties:
botEntryPointOrigin:
$ref: '#/definitions/waAICommon.BotMetricsEntryPoint'
forwardScore:
type: integer
type: object
waAICommon.BotMetadata:
properties:
aiConversationContext:
items:
type: integer
type: array
aiMediaCollectionMetadata:
$ref: '#/definitions/waAICommon.AIMediaCollectionMetadata'
botAgeCollectionMetadata:
$ref: '#/definitions/waAICommon.BotAgeCollectionMetadata'
botDocumentMessageMetadata:
$ref: '#/definitions/waAICommon.BotDocumentMessageMetadata'
botGroupMetadata:
$ref: '#/definitions/waAICommon.BotGroupMetadata'
botInfrastructureDiagnostics:
$ref: '#/definitions/waAICommon.BotInfrastructureDiagnostics'
botLinkedAccountsMetadata:
$ref: '#/definitions/waAICommon.BotLinkedAccountsMetadata'
botMessageOriginMetadata:
$ref: '#/definitions/waAICommon.BotMessageOriginMetadata'
botMetricsMetadata:
$ref: '#/definitions/waAICommon.BotMetricsMetadata'
botModeSelectionMetadata:
$ref: '#/definitions/waAICommon.BotModeSelectionMetadata'
botPromotionMessageMetadata:
$ref: '#/definitions/waAICommon.BotPromotionMessageMetadata'
botQuotaMetadata:
$ref: '#/definitions/waAICommon.BotQuotaMetadata'
botRenderingConfigMetadata:
$ref: '#/definitions/waAICommon.BotRenderingConfigMetadata'
botResponseID:
type: string
botThreadInfo:
$ref: '#/definitions/waAICommon.AIThreadInfo'
capabilityMetadata:
$ref: '#/definitions/waAICommon.BotCapabilityMetadata'
commandMetadata:
$ref: '#/definitions/waAICommon.BotCommandMetadata'
conversationStarterPromptID:
type: string
imagineMetadata:
$ref: '#/definitions/waAICommon.BotImagineMetadata'
inThreadSurveyMetadata:
$ref: '#/definitions/waAICommon.InThreadSurveyMetadata'
internalMetadata:
items:
type: integer
type: array
invokerJID:
type: string
memoryMetadata:
$ref: '#/definitions/waAICommon.BotMemoryMetadata'
memuMetadata:
$ref: '#/definitions/waAICommon.BotMemuMetadata'
messageDisclaimerText:
type: string
modelMetadata:
$ref: '#/definitions/waAICommon.BotModelMetadata'
personaID:
type: string
pluginMetadata:
$ref: '#/definitions/waAICommon.BotPluginMetadata'
progressIndicatorMetadata:
$ref: '#/definitions/waAICommon.BotProgressIndicatorMetadata'
pttPromptMetadata:
$ref: '#/definitions/waAICommon.BotPttPromptMetadata'
regenerateMetadata:
$ref: '#/definitions/waAICommon.AIRegenerateMetadata'
reminderMetadata:
$ref: '#/definitions/waAICommon.BotReminderMetadata'
renderingMetadata:
$ref: '#/definitions/waAICommon.BotRenderingMetadata'
resolvedToolCallMetadata:
$ref: '#/definitions/waAICommon.BotResolvedToolCallMetadata'
richResponseSourcesMetadata:
$ref: '#/definitions/waAICommon.BotSourcesMetadata'
sessionMetadata:
$ref: '#/definitions/waAICommon.BotSessionMetadata'
sessionTransparencyMetadata:
$ref: '#/definitions/waAICommon.SessionTransparencyMetadata'
subscriptionUpsellMetadata:
$ref: '#/definitions/waAICommon.AISubscriptionUpsellMetadata'
suggestedPromptMetadata:
$ref: '#/definitions/waAICommon.BotSuggestedPromptMetadata'
timezone:
type: string
unifiedResponseMutation:
$ref: '#/definitions/waAICommon.BotUnifiedResponseMutation'
verificationMetadata:
$ref: '#/definitions/waAICommon.BotSignatureVerificationMetadata'
type: object
waAICommon.BotMetricsEntryPoint:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 45
- 46
- 47
- 54
- 55
- 56
format: int32
type: integer
x-enum-varnames:
- BotMetricsEntryPoint_UNDEFINED_ENTRY_POINT
- BotMetricsEntryPoint_FAVICON
- BotMetricsEntryPoint_CHATLIST
- BotMetricsEntryPoint_AISEARCH_NULL_STATE_PAPER_PLANE
- BotMetricsEntryPoint_AISEARCH_NULL_STATE_SUGGESTION
- BotMetricsEntryPoint_AISEARCH_TYPE_AHEAD_SUGGESTION
- BotMetricsEntryPoint_AISEARCH_TYPE_AHEAD_PAPER_PLANE
- BotMetricsEntryPoint_AISEARCH_TYPE_AHEAD_RESULT_CHATLIST
- BotMetricsEntryPoint_AISEARCH_TYPE_AHEAD_RESULT_MESSAGES
- BotMetricsEntryPoint_AIVOICE_SEARCH_BAR
- BotMetricsEntryPoint_AIVOICE_FAVICON
- BotMetricsEntryPoint_AISTUDIO
- BotMetricsEntryPoint_DEEPLINK
- BotMetricsEntryPoint_NOTIFICATION
- BotMetricsEntryPoint_PROFILE_MESSAGE_BUTTON
- BotMetricsEntryPoint_FORWARD
- BotMetricsEntryPoint_APP_SHORTCUT
- BotMetricsEntryPoint_FF_FAMILY
- BotMetricsEntryPoint_AI_TAB
- BotMetricsEntryPoint_AI_HOME
- BotMetricsEntryPoint_AI_DEEPLINK_IMMERSIVE
- BotMetricsEntryPoint_AI_DEEPLINK
- BotMetricsEntryPoint_META_AI_CHAT_SHORTCUT_AI_STUDIO
- BotMetricsEntryPoint_UGC_CHAT_SHORTCUT_AI_STUDIO
- BotMetricsEntryPoint_NEW_CHAT_AI_STUDIO
- BotMetricsEntryPoint_AIVOICE_FAVICON_CALL_HISTORY
- BotMetricsEntryPoint_ASK_META_AI_CONTEXT_MENU
- BotMetricsEntryPoint_ASK_META_AI_CONTEXT_MENU_1ON1
- BotMetricsEntryPoint_ASK_META_AI_CONTEXT_MENU_GROUP
- BotMetricsEntryPoint_INVOKE_META_AI_1ON1
- BotMetricsEntryPoint_INVOKE_META_AI_GROUP
- BotMetricsEntryPoint_META_AI_FORWARD
- BotMetricsEntryPoint_NEW_CHAT_AI_CONTACT
- BotMetricsEntryPoint_MESSAGE_QUICK_ACTION_1_ON_1_CHAT
- BotMetricsEntryPoint_MESSAGE_QUICK_ACTION_GROUP_CHAT
- BotMetricsEntryPoint_ATTACHMENT_TRAY_1_ON_1_CHAT
- BotMetricsEntryPoint_ATTACHMENT_TRAY_GROUP_CHAT
- BotMetricsEntryPoint_ASK_META_AI_MEDIA_VIEWER_1ON1
- BotMetricsEntryPoint_ASK_META_AI_MEDIA_VIEWER_GROUP
- BotMetricsEntryPoint_MEDIA_PICKER_1_ON_1_CHAT
- BotMetricsEntryPoint_MEDIA_PICKER_GROUP_CHAT
- BotMetricsEntryPoint_ASK_META_AI_NO_SEARCH_RESULTS
- BotMetricsEntryPoint_META_AI_SETTINGS
- BotMetricsEntryPoint_WEB_INTRO_PANEL
- BotMetricsEntryPoint_WEB_NAVIGATION_BAR
- BotMetricsEntryPoint_GROUP_MEMBER
- BotMetricsEntryPoint_CHATLIST_SEARCH
- BotMetricsEntryPoint_NEW_CHAT_LIST
waAICommon.BotMetricsMetadata:
properties:
destinationEntryPoint:
$ref: '#/definitions/waAICommon.BotMetricsEntryPoint'
destinationID:
type: string
threadOrigin:
$ref: '#/definitions/waAICommon.BotMetricsThreadEntryPoint'
type: object
waAICommon.BotMetricsThreadEntryPoint:
enum:
- 1
- 2
- 3
- 4
- 5
format: int32
type: integer
x-enum-varnames:
- BotMetricsThreadEntryPoint_AI_TAB_THREAD
- BotMetricsThreadEntryPoint_AI_HOME_THREAD
- BotMetricsThreadEntryPoint_AI_DEEPLINK_IMMERSIVE_THREAD
- BotMetricsThreadEntryPoint_AI_DEEPLINK_THREAD
- BotMetricsThreadEntryPoint_ASK_META_AI_CONTEXT_MENU_THREAD
waAICommon.BotModeSelectionMetadata:
properties:
mode:
items:
$ref: '#/definitions/waAICommon.BotModeSelectionMetadata_BotUserSelectionMode'
type: array
overrideMode:
items:
type: integer
type: array
type: object
waAICommon.BotModeSelectionMetadata_BotUserSelectionMode:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- BotModeSelectionMetadata_DEFAULT_MODE
- BotModeSelectionMetadata_THINK_HARD_MODE
waAICommon.BotModelMetadata:
properties:
modelNameOverride:
type: string
modelType:
$ref: '#/definitions/waAICommon.BotModelMetadata_ModelType'
premiumModelStatus:
$ref: '#/definitions/waAICommon.BotModelMetadata_PremiumModelStatus'
type: object
waAICommon.BotModelMetadata_ModelType:
enum:
- 0
- 1
- 2
format: int32
type: integer
x-enum-varnames:
- BotModelMetadata_UNKNOWN_TYPE
- BotModelMetadata_LLAMA_PROD
- BotModelMetadata_LLAMA_PROD_PREMIUM
waAICommon.BotModelMetadata_PremiumModelStatus:
enum:
- 0
- 1
- 2
format: int32
type: integer
x-enum-varnames:
- BotModelMetadata_UNKNOWN_STATUS
- BotModelMetadata_AVAILABLE
- BotModelMetadata_QUOTA_EXCEED_LIMIT
waAICommon.BotPluginMetadata:
properties:
deprecatedField:
$ref: '#/definitions/waAICommon.BotPluginMetadata_PluginType'
expectedLinksCount:
type: integer
faviconCDNURL:
type: string
parentPluginMessageKey:
$ref: '#/definitions/waCommon.MessageKey'
parentPluginType:
$ref: '#/definitions/waAICommon.BotPluginMetadata_PluginType'
pluginType:
$ref: '#/definitions/waAICommon.BotPluginMetadata_PluginType'
profilePhotoCDNURL:
type: string
provider:
$ref: '#/definitions/waAICommon.BotPluginMetadata_SearchProvider'
referenceIndex:
type: integer
searchProviderURL:
type: string
searchQuery:
type: string
thumbnailCDNURL:
type: string
type: object
waAICommon.BotPluginMetadata_PluginType:
enum:
- 0
- 1
- 2
format: int32
type: integer
x-enum-varnames:
- BotPluginMetadata_UNKNOWN_PLUGIN
- BotPluginMetadata_REELS
- BotPluginMetadata_SEARCH
waAICommon.BotPluginMetadata_SearchProvider:
enum:
- 0
- 1
- 2
- 3
format: int32
type: integer
x-enum-varnames:
- BotPluginMetadata_UNKNOWN
- BotPluginMetadata_BING
- BotPluginMetadata_GOOGLE
- BotPluginMetadata_SUPPORT
waAICommon.BotProgressIndicatorMetadata:
properties:
estimatedCompletionTime:
type: integer
progressDescription:
type: string
stepsMetadata:
items:
$ref: '#/definitions/waAICommon.BotProgressIndicatorMetadata_BotPlanningStepMetadata'
type: array
type: object
waAICommon.BotProgressIndicatorMetadata_BotPlanningStepMetadata:
properties:
isEnhancedSearch:
type: boolean
isReasoning:
type: boolean
sections:
items:
$ref: '#/definitions/waAICommon.BotProgressIndicatorMetadata_BotPlanningStepMetadata_BotPlanningStepSectionMetadata'
type: array
sourcesMetadata:
items:
$ref: '#/definitions/waAICommon.BotProgressIndicatorMetadata_BotPlanningStepMetadata_BotPlanningSearchSourcesMetadata'
type: array
status:
$ref: '#/definitions/waAICommon.BotProgressIndicatorMetadata_BotPlanningStepMetadata_PlanningStepStatus'
statusBody:
type: string
statusTitle:
type: string
type: object
waAICommon.BotProgressIndicatorMetadata_BotPlanningStepMetadata_BotPlanningSearchSourceMetadata:
properties:
favIconURL:
type: string
provider:
$ref: '#/definitions/waAICommon.BotProgressIndicatorMetadata_BotPlanningStepMetadata_BotSearchSourceProvider'
sourceURL:
type: string
title:
type: string
type: object
waAICommon.BotProgressIndicatorMetadata_BotPlanningStepMetadata_BotPlanningSearchSourcesMetadata:
properties:
provider:
$ref: '#/definitions/waAICommon.BotProgressIndicatorMetadata_BotPlanningStepMetadata_BotPlanningSearchSourcesMetadata_BotPlanningSearchSourceProvider'
sourceTitle:
type: string
sourceURL:
type: string
type: object
waAICommon.BotProgressIndicatorMetadata_BotPlanningStepMetadata_BotPlanningSearchSourcesMetadata_BotPlanningSearchSourceProvider:
enum:
- 0
- 1
- 2
- 3
format: int32
type: integer
x-enum-varnames:
- BotProgressIndicatorMetadata_BotPlanningStepMetadata_BotPlanningSearchSourcesMetadata_UNKNOWN
- BotProgressIndicatorMetadata_BotPlanningStepMetadata_BotPlanningSearchSourcesMetadata_OTHER
- BotProgressIndicatorMetadata_BotPlanningStepMetadata_BotPlanningSearchSourcesMetadata_GOOGLE
- BotProgressIndicatorMetadata_BotPlanningStepMetadata_BotPlanningSearchSourcesMetadata_BING
waAICommon.BotProgressIndicatorMetadata_BotPlanningStepMetadata_BotPlanningStepSectionMetadata:
properties:
sectionBody:
type: string
sectionTitle:
type: string
sourcesMetadata:
items:
$ref: '#/definitions/waAICommon.BotProgressIndicatorMetadata_BotPlanningStepMetadata_BotPlanningSearchSourceMetadata'
type: array
type: object
waAICommon.BotProgressIndicatorMetadata_BotPlanningStepMetadata_BotSearchSourceProvider:
enum:
- 0
- 1
- 2
- 3
format: int32
type: integer
x-enum-varnames:
- BotProgressIndicatorMetadata_BotPlanningStepMetadata_UNKNOWN_PROVIDER
- BotProgressIndicatorMetadata_BotPlanningStepMetadata_OTHER
- BotProgressIndicatorMetadata_BotPlanningStepMetadata_GOOGLE
- BotProgressIndicatorMetadata_BotPlanningStepMetadata_BING
waAICommon.BotProgressIndicatorMetadata_BotPlanningStepMetadata_PlanningStepStatus:
enum:
- 0
- 1
- 2
- 3
format: int32
type: integer
x-enum-varnames:
- BotProgressIndicatorMetadata_BotPlanningStepMetadata_UNKNOWN
- BotProgressIndicatorMetadata_BotPlanningStepMetadata_PLANNED
- BotProgressIndicatorMetadata_BotPlanningStepMetadata_EXECUTING
- BotProgressIndicatorMetadata_BotPlanningStepMetadata_FINISHED
waAICommon.BotPromotionMessageMetadata:
properties:
buttonTitle:
type: string
promotionType:
$ref: '#/definitions/waAICommon.BotPromotionMessageMetadata_BotPromotionType'
type: object
waAICommon.BotPromotionMessageMetadata_BotPromotionType:
enum:
- 0
- 1
- 2
format: int32
type: integer
x-enum-varnames:
- BotPromotionMessageMetadata_UNKNOWN_TYPE
- BotPromotionMessageMetadata_C50
- BotPromotionMessageMetadata_SURVEY_PLATFORM
waAICommon.BotPromptSuggestion:
properties:
prompt:
type: string
promptID:
type: string
type: object
waAICommon.BotPromptSuggestions:
properties:
suggestions:
items:
$ref: '#/definitions/waAICommon.BotPromptSuggestion'
type: array
type: object
waAICommon.BotPttPromptMetadata:
properties:
transcript:
type: string
type: object
waAICommon.BotQuotaMetadata:
properties:
botFeatureQuotaMetadata:
items:
$ref: '#/definitions/waAICommon.BotQuotaMetadata_BotFeatureQuotaMetadata'
type: array
type: object
waAICommon.BotQuotaMetadata_BotFeatureQuotaMetadata:
properties:
expirationTimestamp:
type: integer
featureType:
$ref: '#/definitions/waAICommon.BotQuotaMetadata_BotFeatureQuotaMetadata_BotFeatureType'
remainingQuota:
type: integer
type: object
waAICommon.BotQuotaMetadata_BotFeatureQuotaMetadata_BotFeatureType:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- BotQuotaMetadata_BotFeatureQuotaMetadata_UNKNOWN_FEATURE
- BotQuotaMetadata_BotFeatureQuotaMetadata_REASONING_FEATURE
waAICommon.BotReminderMetadata:
properties:
action:
$ref: '#/definitions/waAICommon.BotReminderMetadata_ReminderAction'
frequency:
$ref: '#/definitions/waAICommon.BotReminderMetadata_ReminderFrequency'
name:
type: string
nextTriggerTimestamp:
type: integer
requestMessageKey:
$ref: '#/definitions/waCommon.MessageKey'
type: object
waAICommon.BotReminderMetadata_ReminderAction:
enum:
- 1
- 2
- 3
- 4
format: int32
type: integer
x-enum-varnames:
- BotReminderMetadata_NOTIFY
- BotReminderMetadata_CREATE
- BotReminderMetadata_DELETE
- BotReminderMetadata_UPDATE
waAICommon.BotReminderMetadata_ReminderFrequency:
enum:
- 1
- 2
- 3
- 4
- 5
format: int32
type: integer
x-enum-varnames:
- BotReminderMetadata_ONCE
- BotReminderMetadata_DAILY
- BotReminderMetadata_WEEKLY
- BotReminderMetadata_BIWEEKLY
- BotReminderMetadata_MONTHLY
waAICommon.BotRenderingConfigMetadata:
properties:
bloksVersioningID:
type: string
pixelDensity:
type: number
type: object
waAICommon.BotRenderingMetadata:
properties:
keywords:
items:
$ref: '#/definitions/waAICommon.BotRenderingMetadata_Keyword'
type: array
type: object
waAICommon.BotRenderingMetadata_Keyword:
properties:
associatedPrompts:
items:
type: string
type: array
value:
type: string
type: object
waAICommon.BotResolvedToolCallMetadata:
properties:
resolutionDataSerialized:
type: string
toolCallID:
type: string
type: object
waAICommon.BotSessionMetadata:
properties:
sessionID:
type: string
sessionSource:
$ref: '#/definitions/waAICommon.BotSessionSource'
type: object
waAICommon.BotSessionSource:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
format: int32
type: integer
x-enum-varnames:
- BotSessionSource_NONE
- BotSessionSource_NULL_STATE
- BotSessionSource_TYPEAHEAD
- BotSessionSource_USER_INPUT
- BotSessionSource_EMU_FLASH
- BotSessionSource_EMU_FLASH_FOLLOWUP
- BotSessionSource_VOICE
- BotSessionSource_AI_HOME_SESSION
waAICommon.BotSignatureVerificationMetadata:
properties:
proofs:
items:
$ref: '#/definitions/waAICommon.BotSignatureVerificationUseCaseProof'
type: array
type: object
waAICommon.BotSignatureVerificationUseCaseProof:
properties:
certificateChain:
items:
items:
format: int32
type: integer
type: array
type: array
signature:
items:
type: integer
type: array
useCase:
$ref: '#/definitions/waAICommon.BotSignatureVerificationUseCaseProof_BotSignatureUseCase'
version:
type: integer
type: object
waAICommon.BotSignatureVerificationUseCaseProof_BotSignatureUseCase:
enum:
- 0
- 1
- 2
- 3
format: int32
type: integer
x-enum-varnames:
- BotSignatureVerificationUseCaseProof_UNSPECIFIED
- BotSignatureVerificationUseCaseProof_WA_BOT_MSG
- BotSignatureVerificationUseCaseProof_WA_TEE_BOT_MSG
- BotSignatureVerificationUseCaseProof_P2P_PILLS
waAICommon.BotSourcesMetadata:
properties:
sources:
items:
$ref: '#/definitions/waAICommon.BotSourcesMetadata_BotSourceItem'
type: array
type: object
waAICommon.BotSourcesMetadata_BotSourceItem:
properties:
citationNumber:
type: integer
faviconCDNURL:
type: string
provider:
$ref: '#/definitions/waAICommon.BotSourcesMetadata_BotSourceItem_SourceProvider'
sourceProviderURL:
type: string
sourceQuery:
type: string
sourceTitle:
type: string
thumbnailCDNURL:
type: string
type: object
waAICommon.BotSourcesMetadata_BotSourceItem_SourceProvider:
enum:
- 0
- 1
- 2
- 3
- 4
format: int32
type: integer
x-enum-varnames:
- BotSourcesMetadata_BotSourceItem_UNKNOWN
- BotSourcesMetadata_BotSourceItem_BING
- BotSourcesMetadata_BotSourceItem_GOOGLE
- BotSourcesMetadata_BotSourceItem_SUPPORT
- BotSourcesMetadata_BotSourceItem_OTHER
waAICommon.BotSuggestedPromptMetadata:
properties:
promptSuggestions:
$ref: '#/definitions/waAICommon.BotPromptSuggestions'
selectedPromptID:
type: string
selectedPromptIndex:
type: integer
suggestedPrompts:
items:
type: string
type: array
type: object
waAICommon.BotUnifiedResponseMutation:
properties:
mediaDetailsMetadataList:
items:
$ref: '#/definitions/waAICommon.BotUnifiedResponseMutation_MediaDetailsMetadata'
type: array
sbsMetadata:
$ref: '#/definitions/waAICommon.BotUnifiedResponseMutation_SideBySideMetadata'
type: object
waAICommon.BotUnifiedResponseMutation_MediaDetailsMetadata:
properties:
ID:
type: string
highResMedia:
$ref: '#/definitions/waAICommon.BotMediaMetadata'
previewMedia:
$ref: '#/definitions/waAICommon.BotMediaMetadata'
type: object
waAICommon.BotUnifiedResponseMutation_SideBySideMetadata:
properties:
primaryResponseID:
type: string
surveyCtaHasRendered:
type: boolean
type: object
waAICommon.ForwardedAIBotMessageInfo:
properties:
botJID:
type: string
botName:
type: string
creatorName:
type: string
type: object
waAICommon.HatchMetadataSync:
properties:
data:
items:
type: integer
type: array
requestID:
type: string
timestampMS:
type: integer
type: object
waAICommon.InThreadSurveyMetadata:
properties:
feedbackToastText:
type: string
invitationBodyText:
type: string
invitationCtaText:
type: string
invitationCtaURL:
type: string
invitationHeaderText:
type: string
privacyStatementFull:
type: string
privacyStatementParts:
items:
$ref: '#/definitions/waAICommon.InThreadSurveyMetadata_InThreadSurveyPrivacyStatementPart'
type: array
questions:
items:
$ref: '#/definitions/waAICommon.InThreadSurveyMetadata_InThreadSurveyQuestion'
type: array
requestID:
type: string
simonSessionID:
type: string
simonSurveyID:
type: string
startQuestionIndex:
type: integer
surveyContinueButtonText:
type: string
surveySubmitButtonText:
type: string
surveyTitle:
type: string
tessaEvent:
type: string
tessaRootID:
type: string
tessaSessionID:
type: string
type: object
waAICommon.InThreadSurveyMetadata_InThreadSurveyOption:
properties:
numericValue:
type: integer
stringValue:
type: string
textTranslated:
type: string
type: object
waAICommon.InThreadSurveyMetadata_InThreadSurveyPrivacyStatementPart:
properties:
URL:
type: string
text:
type: string
type: object
waAICommon.InThreadSurveyMetadata_InThreadSurveyQuestion:
properties:
questionID:
type: string
questionOptions:
items:
$ref: '#/definitions/waAICommon.InThreadSurveyMetadata_InThreadSurveyOption'
type: array
questionText:
type: string
type: object
waAICommon.SessionTransparencyMetadata:
properties:
disclaimerText:
type: string
hcaID:
type: string
sessionTransparencyType:
$ref: '#/definitions/waAICommon.SessionTransparencyType'
type: object
waAICommon.SessionTransparencyType:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- SessionTransparencyType_UNKNOWN_TYPE
- SessionTransparencyType_NY_AI_SAFETY_DISCLAIMER
waAICommonDeprecated.AIRichResponseCodeMetadata:
properties:
codeBlocks:
items:
$ref: '#/definitions/waAICommonDeprecated.AIRichResponseCodeMetadata_AIRichResponseCodeBlock'
type: array
codeLanguage:
type: string
type: object
waAICommonDeprecated.AIRichResponseCodeMetadata_AIRichResponseCodeBlock:
properties:
codeContent:
type: string
highlightType:
$ref: '#/definitions/waAICommonDeprecated.AIRichResponseCodeMetadata_AIRichResponseCodeHighlightType'
type: object
waAICommonDeprecated.AIRichResponseCodeMetadata_AIRichResponseCodeHighlightType:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
format: int32
type: integer
x-enum-varnames:
- AIRichResponseCodeMetadata_AI_RICH_RESPONSE_CODE_HIGHLIGHT_DEFAULT
- AIRichResponseCodeMetadata_AI_RICH_RESPONSE_CODE_HIGHLIGHT_KEYWORD
- AIRichResponseCodeMetadata_AI_RICH_RESPONSE_CODE_HIGHLIGHT_METHOD
- AIRichResponseCodeMetadata_AI_RICH_RESPONSE_CODE_HIGHLIGHT_STRING
- AIRichResponseCodeMetadata_AI_RICH_RESPONSE_CODE_HIGHLIGHT_NUMBER
- AIRichResponseCodeMetadata_AI_RICH_RESPONSE_CODE_HIGHLIGHT_COMMENT
waAICommonDeprecated.AIRichResponseContentItemsMetadata:
properties:
contentType:
$ref: '#/definitions/waAICommonDeprecated.AIRichResponseContentItemsMetadata_ContentType'
itemsMetadata:
items:
$ref: '#/definitions/waAICommonDeprecated.AIRichResponseContentItemsMetadata_AIRichResponseContentItemMetadata'
type: array
type: object
waAICommonDeprecated.AIRichResponseContentItemsMetadata_AIRichResponseContentItemMetadata:
properties:
airichResponseContentItem:
description: "Types that are valid to be assigned to AIRichResponseContentItem:\n\n\t*AIRichResponseContentItemsMetadata_AIRichResponseContentItemMetadata_ReelItem"
type: object
waAICommonDeprecated.AIRichResponseContentItemsMetadata_ContentType:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- AIRichResponseContentItemsMetadata_DEFAULT
- AIRichResponseContentItemsMetadata_CAROUSEL
waAICommonDeprecated.AIRichResponseDynamicMetadata:
properties:
URL:
type: string
loopCount:
type: integer
type:
$ref: '#/definitions/waAICommonDeprecated.AIRichResponseDynamicMetadata_AIRichResponseDynamicMetadataType'
version:
type: integer
type: object
waAICommonDeprecated.AIRichResponseDynamicMetadata_AIRichResponseDynamicMetadataType:
enum:
- 0
- 1
- 2
format: int32
type: integer
x-enum-varnames:
- AIRichResponseDynamicMetadata_AI_RICH_RESPONSE_DYNAMIC_METADATA_TYPE_UNKNOWN
- AIRichResponseDynamicMetadata_AI_RICH_RESPONSE_DYNAMIC_METADATA_TYPE_IMAGE
- AIRichResponseDynamicMetadata_AI_RICH_RESPONSE_DYNAMIC_METADATA_TYPE_GIF
waAICommonDeprecated.AIRichResponseGridImageMetadata:
properties:
gridImageURL:
$ref: '#/definitions/waAICommonDeprecated.AIRichResponseImageURL'
imageURLs:
items:
$ref: '#/definitions/waAICommonDeprecated.AIRichResponseImageURL'
type: array
type: object
waAICommonDeprecated.AIRichResponseImageURL:
properties:
imageHighResURL:
type: string
imagePreviewURL:
type: string
sourceURL:
type: string
type: object
waAICommonDeprecated.AIRichResponseInlineImageMetadata:
properties:
alignment:
$ref: '#/definitions/waAICommonDeprecated.AIRichResponseInlineImageMetadata_AIRichResponseImageAlignment'
imageText:
type: string
imageURL:
$ref: '#/definitions/waAICommonDeprecated.AIRichResponseImageURL'
tapLinkURL:
type: string
type: object
waAICommonDeprecated.AIRichResponseInlineImageMetadata_AIRichResponseImageAlignment:
enum:
- 0
- 1
- 2
format: int32
type: integer
x-enum-varnames:
- AIRichResponseInlineImageMetadata_AI_RICH_RESPONSE_IMAGE_LAYOUT_LEADING_ALIGNED
- AIRichResponseInlineImageMetadata_AI_RICH_RESPONSE_IMAGE_LAYOUT_TRAILING_ALIGNED
- AIRichResponseInlineImageMetadata_AI_RICH_RESPONSE_IMAGE_LAYOUT_CENTER_ALIGNED
waAICommonDeprecated.AIRichResponseLatexMetadata:
properties:
expressions:
items:
$ref: '#/definitions/waAICommonDeprecated.AIRichResponseLatexMetadata_AIRichResponseLatexExpression'
type: array
text:
type: string
type: object
waAICommonDeprecated.AIRichResponseLatexMetadata_AIRichResponseLatexExpression:
properties:
URL:
type: string
fontHeight:
type: number
height:
type: number
imageBottomPadding:
type: number
imageLeadingPadding:
type: number
imageTopPadding:
type: number
imageTrailingPadding:
type: number
latexExpression:
type: string
width:
type: number
type: object
waAICommonDeprecated.AIRichResponseMapMetadata:
properties:
annotations:
items:
$ref: '#/definitions/waAICommonDeprecated.AIRichResponseMapMetadata_AIRichResponseMapAnnotation'
type: array
centerLatitude:
type: number
centerLongitude:
type: number
latitudeDelta:
type: number
longitudeDelta:
type: number
showInfoList:
type: boolean
type: object
waAICommonDeprecated.AIRichResponseMapMetadata_AIRichResponseMapAnnotation:
properties:
annotationNumber:
type: integer
body:
type: string
latitude:
type: number
longitude:
type: number
title:
type: string
type: object
waAICommonDeprecated.AIRichResponseMessageType:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- AIRichResponseMessageType_AI_RICH_RESPONSE_TYPE_UNKNOWN
- AIRichResponseMessageType_AI_RICH_RESPONSE_TYPE_STANDARD
waAICommonDeprecated.AIRichResponseSubMessage:
properties:
codeMetadata:
$ref: '#/definitions/waAICommonDeprecated.AIRichResponseCodeMetadata'
contentItemsMetadata:
$ref: '#/definitions/waAICommonDeprecated.AIRichResponseContentItemsMetadata'
dynamicMetadata:
$ref: '#/definitions/waAICommonDeprecated.AIRichResponseDynamicMetadata'
gridImageMetadata:
$ref: '#/definitions/waAICommonDeprecated.AIRichResponseGridImageMetadata'
imageMetadata:
$ref: '#/definitions/waAICommonDeprecated.AIRichResponseInlineImageMetadata'
latexMetadata:
$ref: '#/definitions/waAICommonDeprecated.AIRichResponseLatexMetadata'
mapMetadata:
$ref: '#/definitions/waAICommonDeprecated.AIRichResponseMapMetadata'
messageText:
type: string
messageType:
$ref: '#/definitions/waAICommonDeprecated.AIRichResponseSubMessageType'
tableMetadata:
$ref: '#/definitions/waAICommonDeprecated.AIRichResponseTableMetadata'
type: object
waAICommonDeprecated.AIRichResponseSubMessageType:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
format: int32
type: integer
x-enum-varnames:
- AIRichResponseSubMessageType_AI_RICH_RESPONSE_UNKNOWN
- AIRichResponseSubMessageType_AI_RICH_RESPONSE_GRID_IMAGE
- AIRichResponseSubMessageType_AI_RICH_RESPONSE_TEXT
- AIRichResponseSubMessageType_AI_RICH_RESPONSE_INLINE_IMAGE
- AIRichResponseSubMessageType_AI_RICH_RESPONSE_TABLE
- AIRichResponseSubMessageType_AI_RICH_RESPONSE_CODE
- AIRichResponseSubMessageType_AI_RICH_RESPONSE_DYNAMIC
- AIRichResponseSubMessageType_AI_RICH_RESPONSE_MAP
- AIRichResponseSubMessageType_AI_RICH_RESPONSE_LATEX
- AIRichResponseSubMessageType_AI_RICH_RESPONSE_CONTENT_ITEMS
waAICommonDeprecated.AIRichResponseTableMetadata:
properties:
rows:
items:
$ref: '#/definitions/waAICommonDeprecated.AIRichResponseTableMetadata_AIRichResponseTableRow'
type: array
title:
type: string
type: object
waAICommonDeprecated.AIRichResponseTableMetadata_AIRichResponseTableRow:
properties:
isHeading:
type: boolean
items:
items:
type: string
type: array
type: object
waAdv.ADVEncryptionType:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- ADVEncryptionType_E2EE
- ADVEncryptionType_HOSTED
waCommon.LimitSharing:
properties:
initiatedByMe:
type: boolean
limitSharingSettingTimestamp:
type: integer
sharingLimited:
type: boolean
trigger:
$ref: '#/definitions/waCommon.LimitSharing_Trigger'
type: object
waCommon.LimitSharing_Trigger:
enum:
- 0
- 1
- 2
- 3
format: int32
type: integer
x-enum-varnames:
- LimitSharing_UNKNOWN
- LimitSharing_CHAT_SETTING
- LimitSharing_BIZ_SUPPORTS_FB_HOSTING
- LimitSharing_UNKNOWN_GROUP
waCommon.MessageKey:
properties:
ID:
type: string
fromMe:
type: boolean
participant:
type: string
remoteJID:
type: string
type: object
waCompanionReg.DeviceProps_HistorySyncConfig:
properties:
completeOnDemandReady:
type: boolean
fullSyncDaysLimit:
type: integer
fullSyncSizeMbLimit:
type: integer
initialSyncMaxMessagesPerChat:
type: integer
inlineInitialPayloadInE2EeMsg:
type: boolean
onDemandReady:
type: boolean
recentSyncDaysLimit:
type: integer
storageQuotaMb:
type: integer
supportAddOnHistorySyncMigration:
type: boolean
supportBizHostedMsg:
type: boolean
supportBotUserAgentChatHistory:
type: boolean
supportCagReactionsAndPolls:
type: boolean
supportCallLogHistory:
type: boolean
supportFbidBotChatHistory:
type: boolean
supportGroupHistory:
type: boolean
supportGuestChat:
type: boolean
supportHatchHistory:
type: boolean
supportHostedGroupMsg:
type: boolean
supportInlineContacts:
type: boolean
supportManusHistory:
type: boolean
supportMessageAssociation:
type: boolean
supportRecentSyncChunkMessageCountTuning:
type: boolean
supportedBotChannelFbids:
items:
type: string
type: array
thumbnailSyncDaysLimit:
type: integer
type: object
waE2E.AIQueryFanout:
properties:
message:
$ref: '#/definitions/waE2E.Message'
messageKey:
$ref: '#/definitions/waCommon.MessageKey'
timestamp:
type: integer
type: object
waE2E.AIRichResponseMessage:
properties:
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
messageType:
$ref: '#/definitions/waAICommonDeprecated.AIRichResponseMessageType'
submessages:
items:
$ref: '#/definitions/waAICommonDeprecated.AIRichResponseSubMessage'
type: array
unifiedResponse:
$ref: '#/definitions/waAICommon.AIRichResponseUnifiedResponse'
type: object
waE2E.ActionLink:
properties:
URL:
type: string
buttonTitle:
type: string
type: object
waE2E.AlbumMessage:
properties:
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
expectedImageCount:
type: integer
expectedVideoCount:
type: integer
type: object
waE2E.AppStateFatalExceptionNotification:
properties:
collectionNames:
items:
type: string
type: array
timestamp:
type: integer
type: object
waE2E.AppStateSyncKey:
properties:
keyData:
$ref: '#/definitions/waE2E.AppStateSyncKeyData'
keyID:
$ref: '#/definitions/waE2E.AppStateSyncKeyId'
type: object
waE2E.AppStateSyncKeyData:
properties:
fingerprint:
$ref: '#/definitions/waE2E.AppStateSyncKeyFingerprint'
keyData:
items:
type: integer
type: array
timestamp:
type: integer
type: object
waE2E.AppStateSyncKeyFingerprint:
properties:
currentIndex:
type: integer
deviceIndexes:
items:
type: integer
type: array
rawID:
type: integer
type: object
waE2E.AppStateSyncKeyId:
properties:
keyID:
items:
type: integer
type: array
type: object
waE2E.AppStateSyncKeyRequest:
properties:
keyIDs:
items:
$ref: '#/definitions/waE2E.AppStateSyncKeyId'
type: array
type: object
waE2E.AppStateSyncKeyShare:
properties:
keys:
items:
$ref: '#/definitions/waE2E.AppStateSyncKey'
type: array
type: object
waE2E.AudioMessage:
properties:
PTT:
type: boolean
URL:
type: string
accessibilityLabel:
type: string
backgroundArgb:
type: integer
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
directPath:
type: string
fileEncSHA256:
items:
type: integer
type: array
fileLength:
type: integer
fileSHA256:
items:
type: integer
type: array
mediaKey:
items:
type: integer
type: array
mediaKeyTimestamp:
type: integer
mimetype:
type: string
seconds:
type: integer
streamingSidecar:
items:
type: integer
type: array
viewOnce:
type: boolean
waveform:
items:
type: integer
type: array
type: object
waE2E.BCallMessage:
properties:
caption:
type: string
masterKey:
items:
type: integer
type: array
mediaType:
$ref: '#/definitions/waE2E.BCallMessage_MediaType'
sessionID:
type: string
type: object
waE2E.BCallMessage_MediaType:
enum:
- 0
- 1
- 2
format: int32
type: integer
x-enum-varnames:
- BCallMessage_UNKNOWN
- BCallMessage_AUDIO
- BCallMessage_VIDEO
waE2E.ButtonsMessage:
properties:
buttons:
items:
$ref: '#/definitions/waE2E.ButtonsMessage_Button'
type: array
contentText:
type: string
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
footerText:
type: string
header:
description: "Types that are valid to be assigned to Header:\n\n\t*ButtonsMessage_Text\n\t*ButtonsMessage_DocumentMessage\n\t*ButtonsMessage_ImageMessage\n\t*ButtonsMessage_VideoMessage\n\t*ButtonsMessage_LocationMessage"
headerType:
$ref: '#/definitions/waE2E.ButtonsMessage_HeaderType'
type: object
waE2E.ButtonsMessage_Button:
properties:
buttonID:
type: string
buttonText:
$ref: '#/definitions/waE2E.ButtonsMessage_Button_ButtonText'
nativeFlowInfo:
$ref: '#/definitions/waE2E.ButtonsMessage_Button_NativeFlowInfo'
type:
$ref: '#/definitions/waE2E.ButtonsMessage_Button_Type'
type: object
waE2E.ButtonsMessage_Button_ButtonText:
properties:
displayText:
type: string
type: object
waE2E.ButtonsMessage_Button_NativeFlowInfo:
properties:
name:
type: string
paramsJSON:
type: string
type: object
waE2E.ButtonsMessage_Button_Type:
enum:
- 0
- 1
- 2
format: int32
type: integer
x-enum-varnames:
- ButtonsMessage_Button_UNKNOWN
- ButtonsMessage_Button_RESPONSE
- ButtonsMessage_Button_NATIVE_FLOW
waE2E.ButtonsMessage_HeaderType:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
format: int32
type: integer
x-enum-varnames:
- ButtonsMessage_UNKNOWN
- ButtonsMessage_EMPTY
- ButtonsMessage_TEXT
- ButtonsMessage_DOCUMENT
- ButtonsMessage_IMAGE
- ButtonsMessage_VIDEO
- ButtonsMessage_LOCATION
waE2E.ButtonsResponseMessage:
properties:
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
response:
description: "Types that are valid to be assigned to Response:\n\n\t*ButtonsResponseMessage_SelectedDisplayText"
selectedButtonID:
type: string
type:
$ref: '#/definitions/waE2E.ButtonsResponseMessage_Type'
type: object
waE2E.ButtonsResponseMessage_Type:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- ButtonsResponseMessage_UNKNOWN
- ButtonsResponseMessage_DISPLAY_TEXT
waE2E.Call:
properties:
callEntryPoint:
type: integer
callKey:
items:
type: integer
type: array
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
conversionData:
items:
type: integer
type: array
conversionDelaySeconds:
type: integer
conversionSource:
type: string
ctwaPayload:
items:
type: integer
type: array
ctwaSignals:
type: string
deeplinkPayload:
type: string
messageContextInfo:
$ref: '#/definitions/waE2E.MessageContextInfo'
nativeFlowCallButtonPayload:
type: string
type: object
waE2E.CallLogMessage:
properties:
callOutcome:
$ref: '#/definitions/waE2E.CallLogMessage_CallOutcome'
callType:
$ref: '#/definitions/waE2E.CallLogMessage_CallType'
durationSecs:
type: integer
isVideo:
type: boolean
participants:
items:
$ref: '#/definitions/waE2E.CallLogMessage_CallParticipant'
type: array
type: object
waE2E.CallLogMessage_CallOutcome:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
format: int32
type: integer
x-enum-varnames:
- CallLogMessage_CONNECTED
- CallLogMessage_MISSED
- CallLogMessage_FAILED
- CallLogMessage_REJECTED
- CallLogMessage_ACCEPTED_ELSEWHERE
- CallLogMessage_ONGOING
- CallLogMessage_SILENCED_BY_DND
- CallLogMessage_SILENCED_UNKNOWN_CALLER
waE2E.CallLogMessage_CallParticipant:
properties:
JID:
type: string
callOutcome:
$ref: '#/definitions/waE2E.CallLogMessage_CallOutcome'
type: object
waE2E.CallLogMessage_CallType:
enum:
- 0
- 1
- 2
format: int32
type: integer
x-enum-varnames:
- CallLogMessage_REGULAR
- CallLogMessage_SCHEDULED_CALL
- CallLogMessage_VOICE_CHAT
waE2E.CancelPaymentRequestMessage:
properties:
key:
$ref: '#/definitions/waCommon.MessageKey'
type: object
waE2E.Chat:
properties:
ID:
type: string
displayName:
type: string
type: object
waE2E.ChatThemeSetting:
properties:
clearTheme:
type: boolean
colorSchemeID:
type: string
settingTimestampMS:
type: integer
wallpaper:
description: "Types that are valid to be assigned to Wallpaper:\n\n\t*ChatThemeSetting_DefaultWallpaper\n\t*ChatThemeSetting_SolidColor\n\t*ChatThemeSetting_StockImage\n\t*ChatThemeSetting_CustomImage"
type: object
waE2E.CloudAPIThreadControlNotification:
properties:
consumerLid:
type: string
consumerPhoneNumber:
type: string
notificationContent:
$ref: '#/definitions/waE2E.CloudAPIThreadControlNotification_CloudAPIThreadControlNotificationContent'
senderNotificationTimestampMS:
type: integer
shouldSuppressNotification:
type: boolean
status:
$ref: '#/definitions/waE2E.CloudAPIThreadControlNotification_CloudAPIThreadControl'
type: object
waE2E.CloudAPIThreadControlNotification_CloudAPIThreadControl:
enum:
- 0
- 1
- 2
- 3
format: int32
type: integer
x-enum-varnames:
- CloudAPIThreadControlNotification_UNKNOWN
- CloudAPIThreadControlNotification_CONTROL_PASSED
- CloudAPIThreadControlNotification_CONTROL_TAKEN
- CloudAPIThreadControlNotification_INFO
waE2E.CloudAPIThreadControlNotification_CloudAPIThreadControlNotificationContent:
properties:
extraJSON:
type: string
handoffNotificationText:
type: string
type: object
waE2E.CommentMessage:
properties:
message:
$ref: '#/definitions/waE2E.Message'
targetMessageKey:
$ref: '#/definitions/waCommon.MessageKey'
type: object
waE2E.ConditionalRevealMessage:
properties:
conditionalRevealMessageType:
$ref: '#/definitions/waE2E.ConditionalRevealMessage_ConditionalRevealMessageType'
encIV:
items:
type: integer
type: array
encPayload:
items:
type: integer
type: array
revealKeyID:
type: string
type: object
waE2E.ConditionalRevealMessage_ConditionalRevealMessageType:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- ConditionalRevealMessage_UNKNOWN
- ConditionalRevealMessage_SCHEDULED_MESSAGE
waE2E.ContactMessage:
properties:
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
displayName:
type: string
isSelfContact:
type: boolean
vcard:
type: string
type: object
waE2E.ContactsArrayMessage:
properties:
contacts:
items:
$ref: '#/definitions/waE2E.ContactMessage'
type: array
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
displayName:
type: string
type: object
waE2E.ContextInfo:
properties:
actionLink:
$ref: '#/definitions/waE2E.ActionLink'
afterReadDuration:
type: integer
alwaysShowAdAttribution:
type: boolean
botMessageSharingInfo:
$ref: '#/definitions/waAICommon.BotMessageSharingInfo'
businessInteractionPills:
$ref: '#/definitions/waE2E.ContextInfo_BusinessInteractionPills'
businessMessageForwardInfo:
$ref: '#/definitions/waE2E.ContextInfo_BusinessMessageForwardInfo'
conversionData:
items:
type: integer
type: array
conversionDelaySeconds:
type: integer
conversionSource:
type: string
crossAppSource:
$ref: '#/definitions/waE2E.ContextInfo_CrossAppSource'
ctwaPayload:
items:
type: integer
type: array
ctwaSignals:
type: string
dataSharingContext:
$ref: '#/definitions/waE2E.ContextInfo_DataSharingContext'
disappearingMode:
$ref: '#/definitions/waE2E.DisappearingMode'
entryPointConversionApp:
type: string
entryPointConversionDelaySeconds:
type: integer
entryPointConversionExternalMedium:
type: string
entryPointConversionExternalSource:
type: string
entryPointConversionSource:
type: string
ephemeralSettingTimestamp:
type: integer
ephemeralSharedSecret:
items:
type: integer
type: array
expiration:
type: integer
externalAdReply:
$ref: '#/definitions/waE2E.ContextInfo_ExternalAdReplyInfo'
featureEligibilities:
$ref: '#/definitions/waE2E.ContextInfo_FeatureEligibilities'
forwardOrigin:
$ref: '#/definitions/waE2E.ContextInfo_ForwardOrigin'
forwardedAiBotMessageInfo:
$ref: '#/definitions/waAICommon.ForwardedAIBotMessageInfo'
forwardedNewsletterMessageInfo:
$ref: '#/definitions/waE2E.ContextInfo_ForwardedNewsletterMessageInfo'
forwardingScore:
type: integer
groupMentions:
items:
$ref: '#/definitions/waE2E.GroupMention'
type: array
groupSubject:
type: string
isForwarded:
type: boolean
isGroupStatus:
type: boolean
isQuestion:
type: boolean
isSampled:
type: boolean
isSpoiler:
type: boolean
mediaDomainInfo:
$ref: '#/definitions/waE2E.MediaDomainInfo'
memberLabel:
$ref: '#/definitions/waE2E.MemberLabel'
mentionedJID:
items:
type: string
type: array
nonJIDMentions:
type: integer
pairedMediaType:
$ref: '#/definitions/waE2E.ContextInfo_PairedMediaType'
parentGroupJID:
type: string
partiallySelectedContent:
$ref: '#/definitions/waE2E.ContextInfo_PartiallySelectedContent'
participant:
type: string
placeholderKey:
$ref: '#/definitions/waCommon.MessageKey'
posterStatusID:
type: string
questionReplyQuotedMessage:
$ref: '#/definitions/waE2E.ContextInfo_QuestionReplyQuotedMessage'
quotedAd:
$ref: '#/definitions/waE2E.ContextInfo_AdReplyInfo'
quotedMessage:
$ref: '#/definitions/waE2E.Message'
quotedType:
$ref: '#/definitions/waE2E.ContextInfo_QuotedType'
rankingVersion:
type: integer
remoteJID:
type: string
smbClientCampaignID:
type: string
smbServerCampaignID:
type: string
stanzaID:
type: string
statusAttributionType:
$ref: '#/definitions/waE2E.ContextInfo_StatusAttributionType'
statusAttributions:
items:
$ref: '#/definitions/waStatusAttributions.StatusAttribution'
type: array
statusAudienceMetadata:
$ref: '#/definitions/waE2E.ContextInfo_StatusAudienceMetadata'
statusSourceType:
$ref: '#/definitions/waE2E.ContextInfo_StatusSourceType'
trustBannerAction:
type: integer
trustBannerType:
type: string
urlTrackingMap:
$ref: '#/definitions/waE2E.UrlTrackingMap'
utm:
$ref: '#/definitions/waE2E.ContextInfo_UTMInfo'
type: object
waE2E.ContextInfo_AdReplyInfo:
properties:
JPEGThumbnail:
items:
type: integer
type: array
advertiserName:
type: string
caption:
type: string
mediaType:
$ref: '#/definitions/waE2E.ContextInfo_AdReplyInfo_MediaType'
type: object
waE2E.ContextInfo_AdReplyInfo_MediaType:
enum:
- 0
- 1
- 2
format: int32
type: integer
x-enum-varnames:
- ContextInfo_AdReplyInfo_NONE
- ContextInfo_AdReplyInfo_IMAGE
- ContextInfo_AdReplyInfo_VIDEO
waE2E.ContextInfo_BusinessInteractionPills:
properties:
businessJID:
type: string
entryPoint:
$ref: '#/definitions/waE2E.ContextInfo_BusinessInteractionPills_EntryPoint'
pills:
items:
$ref: '#/definitions/waE2E.ContextInfo_BusinessInteractionPills_Pill'
type: array
signatureEnvelope:
$ref: '#/definitions/waAICommon.BotSignatureVerificationMetadata'
signedPayload:
items:
type: integer
type: array
type: object
waE2E.ContextInfo_BusinessInteractionPills_EntryPoint:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
format: int32
type: integer
x-enum-varnames:
- ContextInfo_BusinessInteractionPills_ENTRY_POINT_UNKNOWN
- ContextInfo_BusinessInteractionPills_P2P_LINK_SHARE
- ContextInfo_BusinessInteractionPills_CONTACT_CARD_SHARING
- ContextInfo_BusinessInteractionPills_PHONE_NUMBER
- ContextInfo_BusinessInteractionPills_STATUS
- ContextInfo_BusinessInteractionPills_IN_THREAD_CONTEXT_CARD
waE2E.ContextInfo_BusinessInteractionPills_Pill:
properties:
actionURL:
type: string
pillType:
$ref: '#/definitions/waE2E.ContextInfo_BusinessInteractionPills_PillType'
type: object
waE2E.ContextInfo_BusinessInteractionPills_PillType:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
format: int32
type: integer
x-enum-varnames:
- ContextInfo_BusinessInteractionPills_UNKNOWN
- ContextInfo_BusinessInteractionPills_VIEW_BUSINESS
- ContextInfo_BusinessInteractionPills_CHAT
- ContextInfo_BusinessInteractionPills_CALL
- ContextInfo_BusinessInteractionPills_CATALOG
- ContextInfo_BusinessInteractionPills_CHANNEL
- ContextInfo_BusinessInteractionPills_BOOK_APPOINTMENT
- ContextInfo_BusinessInteractionPills_OFFERS
- ContextInfo_BusinessInteractionPills_BESTSELLERS
- ContextInfo_BusinessInteractionPills_MENU
- ContextInfo_BusinessInteractionPills_ABOUT
- ContextInfo_BusinessInteractionPills_SHOP
- ContextInfo_BusinessInteractionPills_ORDER
waE2E.ContextInfo_BusinessMessageForwardInfo:
properties:
businessOwnerJID:
type: string
type: object
waE2E.ContextInfo_CrossAppSource:
enum:
- 0
- 1
- 2
format: int32
type: integer
x-enum-varnames:
- ContextInfo_CROSS_APP_SOURCE_UNKNOWN
- ContextInfo_CROSS_APP_SOURCE_INSTAGRAM
- ContextInfo_CROSS_APP_SOURCE_FACEBOOK
waE2E.ContextInfo_DataSharingContext:
properties:
dataSharingFlags:
type: integer
encryptedSignalTokenConsented:
type: string
parameters:
items:
$ref: '#/definitions/waE2E.ContextInfo_DataSharingContext_Parameters'
type: array
showMmDisclosure:
type: boolean
type: object
waE2E.ContextInfo_DataSharingContext_Parameters:
properties:
contents:
$ref: '#/definitions/waE2E.ContextInfo_DataSharingContext_Parameters'
floatData:
type: number
intData:
type: integer
key:
type: string
stringData:
type: string
type: object
waE2E.ContextInfo_ExternalAdReplyInfo:
properties:
adContextPreviewDismissed:
type: boolean
adPreviewURL:
type: string
adType:
$ref: '#/definitions/waE2E.ContextInfo_ExternalAdReplyInfo_AdType'
agmHeaderInteractionStrategy:
type: integer
agmSubtitleStrategy:
type: integer
agmThumbnailStrategy:
type: integer
agmTitleStrategy:
type: integer
automatedGreetingMessageCtaType:
type: string
automatedGreetingMessageShown:
type: boolean
body:
type: string
clickToWhatsappCall:
type: boolean
containsAutoReply:
type: boolean
containsCtwaFlowsAutoReply:
type: boolean
ctaPayload:
type: string
ctwaClid:
type: string
disableNudge:
type: boolean
greetingMessageBody:
type: string
mediaType:
$ref: '#/definitions/waE2E.ContextInfo_ExternalAdReplyInfo_MediaType'
mediaURL:
type: string
originalImageURL:
type: string
ref:
type: string
renderLargerThumbnail:
type: boolean
showAdAttribution:
type: boolean
sourceApp:
type: string
sourceID:
type: string
sourceType:
type: string
sourceURL:
type: string
thumbnail:
items:
type: integer
type: array
thumbnailURL:
type: string
title:
type: string
wtwaAdFormat:
type: boolean
wtwaWebsiteURL:
type: string
type: object
waE2E.ContextInfo_ExternalAdReplyInfo_AdType:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- ContextInfo_ExternalAdReplyInfo_CTWA
- ContextInfo_ExternalAdReplyInfo_CAWC
waE2E.ContextInfo_ExternalAdReplyInfo_MediaType:
enum:
- 0
- 1
- 2
format: int32
type: integer
x-enum-varnames:
- ContextInfo_ExternalAdReplyInfo_NONE
- ContextInfo_ExternalAdReplyInfo_IMAGE
- ContextInfo_ExternalAdReplyInfo_VIDEO
waE2E.ContextInfo_FeatureEligibilities:
properties:
canBeReshared:
type: boolean
canReceiveMultiReact:
type: boolean
canRequestFeedback:
type: boolean
cannotBeRanked:
type: boolean
cannotBeReactedTo:
type: boolean
type: object
waE2E.ContextInfo_ForwardOrigin:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
format: int32
type: integer
x-enum-varnames:
- ContextInfo_UNKNOWN
- ContextInfo_CHAT
- ContextInfo_STATUS
- ContextInfo_CHANNELS
- ContextInfo_META_AI
- ContextInfo_UGC
waE2E.ContextInfo_ForwardedNewsletterMessageInfo:
properties:
accessibilityText:
type: string
contentType:
$ref: '#/definitions/waE2E.ContextInfo_ForwardedNewsletterMessageInfo_ContentType'
newsletterJID:
type: string
newsletterName:
type: string
profileName:
type: string
serverMessageID:
type: integer
type: object
waE2E.ContextInfo_ForwardedNewsletterMessageInfo_ContentType:
enum:
- 1
- 2
- 3
format: int32
type: integer
x-enum-varnames:
- ContextInfo_ForwardedNewsletterMessageInfo_UPDATE
- ContextInfo_ForwardedNewsletterMessageInfo_UPDATE_CARD
- ContextInfo_ForwardedNewsletterMessageInfo_LINK_CARD
waE2E.ContextInfo_PairedMediaType:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
format: int32
type: integer
x-enum-varnames:
- ContextInfo_NOT_PAIRED_MEDIA
- ContextInfo_SD_VIDEO_PARENT
- ContextInfo_HD_VIDEO_CHILD
- ContextInfo_SD_IMAGE_PARENT
- ContextInfo_HD_IMAGE_CHILD
- ContextInfo_MOTION_PHOTO_PARENT
- ContextInfo_MOTION_PHOTO_CHILD
- ContextInfo_HEVC_VIDEO_PARENT
- ContextInfo_HEVC_VIDEO_CHILD
waE2E.ContextInfo_PartiallySelectedContent:
properties:
text:
type: string
type: object
waE2E.ContextInfo_QuestionReplyQuotedMessage:
properties:
quotedQuestion:
$ref: '#/definitions/waE2E.Message'
quotedResponse:
$ref: '#/definitions/waE2E.Message'
serverQuestionID:
type: integer
type: object
waE2E.ContextInfo_QuotedType:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- ContextInfo_EXPLICIT
- ContextInfo_AUTO
waE2E.ContextInfo_StatusAttributionType:
enum:
- 0
- 1
- 2
- 3
- 4
format: int32
type: integer
x-enum-varnames:
- ContextInfo_NONE
- ContextInfo_RESHARED_FROM_MENTION
- ContextInfo_RESHARED_FROM_POST
- ContextInfo_RESHARED_FROM_POST_MANY_TIMES
- ContextInfo_FORWARDED_FROM_STATUS
waE2E.ContextInfo_StatusAudienceMetadata:
properties:
audienceType:
$ref: '#/definitions/waE2E.ContextInfo_StatusAudienceMetadata_AudienceType'
listEmoji:
type: string
listName:
type: string
type: object
waE2E.ContextInfo_StatusAudienceMetadata_AudienceType:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- ContextInfo_StatusAudienceMetadata_UNKNOWN
- ContextInfo_StatusAudienceMetadata_CLOSE_FRIENDS
waE2E.ContextInfo_StatusSourceType:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
format: int32
type: integer
x-enum-varnames:
- ContextInfo_IMAGE
- ContextInfo_VIDEO
- ContextInfo_GIF
- ContextInfo_AUDIO
- ContextInfo_TEXT
- ContextInfo_MUSIC_STANDALONE
waE2E.ContextInfo_UTMInfo:
properties:
utmCampaign:
type: string
utmSource:
type: string
type: object
waE2E.DeclinePaymentRequestMessage:
properties:
key:
$ref: '#/definitions/waCommon.MessageKey'
type: object
waE2E.DeviceListMetadata:
properties:
receiverAccountType:
$ref: '#/definitions/waAdv.ADVEncryptionType'
recipientKeyHash:
items:
type: integer
type: array
recipientKeyIndexes:
items:
type: integer
type: array
recipientTimestamp:
type: integer
senderAccountType:
$ref: '#/definitions/waAdv.ADVEncryptionType'
senderKeyHash:
items:
type: integer
type: array
senderKeyIndexes:
items:
type: integer
type: array
senderTimestamp:
type: integer
type: object
waE2E.DeviceSentMessage:
properties:
destinationJID:
type: string
message:
$ref: '#/definitions/waE2E.Message'
phash:
type: string
type: object
waE2E.DisappearingMode:
properties:
initiatedByMe:
type: boolean
initiator:
$ref: '#/definitions/waE2E.DisappearingMode_Initiator'
initiatorDeviceJID:
type: string
trigger:
$ref: '#/definitions/waE2E.DisappearingMode_Trigger'
type: object
waE2E.DisappearingMode_Initiator:
enum:
- 0
- 1
- 2
- 3
format: int32
type: integer
x-enum-varnames:
- DisappearingMode_CHANGED_IN_CHAT
- DisappearingMode_INITIATED_BY_ME
- DisappearingMode_INITIATED_BY_OTHER
- DisappearingMode_BIZ_UPGRADE_FB_HOSTING
waE2E.DisappearingMode_Trigger:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
format: int32
type: integer
x-enum-varnames:
- DisappearingMode_UNKNOWN
- DisappearingMode_CHAT_SETTING
- DisappearingMode_ACCOUNT_SETTING
- DisappearingMode_BULK_CHANGE
- DisappearingMode_BIZ_SUPPORTS_FB_HOSTING
- DisappearingMode_UNKNOWN_GROUPS
waE2E.DocumentMessage:
properties:
JPEGThumbnail:
items:
type: integer
type: array
URL:
type: string
accessibilityLabel:
type: string
caption:
type: string
contactVcard:
type: boolean
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
directPath:
type: string
fileEncSHA256:
items:
type: integer
type: array
fileLength:
type: integer
fileName:
type: string
fileSHA256:
items:
type: integer
type: array
mediaKey:
items:
type: integer
type: array
mediaKeyTimestamp:
type: integer
mimetype:
type: string
pageCount:
type: integer
thumbnailDirectPath:
type: string
thumbnailEncSHA256:
items:
type: integer
type: array
thumbnailHeight:
type: integer
thumbnailSHA256:
items:
type: integer
type: array
thumbnailWidth:
type: integer
title:
type: string
type: object
waE2E.EmbeddedContent:
properties:
content:
description: "Types that are valid to be assigned to Content:\n\n\t*EmbeddedContent_EmbeddedMessage\n\t*EmbeddedContent_EmbeddedMusic"
type: object
waE2E.EmbeddedMusic:
properties:
artistAttribution:
type: string
artworkDirectPath:
type: string
artworkEncSHA256:
items:
type: integer
type: array
artworkMediaKey:
items:
type: integer
type: array
artworkSHA256:
items:
type: integer
type: array
author:
type: string
countryBlocklist:
items:
type: integer
type: array
derivedContentStartTimeInMS:
type: integer
isExplicit:
type: boolean
musicContentMediaID:
type: string
musicSongStartTimeInMS:
type: integer
overlapDurationInMS:
type: integer
songID:
type: string
title:
type: string
type: object
waE2E.EncCommentMessage:
properties:
encIV:
items:
type: integer
type: array
encPayload:
items:
type: integer
type: array
targetMessageKey:
$ref: '#/definitions/waCommon.MessageKey'
type: object
waE2E.EncEventResponseMessage:
properties:
encIV:
items:
type: integer
type: array
encPayload:
items:
type: integer
type: array
eventCreationMessageKey:
$ref: '#/definitions/waCommon.MessageKey'
type: object
waE2E.EncReactionMessage:
properties:
encIV:
items:
type: integer
type: array
encPayload:
items:
type: integer
type: array
targetMessageKey:
$ref: '#/definitions/waCommon.MessageKey'
type: object
waE2E.EventInviteMessage:
properties:
JPEGThumbnail:
items:
type: integer
type: array
callLink:
type: string
caption:
type: string
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
endTime:
type: integer
eventID:
type: string
eventTitle:
type: string
isCanceled:
type: boolean
startTime:
type: integer
type: object
waE2E.EventMessage:
properties:
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
description:
type: string
endTime:
type: integer
extraGuestsAllowed:
type: boolean
hasReminder:
type: boolean
isCanceled:
type: boolean
isScheduleCall:
type: boolean
joinLink:
type: string
location:
$ref: '#/definitions/waE2E.LocationMessage'
name:
type: string
reminderOffsetSec:
type: integer
startTime:
type: integer
type: object
waE2E.ExtendedTextMessage:
properties:
JPEGThumbnail:
items:
type: integer
type: array
backgroundArgb:
type: integer
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
description:
type: string
doNotPlayInline:
type: boolean
endCardTiles:
items:
$ref: '#/definitions/waE2E.VideoEndCard'
type: array
faviconMMSMetadata:
$ref: '#/definitions/waE2E.MMSThumbnailMetadata'
font:
$ref: '#/definitions/waE2E.ExtendedTextMessage_FontType'
inviteLinkGroupType:
$ref: '#/definitions/waE2E.ExtendedTextMessage_InviteLinkGroupType'
inviteLinkGroupTypeV2:
$ref: '#/definitions/waE2E.ExtendedTextMessage_InviteLinkGroupType'
inviteLinkParentGroupSubjectV2:
type: string
inviteLinkParentGroupThumbnailV2:
items:
type: integer
type: array
linkPreviewMetadata:
$ref: '#/definitions/waE2E.LinkPreviewMetadata'
matchedText:
type: string
mediaKey:
items:
type: integer
type: array
mediaKeyTimestamp:
type: integer
musicMetadata:
$ref: '#/definitions/waE2E.EmbeddedMusic'
paymentExtendedMetadata:
$ref: '#/definitions/waE2E.PaymentExtendedMetadata'
paymentLinkMetadata:
$ref: '#/definitions/waE2E.PaymentLinkMetadata'
previewType:
$ref: '#/definitions/waE2E.ExtendedTextMessage_PreviewType'
text:
type: string
textArgb:
type: integer
thumbnailDirectPath:
type: string
thumbnailEncSHA256:
items:
type: integer
type: array
thumbnailHeight:
type: integer
thumbnailSHA256:
items:
type: integer
type: array
thumbnailWidth:
type: integer
title:
type: string
videoContentURL:
type: string
videoHeight:
type: integer
videoWidth:
type: integer
viewOnce:
type: boolean
type: object
waE2E.ExtendedTextMessage_FontType:
enum:
- 0
- 1
- 2
- 6
- 7
- 8
- 9
- 10
format: int32
type: integer
x-enum-varnames:
- ExtendedTextMessage_SYSTEM
- ExtendedTextMessage_SYSTEM_TEXT
- ExtendedTextMessage_FB_SCRIPT
- ExtendedTextMessage_SYSTEM_BOLD
- ExtendedTextMessage_MORNINGBREEZE_REGULAR
- ExtendedTextMessage_CALISTOGA_REGULAR
- ExtendedTextMessage_EXO2_EXTRABOLD
- ExtendedTextMessage_COURIERPRIME_BOLD
waE2E.ExtendedTextMessage_InviteLinkGroupType:
enum:
- 0
- 1
- 2
- 3
format: int32
type: integer
x-enum-varnames:
- ExtendedTextMessage_DEFAULT
- ExtendedTextMessage_PARENT
- ExtendedTextMessage_SUB
- ExtendedTextMessage_DEFAULT_SUB
waE2E.ExtendedTextMessage_PreviewType:
enum:
- 0
- 1
- 4
- 5
- 6
- 7
format: int32
type: integer
x-enum-varnames:
- ExtendedTextMessage_NONE
- ExtendedTextMessage_VIDEO
- ExtendedTextMessage_PLACEHOLDER
- ExtendedTextMessage_IMAGE
- ExtendedTextMessage_PAYMENT_LINKS
- ExtendedTextMessage_PROFILE
waE2E.FullHistorySyncOnDemandConfig:
properties:
historyDurationDays:
type: integer
historyFromTimestamp:
type: integer
type: object
waE2E.FullHistorySyncOnDemandRequestMetadata:
properties:
businessProduct:
type: string
opaqueClientData:
items:
type: integer
type: array
requestID:
type: string
type: object
waE2E.FutureProofMessage:
properties:
message:
$ref: '#/definitions/waE2E.Message'
type: object
waE2E.GroupInviteMessage:
properties:
JPEGThumbnail:
items:
type: integer
type: array
caption:
type: string
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
groupJID:
type: string
groupName:
type: string
groupType:
$ref: '#/definitions/waE2E.GroupInviteMessage_GroupType'
inviteCode:
type: string
inviteExpiration:
type: integer
type: object
waE2E.GroupInviteMessage_GroupType:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- GroupInviteMessage_DEFAULT
- GroupInviteMessage_PARENT
waE2E.GroupMention:
properties:
groupJID:
type: string
groupSubject:
type: string
type: object
waE2E.GroupRootKeyShare:
properties:
keys:
items:
$ref: '#/definitions/waE2E.GroupRootKeyShareEntry'
type: array
type: object
waE2E.GroupRootKeyShareEntry:
properties:
createdTimestampMS:
type: integer
expiryTimestampMS:
type: integer
groupRootKey:
items:
type: integer
type: array
keyID:
type: string
type: object
waE2E.HighlyStructuredMessage:
properties:
deterministicLc:
type: string
deterministicLg:
type: string
elementName:
type: string
fallbackLc:
type: string
fallbackLg:
type: string
hydratedHsm:
$ref: '#/definitions/waE2E.TemplateMessage'
localizableParams:
items:
$ref: '#/definitions/waE2E.HighlyStructuredMessage_HSMLocalizableParameter'
type: array
namespace:
type: string
params:
items:
type: string
type: array
type: object
waE2E.HighlyStructuredMessage_HSMLocalizableParameter:
properties:
default:
type: string
paramOneof:
description: "Types that are valid to be assigned to ParamOneof:\n\n\t*HighlyStructuredMessage_HSMLocalizableParameter_Currency\n\t*HighlyStructuredMessage_HSMLocalizableParameter_DateTime"
type: object
waE2E.HistorySyncMessageAccessStatus:
properties:
completeAccessGranted:
type: boolean
type: object
waE2E.HistorySyncNotification:
properties:
chunkOrder:
type: integer
directPath:
type: string
encHandle:
type: string
fileEncSHA256:
items:
type: integer
type: array
fileLength:
type: integer
fileSHA256:
items:
type: integer
type: array
fullHistorySyncOnDemandRequestMetadata:
$ref: '#/definitions/waE2E.FullHistorySyncOnDemandRequestMetadata'
initialHistBootstrapInlinePayload:
items:
type: integer
type: array
mediaKey:
items:
type: integer
type: array
messageAccessStatus:
$ref: '#/definitions/waE2E.HistorySyncMessageAccessStatus'
oldestMsgInChunkTimestampSec:
type: integer
originalMessageID:
type: string
peerDataRequestSessionID:
type: string
progress:
type: integer
syncType:
$ref: '#/definitions/waE2E.HistorySyncType'
type: object
waE2E.HistorySyncType:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
format: int32
type: integer
x-enum-varnames:
- HistorySyncType_INITIAL_BOOTSTRAP
- HistorySyncType_INITIAL_STATUS_V3
- HistorySyncType_FULL
- HistorySyncType_RECENT
- HistorySyncType_PUSH_NAME
- HistorySyncType_NON_BLOCKING_DATA
- HistorySyncType_ON_DEMAND
- HistorySyncType_NO_HISTORY
- HistorySyncType_MESSAGE_ACCESS_STATUS
waE2E.HydratedTemplateButton:
properties:
hydratedButton:
description: "Types that are valid to be assigned to HydratedButton:\n\n\t*HydratedTemplateButton_QuickReplyButton\n\t*HydratedTemplateButton_UrlButton\n\t*HydratedTemplateButton_CallButton"
index:
type: integer
type: object
waE2E.ImageMessage:
properties:
JPEGThumbnail:
items:
type: integer
type: array
URL:
type: string
accessibilityLabel:
type: string
annotations:
items:
$ref: '#/definitions/waE2E.InteractiveAnnotation'
type: array
caption:
type: string
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
directPath:
type: string
experimentGroupID:
type: integer
fileEncSHA256:
items:
type: integer
type: array
fileLength:
type: integer
fileSHA256:
items:
type: integer
type: array
firstScanLength:
type: integer
firstScanSidecar:
items:
type: integer
type: array
height:
type: integer
imageSourceType:
$ref: '#/definitions/waE2E.ImageMessage_ImageSourceType'
interactiveAnnotations:
items:
$ref: '#/definitions/waE2E.InteractiveAnnotation'
type: array
mediaKey:
items:
type: integer
type: array
mediaKeyTimestamp:
type: integer
midQualityFileEncSHA256:
items:
type: integer
type: array
midQualityFileSHA256:
items:
type: integer
type: array
mimetype:
type: string
qrURL:
type: string
scanLengths:
items:
type: integer
type: array
scansSidecar:
items:
type: integer
type: array
staticURL:
type: string
thumbnailDirectPath:
type: string
thumbnailEncSHA256:
items:
type: integer
type: array
thumbnailSHA256:
items:
type: integer
type: array
viewOnce:
type: boolean
width:
type: integer
type: object
waE2E.ImageMessage_ImageSourceType:
enum:
- 0
- 1
- 2
- 3
format: int32
type: integer
x-enum-varnames:
- ImageMessage_USER_IMAGE
- ImageMessage_AI_GENERATED
- ImageMessage_AI_MODIFIED
- ImageMessage_RASTERIZED_TEXT_STATUS
waE2E.InitialSecurityNotificationSettingSync:
properties:
securityNotificationEnabled:
type: boolean
type: object
waE2E.InsightDeliveryState:
enum:
- 0
- 1
- 2
- 3
- 4
format: int32
type: integer
x-enum-varnames:
- InsightDeliveryState_SENT
- InsightDeliveryState_DELIVERED
- InsightDeliveryState_READ
- InsightDeliveryState_REPLIED
- InsightDeliveryState_QUICK_REPLIED
waE2E.InteractiveAnnotation:
properties:
action:
description: "Types that are valid to be assigned to Action:\n\n\t*InteractiveAnnotation_Location\n\t*InteractiveAnnotation_Newsletter\n\t*InteractiveAnnotation_EmbeddedAction\n\t*InteractiveAnnotation_TapAction"
embeddedContent:
$ref: '#/definitions/waE2E.EmbeddedContent'
polygonVertices:
items:
$ref: '#/definitions/waE2E.Point'
type: array
shouldSkipConfirmation:
type: boolean
statusLinkType:
$ref: '#/definitions/waE2E.InteractiveAnnotation_StatusLinkType'
type: object
waE2E.InteractiveAnnotation_StatusLinkType:
enum:
- 1
- 2
- 3
format: int32
type: integer
x-enum-varnames:
- InteractiveAnnotation_RASTERIZED_LINK_PREVIEW
- InteractiveAnnotation_RASTERIZED_LINK_TRUNCATED
- InteractiveAnnotation_RASTERIZED_LINK_FULL_URL
waE2E.InteractiveMessage:
properties:
bloksWidget:
$ref: '#/definitions/waE2E.InteractiveMessage_BloksWidget'
body:
$ref: '#/definitions/waE2E.InteractiveMessage_Body'
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
footer:
$ref: '#/definitions/waE2E.InteractiveMessage_Footer'
header:
$ref: '#/definitions/waE2E.InteractiveMessage_Header'
interactiveMessage:
description: "Types that are valid to be assigned to InteractiveMessage:\n\n\t*InteractiveMessage_ShopStorefrontMessage\n\t*InteractiveMessage_CollectionMessage_\n\t*InteractiveMessage_NativeFlowMessage_\n\t*InteractiveMessage_CarouselMessage_"
urlTrackingMap:
$ref: '#/definitions/waE2E.UrlTrackingMap'
type: object
waE2E.InteractiveMessage_BloksWidget:
properties:
data:
type: string
fallback:
type: string
type:
type: string
uuid:
type: string
type: object
waE2E.InteractiveMessage_Body:
properties:
text:
type: string
type: object
waE2E.InteractiveMessage_Footer:
properties:
hasMediaAttachment:
type: boolean
media:
description: "Types that are valid to be assigned to Media:\n\n\t*InteractiveMessage_Footer_AudioMessage"
text:
type: string
type: object
waE2E.InteractiveMessage_Header:
properties:
bloksWidget:
$ref: '#/definitions/waE2E.InteractiveMessage_BloksWidget'
hasMediaAttachment:
type: boolean
media:
description: "Types that are valid to be assigned to Media:\n\n\t*InteractiveMessage_Header_DocumentMessage\n\t*InteractiveMessage_Header_ImageMessage\n\t*InteractiveMessage_Header_JPEGThumbnail\n\t*InteractiveMessage_Header_VideoMessage\n\t*InteractiveMessage_Header_LocationMessage\n\t*InteractiveMessage_Header_ProductMessage"
subtitle:
type: string
title:
type: string
type: object
waE2E.InteractiveResponseMessage:
properties:
body:
$ref: '#/definitions/waE2E.InteractiveResponseMessage_Body'
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
interactiveResponseMessage:
description: "Types that are valid to be assigned to InteractiveResponseMessage:\n\n\t*InteractiveResponseMessage_NativeFlowResponseMessage_"
type: object
waE2E.InteractiveResponseMessage_Body:
properties:
format:
$ref: '#/definitions/waE2E.InteractiveResponseMessage_Body_Format'
text:
type: string
type: object
waE2E.InteractiveResponseMessage_Body_Format:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- InteractiveResponseMessage_Body_DEFAULT
- InteractiveResponseMessage_Body_EXTENSIONS_1
waE2E.InvoiceMessage:
properties:
attachmentDirectPath:
type: string
attachmentFileEncSHA256:
items:
type: integer
type: array
attachmentFileSHA256:
items:
type: integer
type: array
attachmentJPEGThumbnail:
items:
type: integer
type: array
attachmentMediaKey:
items:
type: integer
type: array
attachmentMediaKeyTimestamp:
type: integer
attachmentMimetype:
type: string
attachmentType:
$ref: '#/definitions/waE2E.InvoiceMessage_AttachmentType'
note:
type: string
token:
type: string
type: object
waE2E.InvoiceMessage_AttachmentType:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- InvoiceMessage_IMAGE
- InvoiceMessage_PDF
waE2E.KeepInChatMessage:
properties:
keepType:
$ref: '#/definitions/waE2E.KeepType'
key:
$ref: '#/definitions/waCommon.MessageKey'
timestampMS:
type: integer
type: object
waE2E.KeepType:
enum:
- 0
- 1
- 2
format: int32
type: integer
x-enum-varnames:
- KeepType_UNKNOWN_KEEP_TYPE
- KeepType_KEEP_FOR_ALL
- KeepType_UNDO_KEEP_FOR_ALL
waE2E.LIDMigrationMappingSyncMessage:
properties:
encodedMappingPayload:
items:
type: integer
type: array
type: object
waE2E.LinkPreviewMetadata:
properties:
fbExperimentID:
type: integer
linkInlineVideoMuted:
type: boolean
linkMediaDuration:
type: integer
musicMetadata:
$ref: '#/definitions/waE2E.EmbeddedMusic'
paymentLinkMetadata:
$ref: '#/definitions/waE2E.PaymentLinkMetadata'
socialMediaPostType:
$ref: '#/definitions/waE2E.LinkPreviewMetadata_SocialMediaPostType'
urlMetadata:
$ref: '#/definitions/waE2E.URLMetadata'
videoContentCaption:
type: string
videoContentURL:
type: string
type: object
waE2E.LinkPreviewMetadata_SocialMediaPostType:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
format: int32
type: integer
x-enum-varnames:
- LinkPreviewMetadata_NONE
- LinkPreviewMetadata_REEL
- LinkPreviewMetadata_LIVE_VIDEO
- LinkPreviewMetadata_LONG_VIDEO
- LinkPreviewMetadata_SINGLE_IMAGE
- LinkPreviewMetadata_CAROUSEL
waE2E.ListMessage:
properties:
buttonText:
type: string
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
description:
type: string
footerText:
type: string
listType:
$ref: '#/definitions/waE2E.ListMessage_ListType'
productListInfo:
$ref: '#/definitions/waE2E.ListMessage_ProductListInfo'
sections:
items:
$ref: '#/definitions/waE2E.ListMessage_Section'
type: array
title:
type: string
type: object
waE2E.ListMessage_ListType:
enum:
- 0
- 1
- 2
format: int32
type: integer
x-enum-varnames:
- ListMessage_UNKNOWN
- ListMessage_SINGLE_SELECT
- ListMessage_PRODUCT_LIST
waE2E.ListMessage_Product:
properties:
productID:
type: string
type: object
waE2E.ListMessage_ProductListHeaderImage:
properties:
JPEGThumbnail:
items:
type: integer
type: array
productID:
type: string
type: object
waE2E.ListMessage_ProductListInfo:
properties:
businessOwnerJID:
type: string
headerImage:
$ref: '#/definitions/waE2E.ListMessage_ProductListHeaderImage'
productSections:
items:
$ref: '#/definitions/waE2E.ListMessage_ProductSection'
type: array
type: object
waE2E.ListMessage_ProductSection:
properties:
products:
items:
$ref: '#/definitions/waE2E.ListMessage_Product'
type: array
title:
type: string
type: object
waE2E.ListMessage_Row:
properties:
description:
type: string
rowID:
type: string
title:
type: string
type: object
waE2E.ListMessage_Section:
properties:
rows:
items:
$ref: '#/definitions/waE2E.ListMessage_Row'
type: array
title:
type: string
type: object
waE2E.ListResponseMessage:
properties:
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
description:
type: string
listType:
$ref: '#/definitions/waE2E.ListResponseMessage_ListType'
singleSelectReply:
$ref: '#/definitions/waE2E.ListResponseMessage_SingleSelectReply'
title:
type: string
type: object
waE2E.ListResponseMessage_ListType:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- ListResponseMessage_UNKNOWN
- ListResponseMessage_SINGLE_SELECT
waE2E.ListResponseMessage_SingleSelectReply:
properties:
selectedRowID:
type: string
type: object
waE2E.LiveLocationMessage:
properties:
JPEGThumbnail:
items:
type: integer
type: array
accuracyInMeters:
type: integer
caption:
type: string
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
degreesClockwiseFromMagneticNorth:
type: integer
degreesLatitude:
type: number
degreesLongitude:
type: number
sequenceNumber:
type: integer
speedInMps:
type: number
timeOffset:
type: integer
type: object
waE2E.LocationMessage:
properties:
JPEGThumbnail:
items:
type: integer
type: array
URL:
type: string
accuracyInMeters:
type: integer
address:
type: string
comment:
type: string
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
degreesClockwiseFromMagneticNorth:
type: integer
degreesLatitude:
type: number
degreesLongitude:
type: number
isLive:
type: boolean
name:
type: string
speedInMps:
type: number
type: object
waE2E.MMSThumbnailMetadata:
properties:
mediaKey:
items:
type: integer
type: array
mediaKeyTimestamp:
type: integer
thumbnailDirectPath:
type: string
thumbnailEncSHA256:
items:
type: integer
type: array
thumbnailHeight:
type: integer
thumbnailSHA256:
items:
type: integer
type: array
thumbnailWidth:
type: integer
type: object
waE2E.MediaDomainInfo:
properties:
e2EeMediaKey:
items:
type: integer
type: array
mediaKeyDomain:
$ref: '#/definitions/waE2E.MediaKeyDomain'
type: object
waE2E.MediaKeyDomain:
enum:
- 0
- 1
- 2
format: int32
type: integer
x-enum-varnames:
- MediaKeyDomain_MEDIA_KEY_DOMAIN_UNKNOWN
- MediaKeyDomain_MEDIA_KEY_DOMAIN_E2EE
- MediaKeyDomain_MEDIA_KEY_DOMAIN_NON_E2EE
waE2E.MediaNotifyMessage:
properties:
expressPathURL:
type: string
fileEncSHA256:
items:
type: integer
type: array
fileLength:
type: integer
type: object
waE2E.MemberLabel:
properties:
label:
type: string
labelTimestamp:
type: integer
type: object
waE2E.Message:
properties:
albumMessage:
$ref: '#/definitions/waE2E.AlbumMessage'
associatedChildMessage:
$ref: '#/definitions/waE2E.FutureProofMessage'
audioMessage:
$ref: '#/definitions/waE2E.AudioMessage'
bcallMessage:
$ref: '#/definitions/waE2E.BCallMessage'
botForwardedMessage:
$ref: '#/definitions/waE2E.FutureProofMessage'
botInvokeMessage:
$ref: '#/definitions/waE2E.FutureProofMessage'
botTaskMessage:
$ref: '#/definitions/waE2E.FutureProofMessage'
buttonsMessage:
$ref: '#/definitions/waE2E.ButtonsMessage'
buttonsResponseMessage:
$ref: '#/definitions/waE2E.ButtonsResponseMessage'
call:
$ref: '#/definitions/waE2E.Call'
callLogMesssage:
$ref: '#/definitions/waE2E.CallLogMessage'
cancelPaymentRequestMessage:
$ref: '#/definitions/waE2E.CancelPaymentRequestMessage'
chat:
$ref: '#/definitions/waE2E.Chat'
commentMessage:
$ref: '#/definitions/waE2E.CommentMessage'
conditionalRevealMessage:
$ref: '#/definitions/waE2E.ConditionalRevealMessage'
contactMessage:
$ref: '#/definitions/waE2E.ContactMessage'
contactsArrayMessage:
$ref: '#/definitions/waE2E.ContactsArrayMessage'
conversation:
type: string
declinePaymentRequestMessage:
$ref: '#/definitions/waE2E.DeclinePaymentRequestMessage'
deviceSentMessage:
$ref: '#/definitions/waE2E.DeviceSentMessage'
documentMessage:
$ref: '#/definitions/waE2E.DocumentMessage'
documentWithCaptionMessage:
$ref: '#/definitions/waE2E.FutureProofMessage'
editedMessage:
$ref: '#/definitions/waE2E.FutureProofMessage'
encCommentMessage:
$ref: '#/definitions/waE2E.EncCommentMessage'
encEventResponseMessage:
$ref: '#/definitions/waE2E.EncEventResponseMessage'
encReactionMessage:
$ref: '#/definitions/waE2E.EncReactionMessage'
ephemeralMessage:
$ref: '#/definitions/waE2E.FutureProofMessage'
eventCoverImage:
$ref: '#/definitions/waE2E.FutureProofMessage'
eventInviteMessage:
$ref: '#/definitions/waE2E.EventInviteMessage'
eventMessage:
$ref: '#/definitions/waE2E.EventMessage'
extendedTextMessage:
$ref: '#/definitions/waE2E.ExtendedTextMessage'
fastRatchetKeySenderKeyDistributionMessage:
$ref: '#/definitions/waE2E.SenderKeyDistributionMessage'
groupInviteMessage:
$ref: '#/definitions/waE2E.GroupInviteMessage'
groupMentionedMessage:
$ref: '#/definitions/waE2E.FutureProofMessage'
groupRootKeyShare:
$ref: '#/definitions/waE2E.GroupRootKeyShare'
groupStatusMentionMessage:
$ref: '#/definitions/waE2E.FutureProofMessage'
groupStatusMessage:
$ref: '#/definitions/waE2E.FutureProofMessage'
groupStatusMessageV2:
$ref: '#/definitions/waE2E.FutureProofMessage'
highlyStructuredMessage:
$ref: '#/definitions/waE2E.HighlyStructuredMessage'
imageMessage:
$ref: '#/definitions/waE2E.ImageMessage'
interactiveMessage:
$ref: '#/definitions/waE2E.InteractiveMessage'
interactiveResponseMessage:
$ref: '#/definitions/waE2E.InteractiveResponseMessage'
invoiceMessage:
$ref: '#/definitions/waE2E.InvoiceMessage'
keepInChatMessage:
$ref: '#/definitions/waE2E.KeepInChatMessage'
limitSharingMessage:
$ref: '#/definitions/waE2E.FutureProofMessage'
listMessage:
$ref: '#/definitions/waE2E.ListMessage'
listResponseMessage:
$ref: '#/definitions/waE2E.ListResponseMessage'
liveLocationMessage:
$ref: '#/definitions/waE2E.LiveLocationMessage'
locationMessage:
$ref: '#/definitions/waE2E.LocationMessage'
lottieStickerMessage:
$ref: '#/definitions/waE2E.FutureProofMessage'
messageContextInfo:
$ref: '#/definitions/waE2E.MessageContextInfo'
messageHistoryBundle:
$ref: '#/definitions/waE2E.MessageHistoryBundle'
messageHistoryNotice:
$ref: '#/definitions/waE2E.MessageHistoryNotice'
newsletterAdminInviteMessage:
$ref: '#/definitions/waE2E.NewsletterAdminInviteMessage'
newsletterAdminProfileMessage:
$ref: '#/definitions/waE2E.FutureProofMessage'
newsletterAdminProfileMessageV2:
$ref: '#/definitions/waE2E.FutureProofMessage'
newsletterAdminProfileStatusMessage:
$ref: '#/definitions/waE2E.FutureProofMessage'
newsletterFollowerInviteMessageV2:
$ref: '#/definitions/waE2E.NewsletterFollowerInviteMessage'
orderMessage:
$ref: '#/definitions/waE2E.OrderMessage'
paymentInviteMessage:
$ref: '#/definitions/waE2E.PaymentInviteMessage'
paymentReminderMessage:
$ref: '#/definitions/waE2E.PaymentReminderMessage'
pinInChatMessage:
$ref: '#/definitions/waE2E.PinInChatMessage'
placeholderMessage:
$ref: '#/definitions/waE2E.PlaceholderMessage'
pollAddOptionMessage:
$ref: '#/definitions/waE2E.PollAddOptionMessage'
pollCreationMessage:
$ref: '#/definitions/waE2E.PollCreationMessage'
pollCreationMessageV2:
$ref: '#/definitions/waE2E.PollCreationMessage'
pollCreationMessageV3:
$ref: '#/definitions/waE2E.PollCreationMessage'
pollCreationMessageV4:
$ref: '#/definitions/waE2E.FutureProofMessage'
pollCreationMessageV5:
$ref: '#/definitions/waE2E.PollCreationMessage'
pollCreationMessageV6:
$ref: '#/definitions/waE2E.PollCreationMessage'
pollCreationOptionImageMessage:
$ref: '#/definitions/waE2E.FutureProofMessage'
pollResultSnapshotMessage:
$ref: '#/definitions/waE2E.PollResultSnapshotMessage'
pollResultSnapshotMessageV3:
$ref: '#/definitions/waE2E.PollResultSnapshotMessage'
pollUpdateMessage:
$ref: '#/definitions/waE2E.PollUpdateMessage'
productMessage:
$ref: '#/definitions/waE2E.ProductMessage'
protocolMessage:
$ref: '#/definitions/waE2E.ProtocolMessage'
ptvMessage:
$ref: '#/definitions/waE2E.VideoMessage'
questionMessage:
$ref: '#/definitions/waE2E.FutureProofMessage'
questionReplyMessage:
$ref: '#/definitions/waE2E.FutureProofMessage'
questionResponseMessage:
$ref: '#/definitions/waE2E.QuestionResponseMessage'
reactionMessage:
$ref: '#/definitions/waE2E.ReactionMessage'
requestPaymentMessage:
$ref: '#/definitions/waE2E.RequestPaymentMessage'
requestPhoneNumberMessage:
$ref: '#/definitions/waE2E.RequestPhoneNumberMessage'
richResponseMessage:
$ref: '#/definitions/waE2E.AIRichResponseMessage'
rootSecretDistributeMessage:
$ref: '#/definitions/waE2E.RootSecretDistributeMessage'
scheduledCallCreationMessage:
$ref: '#/definitions/waE2E.ScheduledCallCreationMessage'
scheduledCallEditMessage:
$ref: '#/definitions/waE2E.ScheduledCallEditMessage'
secretEncryptedMessage:
$ref: '#/definitions/waE2E.SecretEncryptedMessage'
sendPaymentMessage:
$ref: '#/definitions/waE2E.SendPaymentMessage'
senderKeyDistributionMessage:
$ref: '#/definitions/waE2E.SenderKeyDistributionMessage'
splitPaymentMessage:
$ref: '#/definitions/waE2E.SplitPaymentMessage'
spoilerMessage:
$ref: '#/definitions/waE2E.FutureProofMessage'
statusAddYours:
$ref: '#/definitions/waE2E.FutureProofMessage'
statusMentionMessage:
$ref: '#/definitions/waE2E.FutureProofMessage'
statusNotificationMessage:
$ref: '#/definitions/waE2E.StatusNotificationMessage'
statusQuestionAnswerMessage:
$ref: '#/definitions/waE2E.StatusQuestionAnswerMessage'
statusQuotedMessage:
$ref: '#/definitions/waE2E.StatusQuotedMessage'
statusStickerInteractionMessage:
$ref: '#/definitions/waE2E.StatusStickerInteractionMessage'
stickerMessage:
$ref: '#/definitions/waE2E.StickerMessage'
stickerPackMessage:
$ref: '#/definitions/waE2E.StickerPackMessage'
stickerSyncRmrMessage:
$ref: '#/definitions/waE2E.StickerSyncRMRMessage'
templateButtonReplyMessage:
$ref: '#/definitions/waE2E.TemplateButtonReplyMessage'
templateMessage:
$ref: '#/definitions/waE2E.TemplateMessage'
videoMessage:
$ref: '#/definitions/waE2E.VideoMessage'
viewOnceMessage:
$ref: '#/definitions/waE2E.FutureProofMessage'
viewOnceMessageV2:
$ref: '#/definitions/waE2E.FutureProofMessage'
viewOnceMessageV2Extension:
$ref: '#/definitions/waE2E.FutureProofMessage'
type: object
waE2E.MessageAssociation:
properties:
associationType:
$ref: '#/definitions/waE2E.MessageAssociation_AssociationType'
messageIndex:
type: integer
parentMessageKey:
$ref: '#/definitions/waCommon.MessageKey'
type: object
waE2E.MessageAssociation_AssociationType:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
format: int32
type: integer
x-enum-varnames:
- MessageAssociation_UNKNOWN
- MessageAssociation_MEDIA_ALBUM
- MessageAssociation_BOT_PLUGIN
- MessageAssociation_EVENT_COVER_IMAGE
- MessageAssociation_STATUS_POLL
- MessageAssociation_HD_VIDEO_DUAL_UPLOAD
- MessageAssociation_STATUS_EXTERNAL_RESHARE
- MessageAssociation_MEDIA_POLL
- MessageAssociation_STATUS_ADD_YOURS
- MessageAssociation_STATUS_NOTIFICATION
- MessageAssociation_HD_IMAGE_DUAL_UPLOAD
- MessageAssociation_STICKER_ANNOTATION
- MessageAssociation_MOTION_PHOTO
- MessageAssociation_STATUS_LINK_ACTION
- MessageAssociation_VIEW_ALL_REPLIES
- MessageAssociation_STATUS_ADD_YOURS_AI_IMAGINE
- MessageAssociation_STATUS_QUESTION
- MessageAssociation_STATUS_ADD_YOURS_DIWALI
- MessageAssociation_STATUS_REACTION
- MessageAssociation_HEVC_VIDEO_DUAL_UPLOAD
- MessageAssociation_POLL_ADD_OPTION
waE2E.MessageContextInfo:
properties:
botMessageSecret:
items:
type: integer
type: array
botMetadata:
$ref: '#/definitions/waAICommon.BotMetadata'
capiCreatedGroup:
type: boolean
deviceListMetadata:
$ref: '#/definitions/waE2E.DeviceListMetadata'
deviceListMetadataVersion:
type: integer
limitSharing:
$ref: '#/definitions/waCommon.LimitSharing'
limitSharingV2:
$ref: '#/definitions/waCommon.LimitSharing'
messageAddOnDurationInSecs:
type: integer
messageAddOnExpiryType:
$ref: '#/definitions/waE2E.MessageContextInfo_MessageAddonExpiryType'
messageAssociation:
$ref: '#/definitions/waE2E.MessageAssociation'
messageSecret:
items:
type: integer
type: array
paddingBytes:
items:
type: integer
type: array
reportingTokenVersion:
type: integer
supportPayload:
type: string
teeBotMetadata:
items:
type: integer
type: array
threadID:
items:
$ref: '#/definitions/waE2E.ThreadID'
type: array
weblinkRenderConfig:
$ref: '#/definitions/waE2E.WebLinkRenderConfig'
type: object
waE2E.MessageContextInfo_MessageAddonExpiryType:
enum:
- 1
- 2
format: int32
type: integer
x-enum-varnames:
- MessageContextInfo_STATIC
- MessageContextInfo_DEPENDENT_ON_PARENT
waE2E.MessageHistoryBundle:
properties:
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
directPath:
type: string
fileEncSHA256:
items:
type: integer
type: array
fileSHA256:
items:
type: integer
type: array
mediaKey:
items:
type: integer
type: array
mediaKeyTimestamp:
type: integer
messageHistoryMetadata:
$ref: '#/definitions/waE2E.MessageHistoryMetadata'
mimetype:
type: string
type: object
waE2E.MessageHistoryMetadata:
properties:
historyReceivers:
items:
type: string
type: array
messageCount:
type: integer
nonHistoryReceivers:
items:
type: string
type: array
oldestMessageTimestampInBundle:
type: integer
oldestMessageTimestampInWindow:
type: integer
type: object
waE2E.MessageHistoryNotice:
properties:
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
messageHistoryMetadata:
$ref: '#/definitions/waE2E.MessageHistoryMetadata'
type: object
waE2E.Money:
properties:
currencyCode:
type: string
offset:
type: integer
value:
type: integer
type: object
waE2E.NewsletterAdminInviteMessage:
properties:
JPEGThumbnail:
items:
type: integer
type: array
caption:
type: string
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
inviteExpiration:
type: integer
newsletterJID:
type: string
newsletterName:
type: string
type: object
waE2E.NewsletterFollowerInviteMessage:
properties:
JPEGThumbnail:
items:
type: integer
type: array
caption:
type: string
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
newsletterJID:
type: string
newsletterName:
type: string
type: object
waE2E.OrderMessage:
properties:
catalogType:
type: string
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
itemCount:
type: integer
message:
type: string
messageVersion:
type: integer
orderID:
type: string
orderRequestMessageID:
$ref: '#/definitions/waCommon.MessageKey'
orderTitle:
type: string
sellerJID:
type: string
status:
$ref: '#/definitions/waE2E.OrderMessage_OrderStatus'
surface:
$ref: '#/definitions/waE2E.OrderMessage_OrderSurface'
thumbnail:
items:
type: integer
type: array
token:
type: string
totalAmount1000:
type: integer
totalCurrencyCode:
type: string
type: object
waE2E.OrderMessage_OrderStatus:
enum:
- 1
- 2
- 3
format: int32
type: integer
x-enum-varnames:
- OrderMessage_INQUIRY
- OrderMessage_ACCEPTED
- OrderMessage_DECLINED
waE2E.OrderMessage_OrderSurface:
enum:
- 1
format: int32
type: integer
x-enum-varnames:
- OrderMessage_CATALOG
waE2E.PaymentBackground:
properties:
ID:
type: string
fileLength:
type: integer
height:
type: integer
mediaData:
$ref: '#/definitions/waE2E.PaymentBackground_MediaData'
mimetype:
type: string
placeholderArgb:
type: integer
subtextArgb:
type: integer
textArgb:
type: integer
type:
$ref: '#/definitions/waE2E.PaymentBackground_Type'
width:
type: integer
type: object
waE2E.PaymentBackground_MediaData:
properties:
directPath:
type: string
fileEncSHA256:
items:
type: integer
type: array
fileSHA256:
items:
type: integer
type: array
mediaKey:
items:
type: integer
type: array
mediaKeyTimestamp:
type: integer
type: object
waE2E.PaymentBackground_Type:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- PaymentBackground_UNKNOWN
- PaymentBackground_DEFAULT
waE2E.PaymentExtendedMetadata:
properties:
platform:
type: string
type:
type: integer
type: object
waE2E.PaymentInviteMessage:
properties:
expiryTimestamp:
type: integer
incentiveEligible:
type: boolean
inviteType:
$ref: '#/definitions/waE2E.PaymentInviteMessage_InviteType'
referralID:
type: string
serviceType:
$ref: '#/definitions/waE2E.PaymentInviteMessage_ServiceType'
type: object
waE2E.PaymentInviteMessage_InviteType:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- PaymentInviteMessage_DEFAULT
- PaymentInviteMessage_MAPPER
waE2E.PaymentInviteMessage_ServiceType:
enum:
- 0
- 1
- 2
- 3
format: int32
type: integer
x-enum-varnames:
- PaymentInviteMessage_UNKNOWN
- PaymentInviteMessage_FBPAY
- PaymentInviteMessage_NOVI
- PaymentInviteMessage_UPI
waE2E.PaymentLinkMetadata:
properties:
button:
$ref: '#/definitions/waE2E.PaymentLinkMetadata_PaymentLinkButton'
header:
$ref: '#/definitions/waE2E.PaymentLinkMetadata_PaymentLinkHeader'
provider:
$ref: '#/definitions/waE2E.PaymentLinkMetadata_PaymentLinkProvider'
type: object
waE2E.PaymentLinkMetadata_PaymentLinkButton:
properties:
displayText:
type: string
type: object
waE2E.PaymentLinkMetadata_PaymentLinkHeader:
properties:
headerType:
$ref: '#/definitions/waE2E.PaymentLinkMetadata_PaymentLinkHeader_PaymentLinkHeaderType'
type: object
waE2E.PaymentLinkMetadata_PaymentLinkHeader_PaymentLinkHeaderType:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- PaymentLinkMetadata_PaymentLinkHeader_LINK_PREVIEW
- PaymentLinkMetadata_PaymentLinkHeader_ORDER
waE2E.PaymentLinkMetadata_PaymentLinkProvider:
properties:
paramsJSON:
type: string
type: object
waE2E.PaymentReminderMessage:
properties:
amount:
$ref: '#/definitions/waE2E.Money'
description:
type: string
frequency:
$ref: '#/definitions/waE2E.PaymentReminderMessage_ReminderFrequency'
instanceID:
type: string
payeeJID:
type: string
payeeVpa:
type: string
payerJID:
type: string
reminderID:
type: string
status:
$ref: '#/definitions/waE2E.PaymentReminderMessage_ReminderStatus'
type: object
waE2E.PaymentReminderMessage_ReminderFrequency:
enum:
- 0
- 1
- 2
- 3
- 4
format: int32
type: integer
x-enum-varnames:
- PaymentReminderMessage_REMINDER_FREQUENCY_UNKNOWN
- PaymentReminderMessage_WEEKLY
- PaymentReminderMessage_BI_WEEKLY
- PaymentReminderMessage_MONTHLY
- PaymentReminderMessage_QUARTERLY
waE2E.PaymentReminderMessage_ReminderStatus:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
format: int32
type: integer
x-enum-varnames:
- PaymentReminderMessage_REMINDER_STATUS_UNKNOWN
- PaymentReminderMessage_ACTIVE
- PaymentReminderMessage_CANCELLED_BY_CREATOR
- PaymentReminderMessage_STOPPED_BY_RECEIVER
- PaymentReminderMessage_EXPIRED
- PaymentReminderMessage_PAID
waE2E.PeerDataOperationRequestMessage:
properties:
bizBroadcastInsightsContactListRequest:
$ref: '#/definitions/waE2E.PeerDataOperationRequestMessage_BizBroadcastInsightsContactListRequest'
bizBroadcastInsightsRefreshRequest:
$ref: '#/definitions/waE2E.PeerDataOperationRequestMessage_BizBroadcastInsightsRefreshRequest'
companionCanonicalUserNonceFetchRequest:
$ref: '#/definitions/waE2E.PeerDataOperationRequestMessage_CompanionCanonicalUserNonceFetchRequest'
fullHistorySyncOnDemandRequest:
$ref: '#/definitions/waE2E.PeerDataOperationRequestMessage_FullHistorySyncOnDemandRequest'
galaxyFlowAction:
$ref: '#/definitions/waE2E.PeerDataOperationRequestMessage_GalaxyFlowAction'
historySyncChunkRetryRequest:
$ref: '#/definitions/waE2E.PeerDataOperationRequestMessage_HistorySyncChunkRetryRequest'
historySyncOnDemandRequest:
$ref: '#/definitions/waE2E.PeerDataOperationRequestMessage_HistorySyncOnDemandRequest'
peerDataOperationRequestType:
$ref: '#/definitions/waE2E.PeerDataOperationRequestType'
placeholderMessageResendRequest:
items:
$ref: '#/definitions/waE2E.PeerDataOperationRequestMessage_PlaceholderMessageResendRequest'
type: array
requestStickerReupload:
items:
$ref: '#/definitions/waE2E.PeerDataOperationRequestMessage_RequestStickerReupload'
type: array
requestURLPreview:
items:
$ref: '#/definitions/waE2E.PeerDataOperationRequestMessage_RequestUrlPreview'
type: array
syncdCollectionFatalRecoveryRequest:
$ref: '#/definitions/waE2E.PeerDataOperationRequestMessage_SyncDCollectionFatalRecoveryRequest'
type: object
waE2E.PeerDataOperationRequestMessage_BizBroadcastInsightsContactListRequest:
properties:
campaignID:
type: string
type: object
waE2E.PeerDataOperationRequestMessage_BizBroadcastInsightsRefreshRequest:
properties:
campaignID:
type: string
type: object
waE2E.PeerDataOperationRequestMessage_CompanionCanonicalUserNonceFetchRequest:
properties:
registrationTraceID:
type: string
type: object
waE2E.PeerDataOperationRequestMessage_FullHistorySyncOnDemandRequest:
properties:
fullHistorySyncOnDemandConfig:
$ref: '#/definitions/waE2E.FullHistorySyncOnDemandConfig'
historySyncConfig:
$ref: '#/definitions/waCompanionReg.DeviceProps_HistorySyncConfig'
requestMetadata:
$ref: '#/definitions/waE2E.FullHistorySyncOnDemandRequestMetadata'
type: object
waE2E.PeerDataOperationRequestMessage_GalaxyFlowAction:
properties:
agmID:
type: string
flowID:
type: string
galaxyFlowDownloadRequestID:
type: string
stanzaID:
type: string
type:
$ref: '#/definitions/waE2E.PeerDataOperationRequestMessage_GalaxyFlowAction_GalaxyFlowActionType'
type: object
waE2E.PeerDataOperationRequestMessage_GalaxyFlowAction_GalaxyFlowActionType:
enum:
- 1
- 2
format: int32
type: integer
x-enum-varnames:
- PeerDataOperationRequestMessage_GalaxyFlowAction_NOTIFY_LAUNCH
- PeerDataOperationRequestMessage_GalaxyFlowAction_DOWNLOAD_RESPONSES
waE2E.PeerDataOperationRequestMessage_HistorySyncChunkRetryRequest:
properties:
chunkNotificationID:
type: string
chunkOrder:
type: integer
regenerateChunk:
type: boolean
syncType:
$ref: '#/definitions/waE2E.HistorySyncType'
type: object
waE2E.PeerDataOperationRequestMessage_HistorySyncOnDemandRequest:
properties:
accountLid:
type: string
chatJID:
type: string
oldestMsgFromMe:
type: boolean
oldestMsgID:
type: string
oldestMsgTimestampMS:
type: integer
onDemandMsgCount:
type: integer
supportInlineResponse:
type: boolean
type: object
waE2E.PeerDataOperationRequestMessage_PlaceholderMessageResendRequest:
properties:
messageKey:
$ref: '#/definitions/waCommon.MessageKey'
type: object
waE2E.PeerDataOperationRequestMessage_RequestStickerReupload:
properties:
fileSHA256:
type: string
type: object
waE2E.PeerDataOperationRequestMessage_RequestUrlPreview:
properties:
URL:
type: string
includeHqThumbnail:
type: boolean
type: object
waE2E.PeerDataOperationRequestMessage_SyncDCollectionFatalRecoveryRequest:
properties:
collectionName:
type: string
timestamp:
type: integer
type: object
waE2E.PeerDataOperationRequestResponseMessage:
properties:
peerDataOperationRequestType:
$ref: '#/definitions/waE2E.PeerDataOperationRequestType'
peerDataOperationResult:
items:
$ref: '#/definitions/waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult'
type: array
stanzaID:
type: string
type: object
waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult:
properties:
bizBroadcastInsightsContactListResponse:
$ref: '#/definitions/waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_BizBroadcastInsightsContactListResponse'
companionCanonicalUserNonceFetchRequestResponse:
$ref: '#/definitions/waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_CompanionCanonicalUserNonceFetchResponse'
companionMetaNonceFetchRequestResponse:
$ref: '#/definitions/waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_CompanionMetaNonceFetchResponse'
flowResponsesCsvBundle:
$ref: '#/definitions/waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_FlowResponsesCsvBundle'
fullHistorySyncOnDemandRequestResponse:
$ref: '#/definitions/waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_FullHistorySyncOnDemandRequestResponse'
historySyncChunkRetryResponse:
$ref: '#/definitions/waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_HistorySyncChunkRetryResponse'
linkPreviewResponse:
$ref: '#/definitions/waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_LinkPreviewResponse'
mediaUploadResult:
$ref: '#/definitions/waMmsRetry.MediaRetryNotification_ResultType'
placeholderMessageResendResponse:
$ref: '#/definitions/waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_PlaceholderMessageResendResponse'
stickerMessage:
$ref: '#/definitions/waE2E.StickerMessage'
syncdSnapshotFatalRecoveryResponse:
$ref: '#/definitions/waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_SyncDSnapshotFatalRecoveryResponse'
waffleNonceFetchRequestResponse:
$ref: '#/definitions/waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_WaffleNonceFetchResponse'
type: object
waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_BizBroadcastInsightsContactListResponse:
properties:
campaignID:
type: string
contacts:
items:
$ref: '#/definitions/waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_BizBroadcastInsightsContactState'
type: array
timestampMS:
type: integer
type: object
waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_BizBroadcastInsightsContactState:
properties:
contactJID:
type: string
state:
$ref: '#/definitions/waE2E.InsightDeliveryState'
type: object
waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_CompanionCanonicalUserNonceFetchResponse:
properties:
forceRefresh:
type: boolean
nonce:
type: string
waFbid:
type: string
type: object
waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_CompanionMetaNonceFetchResponse:
properties:
nonce:
type: string
type: object
waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_FlowResponsesCsvBundle:
properties:
directPath:
type: string
fileEncSHA256:
items:
type: integer
type: array
fileLength:
type: integer
fileName:
type: string
fileSHA256:
items:
type: integer
type: array
flowID:
type: string
galaxyFlowDownloadRequestID:
type: string
mediaKey:
items:
type: integer
type: array
mediaKeyTimestamp:
type: integer
mimetype:
type: string
type: object
waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_FullHistorySyncOnDemandRequestResponse:
properties:
requestMetadata:
$ref: '#/definitions/waE2E.FullHistorySyncOnDemandRequestMetadata'
responseCode:
$ref: '#/definitions/waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_FullHistorySyncOnDemandResponseCode'
type: object
waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_FullHistorySyncOnDemandResponseCode:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
format: int32
type: integer
x-enum-varnames:
- PeerDataOperationRequestResponseMessage_PeerDataOperationResult_REQUEST_SUCCESS
- PeerDataOperationRequestResponseMessage_PeerDataOperationResult_REQUEST_TIME_EXPIRED
- PeerDataOperationRequestResponseMessage_PeerDataOperationResult_DECLINED_SHARING_HISTORY
- PeerDataOperationRequestResponseMessage_PeerDataOperationResult_GENERIC_ERROR
- PeerDataOperationRequestResponseMessage_PeerDataOperationResult_ERROR_REQUEST_ON_NON_SMB_PRIMARY
- PeerDataOperationRequestResponseMessage_PeerDataOperationResult_ERROR_HOSTED_DEVICE_NOT_CONNECTED
- PeerDataOperationRequestResponseMessage_PeerDataOperationResult_ERROR_HOSTED_DEVICE_LOGIN_TIME_NOT_SET
- PeerDataOperationRequestResponseMessage_PeerDataOperationResult_ERROR_MULTI_PROVIDER_NOT_CONFIGURED
waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_HistorySyncChunkRetryResponse:
properties:
canRecover:
type: boolean
chunkOrder:
type: integer
requestID:
type: string
responseCode:
$ref: '#/definitions/waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_HistorySyncChunkRetryResponseCode'
syncType:
$ref: '#/definitions/waE2E.HistorySyncType'
type: object
waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_HistorySyncChunkRetryResponseCode:
enum:
- 1
- 2
- 3
- 4
- 5
- 6
format: int32
type: integer
x-enum-varnames:
- PeerDataOperationRequestResponseMessage_PeerDataOperationResult_GENERATION_ERROR
- PeerDataOperationRequestResponseMessage_PeerDataOperationResult_CHUNK_CONSUMED
- PeerDataOperationRequestResponseMessage_PeerDataOperationResult_TIMEOUT
- PeerDataOperationRequestResponseMessage_PeerDataOperationResult_SESSION_EXHAUSTED
- PeerDataOperationRequestResponseMessage_PeerDataOperationResult_CHUNK_EXHAUSTED
- PeerDataOperationRequestResponseMessage_PeerDataOperationResult_DUPLICATED_REQUEST
waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_LinkPreviewResponse:
properties:
URL:
type: string
description:
type: string
hqThumbnail:
$ref: '#/definitions/waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_LinkPreviewResponse_LinkPreviewHighQualityThumbnail'
matchText:
type: string
previewMetadata:
$ref: '#/definitions/waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_LinkPreviewResponse_PaymentLinkPreviewMetadata'
previewType:
type: string
thumbData:
items:
type: integer
type: array
title:
type: string
type: object
waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_LinkPreviewResponse_LinkPreviewHighQualityThumbnail:
properties:
directPath:
type: string
encThumbHash:
type: string
mediaKey:
items:
type: integer
type: array
mediaKeyTimestampMS:
type: integer
thumbHash:
type: string
thumbHeight:
type: integer
thumbWidth:
type: integer
type: object
waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_LinkPreviewResponse_PaymentLinkPreviewMetadata:
properties:
amount:
type: string
currency:
type: string
isBusinessVerified:
type: boolean
offset:
type: string
providerName:
type: string
type: object
waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_PlaceholderMessageResendResponse:
properties:
webMessageInfoBytes:
items:
type: integer
type: array
type: object
waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_SyncDSnapshotFatalRecoveryResponse:
properties:
collectionSnapshot:
items:
type: integer
type: array
isCompressed:
type: boolean
type: object
waE2E.PeerDataOperationRequestResponseMessage_PeerDataOperationResult_WaffleNonceFetchResponse:
properties:
nonce:
type: string
waEntFbid:
type: string
type: object
waE2E.PeerDataOperationRequestType:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
format: int32
type: integer
x-enum-varnames:
- PeerDataOperationRequestType_UPLOAD_STICKER
- PeerDataOperationRequestType_SEND_RECENT_STICKER_BOOTSTRAP
- PeerDataOperationRequestType_GENERATE_LINK_PREVIEW
- PeerDataOperationRequestType_HISTORY_SYNC_ON_DEMAND
- PeerDataOperationRequestType_PLACEHOLDER_MESSAGE_RESEND
- PeerDataOperationRequestType_WAFFLE_LINKING_NONCE_FETCH
- PeerDataOperationRequestType_FULL_HISTORY_SYNC_ON_DEMAND
- PeerDataOperationRequestType_COMPANION_META_NONCE_FETCH
- PeerDataOperationRequestType_COMPANION_SYNCD_SNAPSHOT_FATAL_RECOVERY
- PeerDataOperationRequestType_COMPANION_CANONICAL_USER_NONCE_FETCH
- PeerDataOperationRequestType_HISTORY_SYNC_CHUNK_RETRY
- PeerDataOperationRequestType_GALAXY_FLOW_ACTION
- PeerDataOperationRequestType_BUSINESS_BROADCAST_INSIGHTS_DELIVERED_TO
- PeerDataOperationRequestType_BUSINESS_BROADCAST_INSIGHTS_REFRESH
waE2E.PinInChatMessage:
properties:
key:
$ref: '#/definitions/waCommon.MessageKey'
senderTimestampMS:
type: integer
type:
$ref: '#/definitions/waE2E.PinInChatMessage_Type'
type: object
waE2E.PinInChatMessage_Type:
enum:
- 0
- 1
- 2
format: int32
type: integer
x-enum-varnames:
- PinInChatMessage_UNKNOWN_TYPE
- PinInChatMessage_PIN_FOR_ALL
- PinInChatMessage_UNPIN_FOR_ALL
waE2E.PlaceholderMessage:
properties:
type:
$ref: '#/definitions/waE2E.PlaceholderMessage_PlaceholderType'
type: object
waE2E.PlaceholderMessage_PlaceholderType:
enum:
- 0
format: int32
type: integer
x-enum-varnames:
- PlaceholderMessage_MASK_LINKED_DEVICES
waE2E.Point:
properties:
x:
type: number
xDeprecated:
type: integer
"y":
type: number
yDeprecated:
type: integer
type: object
waE2E.PollAddOptionMessage:
properties:
addOption:
$ref: '#/definitions/waE2E.PollCreationMessage_Option'
metadata:
$ref: '#/definitions/waE2E.PollUpdateMessageMetadata'
pollCreationMessageKey:
$ref: '#/definitions/waCommon.MessageKey'
type: object
waE2E.PollContentType:
enum:
- 0
- 1
- 2
format: int32
type: integer
x-enum-varnames:
- PollContentType_UNKNOWN_POLL_CONTENT_TYPE
- PollContentType_TEXT
- PollContentType_IMAGE
waE2E.PollCreationMessage:
properties:
allowAddOption:
type: boolean
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
correctAnswer:
$ref: '#/definitions/waE2E.PollCreationMessage_Option'
encKey:
items:
type: integer
type: array
endTime:
type: integer
hideParticipantName:
type: boolean
name:
type: string
options:
items:
$ref: '#/definitions/waE2E.PollCreationMessage_Option'
type: array
pollContentType:
$ref: '#/definitions/waE2E.PollContentType'
pollType:
$ref: '#/definitions/waE2E.PollType'
selectableOptionsCount:
type: integer
type: object
waE2E.PollCreationMessage_Option:
properties:
optionHash:
type: string
optionName:
type: string
type: object
waE2E.PollEncValue:
properties:
encIV:
items:
type: integer
type: array
encPayload:
items:
type: integer
type: array
type: object
waE2E.PollResultSnapshotMessage:
properties:
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
name:
type: string
pollType:
$ref: '#/definitions/waE2E.PollType'
pollVotes:
items:
$ref: '#/definitions/waE2E.PollResultSnapshotMessage_PollVote'
type: array
type: object
waE2E.PollResultSnapshotMessage_PollVote:
properties:
optionName:
type: string
optionVoteCount:
type: integer
type: object
waE2E.PollType:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- PollType_POLL
- PollType_QUIZ
waE2E.PollUpdateMessage:
properties:
metadata:
$ref: '#/definitions/waE2E.PollUpdateMessageMetadata'
pollCreationMessageKey:
$ref: '#/definitions/waCommon.MessageKey'
senderTimestampMS:
type: integer
vote:
$ref: '#/definitions/waE2E.PollEncValue'
type: object
waE2E.PollUpdateMessageMetadata:
properties:
lastEditStanzaID:
type: string
pollNameHash:
items:
type: integer
type: array
type: object
waE2E.ProcessedVideo:
properties:
bitrate:
type: integer
capabilities:
items:
type: string
type: array
directPath:
type: string
fileLength:
type: integer
fileSHA256:
items:
type: integer
type: array
height:
type: integer
quality:
$ref: '#/definitions/waE2E.ProcessedVideo_VideoQuality'
width:
type: integer
type: object
waE2E.ProcessedVideo_VideoQuality:
enum:
- 0
- 1
- 2
- 3
format: int32
type: integer
x-enum-varnames:
- ProcessedVideo_UNDEFINED
- ProcessedVideo_LOW
- ProcessedVideo_MID
- ProcessedVideo_HIGH
waE2E.ProductMessage:
properties:
body:
type: string
businessOwnerJID:
type: string
catalog:
$ref: '#/definitions/waE2E.ProductMessage_CatalogSnapshot'
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
footer:
type: string
product:
$ref: '#/definitions/waE2E.ProductMessage_ProductSnapshot'
type: object
waE2E.ProductMessage_CatalogSnapshot:
properties:
catalogImage:
$ref: '#/definitions/waE2E.ImageMessage'
description:
type: string
title:
type: string
type: object
waE2E.ProductMessage_ProductSnapshot:
properties:
URL:
type: string
currencyCode:
type: string
description:
type: string
firstImageID:
type: string
priceAmount1000:
type: integer
productID:
type: string
productImage:
$ref: '#/definitions/waE2E.ImageMessage'
productImageCount:
type: integer
retailerID:
type: string
salePriceAmount1000:
type: integer
signedURL:
type: string
title:
type: string
type: object
waE2E.ProtocolMessage:
properties:
afterReadDuration:
type: integer
aiMediaCollectionMessage:
$ref: '#/definitions/waAICommon.AIMediaCollectionMessage'
aiMetadataOperation:
$ref: '#/definitions/waAICommon.AIMetadataOperation'
aiPsiMetadata:
items:
type: integer
type: array
aiQueryFanout:
$ref: '#/definitions/waE2E.AIQueryFanout'
appStateFatalExceptionNotification:
$ref: '#/definitions/waE2E.AppStateFatalExceptionNotification'
appStateSyncKeyRequest:
$ref: '#/definitions/waE2E.AppStateSyncKeyRequest'
appStateSyncKeyShare:
$ref: '#/definitions/waE2E.AppStateSyncKeyShare'
botFeedbackMessage:
$ref: '#/definitions/waAICommon.BotFeedbackMessage'
chatThemeSetting:
$ref: '#/definitions/waE2E.ChatThemeSetting'
cloudApiThreadControlNotification:
$ref: '#/definitions/waE2E.CloudAPIThreadControlNotification'
disappearingMode:
$ref: '#/definitions/waE2E.DisappearingMode'
editedMessage:
$ref: '#/definitions/waE2E.Message'
ephemeralExpiration:
type: integer
ephemeralSettingTimestamp:
type: integer
historySyncNotification:
$ref: '#/definitions/waE2E.HistorySyncNotification'
initialSecurityNotificationSettingSync:
$ref: '#/definitions/waE2E.InitialSecurityNotificationSettingSync'
invokerJID:
type: string
key:
$ref: '#/definitions/waCommon.MessageKey'
lidMigrationMappingSyncMessage:
$ref: '#/definitions/waE2E.LIDMigrationMappingSyncMessage'
limitSharing:
$ref: '#/definitions/waCommon.LimitSharing'
mediaNotifyMessage:
$ref: '#/definitions/waE2E.MediaNotifyMessage'
memberLabel:
$ref: '#/definitions/waE2E.MemberLabel'
peerDataOperationRequestMessage:
$ref: '#/definitions/waE2E.PeerDataOperationRequestMessage'
peerDataOperationRequestResponseMessage:
$ref: '#/definitions/waE2E.PeerDataOperationRequestResponseMessage'
requestWelcomeMessageMetadata:
$ref: '#/definitions/waE2E.RequestWelcomeMessageMetadata'
timestampMS:
type: integer
type:
$ref: '#/definitions/waE2E.ProtocolMessage_Type'
type: object
waE2E.ProtocolMessage_Type:
enum:
- 0
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 14
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 34
- 35
format: int32
type: integer
x-enum-varnames:
- ProtocolMessage_REVOKE
- ProtocolMessage_EPHEMERAL_SETTING
- ProtocolMessage_EPHEMERAL_SYNC_RESPONSE
- ProtocolMessage_HISTORY_SYNC_NOTIFICATION
- ProtocolMessage_APP_STATE_SYNC_KEY_SHARE
- ProtocolMessage_APP_STATE_SYNC_KEY_REQUEST
- ProtocolMessage_MSG_FANOUT_BACKFILL_REQUEST
- ProtocolMessage_INITIAL_SECURITY_NOTIFICATION_SETTING_SYNC
- ProtocolMessage_APP_STATE_FATAL_EXCEPTION_NOTIFICATION
- ProtocolMessage_SHARE_PHONE_NUMBER
- ProtocolMessage_MESSAGE_EDIT
- ProtocolMessage_PEER_DATA_OPERATION_REQUEST_MESSAGE
- ProtocolMessage_PEER_DATA_OPERATION_REQUEST_RESPONSE_MESSAGE
- ProtocolMessage_REQUEST_WELCOME_MESSAGE
- ProtocolMessage_BOT_FEEDBACK_MESSAGE
- ProtocolMessage_MEDIA_NOTIFY_MESSAGE
- ProtocolMessage_CLOUD_API_THREAD_CONTROL_NOTIFICATION
- ProtocolMessage_LID_MIGRATION_MAPPING_SYNC
- ProtocolMessage_REMINDER_MESSAGE
- ProtocolMessage_BOT_MEMU_ONBOARDING_MESSAGE
- ProtocolMessage_STATUS_MENTION_MESSAGE
- ProtocolMessage_STOP_GENERATION_MESSAGE
- ProtocolMessage_LIMIT_SHARING
- ProtocolMessage_AI_PSI_METADATA
- ProtocolMessage_AI_QUERY_FANOUT
- ProtocolMessage_GROUP_MEMBER_LABEL_CHANGE
- ProtocolMessage_AI_MEDIA_COLLECTION_MESSAGE
- ProtocolMessage_MESSAGE_UNSCHEDULE
- ProtocolMessage_CHAT_THEME_SETTING
- ProtocolMessage_AI_METADATA_OPERATION
waE2E.QuestionResponseMessage:
properties:
key:
$ref: '#/definitions/waCommon.MessageKey'
text:
type: string
type: object
waE2E.ReactionMessage:
properties:
groupingKey:
type: string
key:
$ref: '#/definitions/waCommon.MessageKey'
senderTimestampMS:
type: integer
text:
type: string
type: object
waE2E.RequestPaymentMessage:
properties:
amount:
$ref: '#/definitions/waE2E.Money'
amount1000:
type: integer
background:
$ref: '#/definitions/waE2E.PaymentBackground'
currencyCodeIso4217:
type: string
expiryTimestamp:
type: integer
noteMessage:
$ref: '#/definitions/waE2E.Message'
requestFrom:
type: string
type: object
waE2E.RequestPhoneNumberMessage:
properties:
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
type: object
waE2E.RequestWelcomeMessageMetadata:
properties:
botAgentMetadata:
$ref: '#/definitions/waAICommon.BotAgentMetadata'
localChatState:
$ref: '#/definitions/waE2E.RequestWelcomeMessageMetadata_LocalChatState'
welcomeTrigger:
$ref: '#/definitions/waE2E.RequestWelcomeMessageMetadata_WelcomeTrigger'
type: object
waE2E.RequestWelcomeMessageMetadata_LocalChatState:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- RequestWelcomeMessageMetadata_EMPTY
- RequestWelcomeMessageMetadata_NON_EMPTY
waE2E.RequestWelcomeMessageMetadata_WelcomeTrigger:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- RequestWelcomeMessageMetadata_CHAT_OPEN
- RequestWelcomeMessageMetadata_COMPANION_PAIRING
waE2E.RootSecretDistributeMessage:
properties:
chatJID:
type: string
type: object
waE2E.ScheduledCallCreationMessage:
properties:
callType:
$ref: '#/definitions/waE2E.ScheduledCallCreationMessage_CallType'
scheduledTimestampMS:
type: integer
title:
type: string
type: object
waE2E.ScheduledCallCreationMessage_CallType:
enum:
- 0
- 1
- 2
format: int32
type: integer
x-enum-varnames:
- ScheduledCallCreationMessage_UNKNOWN
- ScheduledCallCreationMessage_VOICE
- ScheduledCallCreationMessage_VIDEO
waE2E.ScheduledCallEditMessage:
properties:
editType:
$ref: '#/definitions/waE2E.ScheduledCallEditMessage_EditType'
key:
$ref: '#/definitions/waCommon.MessageKey'
type: object
waE2E.ScheduledCallEditMessage_EditType:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- ScheduledCallEditMessage_UNKNOWN
- ScheduledCallEditMessage_CANCEL
waE2E.SecretEncryptedMessage:
properties:
encIV:
items:
type: integer
type: array
encPayload:
items:
type: integer
type: array
remoteKeyID:
type: string
secretEncType:
$ref: '#/definitions/waE2E.SecretEncryptedMessage_SecretEncType'
targetMessageKey:
$ref: '#/definitions/waCommon.MessageKey'
type: object
waE2E.SecretEncryptedMessage_SecretEncType:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
format: int32
type: integer
x-enum-varnames:
- SecretEncryptedMessage_UNKNOWN
- SecretEncryptedMessage_EVENT_EDIT
- SecretEncryptedMessage_MESSAGE_EDIT
- SecretEncryptedMessage_MESSAGE_SCHEDULE
- SecretEncryptedMessage_POLL_EDIT
- SecretEncryptedMessage_POLL_ADD_OPTION
waE2E.SendPaymentMessage:
properties:
background:
$ref: '#/definitions/waE2E.PaymentBackground'
noteMessage:
$ref: '#/definitions/waE2E.Message'
requestMessageKey:
$ref: '#/definitions/waCommon.MessageKey'
transactionData:
type: string
type: object
waE2E.SenderKeyDistributionMessage:
properties:
axolotlSenderKeyDistributionMessage:
items:
type: integer
type: array
groupID:
type: string
type: object
waE2E.SplitPaymentMessage:
properties:
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
createdAtMS:
type: integer
description:
type: string
participants:
items:
$ref: '#/definitions/waE2E.SplitPaymentParticipant'
type: array
requesterJID:
type: string
splitID:
type: string
totalAmount:
$ref: '#/definitions/waE2E.Money'
type: object
waE2E.SplitPaymentParticipant:
properties:
JID:
type: string
amount:
$ref: '#/definitions/waE2E.Money'
status:
$ref: '#/definitions/waE2E.SplitPaymentParticipant_SplitPaymentStatus'
type: object
waE2E.SplitPaymentParticipant_SplitPaymentStatus:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- SplitPaymentParticipant_PENDING
- SplitPaymentParticipant_PAID
waE2E.StatusNotificationMessage:
properties:
originalMessageKey:
$ref: '#/definitions/waCommon.MessageKey'
responseMessageKey:
$ref: '#/definitions/waCommon.MessageKey'
type:
$ref: '#/definitions/waE2E.StatusNotificationMessage_StatusNotificationType'
type: object
waE2E.StatusNotificationMessage_StatusNotificationType:
enum:
- 0
- 1
- 2
- 3
format: int32
type: integer
x-enum-varnames:
- StatusNotificationMessage_UNKNOWN
- StatusNotificationMessage_STATUS_ADD_YOURS
- StatusNotificationMessage_STATUS_RESHARE
- StatusNotificationMessage_STATUS_QUESTION_ANSWER_RESHARE
waE2E.StatusQuestionAnswerMessage:
properties:
key:
$ref: '#/definitions/waCommon.MessageKey'
text:
type: string
type: object
waE2E.StatusQuotedMessage:
properties:
originalStatusID:
$ref: '#/definitions/waCommon.MessageKey'
text:
type: string
thumbnail:
items:
type: integer
type: array
type:
$ref: '#/definitions/waE2E.StatusQuotedMessage_StatusQuotedMessageType'
type: object
waE2E.StatusQuotedMessage_StatusQuotedMessageType:
enum:
- 1
format: int32
type: integer
x-enum-varnames:
- StatusQuotedMessage_QUESTION_ANSWER
waE2E.StatusStickerInteractionMessage:
properties:
key:
$ref: '#/definitions/waCommon.MessageKey'
stickerKey:
type: string
type:
$ref: '#/definitions/waE2E.StatusStickerInteractionMessage_StatusStickerType'
type: object
waE2E.StatusStickerInteractionMessage_StatusStickerType:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- StatusStickerInteractionMessage_UNKNOWN
- StatusStickerInteractionMessage_REACTION
waE2E.StickerMessage:
properties:
URL:
type: string
accessibilityLabel:
type: string
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
directPath:
type: string
emojis:
type: string
fileEncSHA256:
items:
type: integer
type: array
fileLength:
type: integer
fileSHA256:
items:
type: integer
type: array
firstFrameLength:
type: integer
firstFrameSidecar:
items:
type: integer
type: array
height:
type: integer
isAiSticker:
type: boolean
isAnimated:
type: boolean
isAvatar:
type: boolean
isLottie:
type: boolean
mediaKey:
items:
type: integer
type: array
mediaKeyTimestamp:
type: integer
mimetype:
type: string
pngThumbnail:
items:
type: integer
type: array
premium:
type: integer
stickerSentTS:
type: integer
width:
type: integer
type: object
waE2E.StickerPackMessage:
properties:
caption:
type: string
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
directPath:
type: string
fileEncSHA256:
items:
type: integer
type: array
fileLength:
type: integer
fileSHA256:
items:
type: integer
type: array
imageDataHash:
type: string
mediaKey:
items:
type: integer
type: array
mediaKeyTimestamp:
type: integer
name:
type: string
packDescription:
type: string
publisher:
type: string
stickerPackID:
type: string
stickerPackOrigin:
$ref: '#/definitions/waE2E.StickerPackMessage_StickerPackOrigin'
stickerPackSize:
type: integer
stickers:
items:
$ref: '#/definitions/waE2E.StickerPackMessage_Sticker'
type: array
thumbnailDirectPath:
type: string
thumbnailEncSHA256:
items:
type: integer
type: array
thumbnailHeight:
type: integer
thumbnailSHA256:
items:
type: integer
type: array
thumbnailWidth:
type: integer
trayIconFileName:
type: string
type: object
waE2E.StickerPackMessage_Sticker:
properties:
accessibilityLabel:
type: string
emojis:
items:
type: string
type: array
fileName:
type: string
isAnimated:
type: boolean
isLottie:
type: boolean
mimetype:
type: string
premium:
type: integer
type: object
waE2E.StickerPackMessage_StickerPackOrigin:
enum:
- 0
- 1
- 2
format: int32
type: integer
x-enum-varnames:
- StickerPackMessage_FIRST_PARTY
- StickerPackMessage_THIRD_PARTY
- StickerPackMessage_USER_CREATED
waE2E.StickerSyncRMRMessage:
properties:
filehash:
items:
type: string
type: array
requestTimestamp:
type: integer
rmrSource:
type: string
type: object
waE2E.TemplateButtonReplyMessage:
properties:
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
selectedCarouselCardIndex:
type: integer
selectedDisplayText:
type: string
selectedID:
type: string
selectedIndex:
type: integer
type: object
waE2E.TemplateMessage:
properties:
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
format:
description: "Types that are valid to be assigned to Format:\n\n\t*TemplateMessage_FourRowTemplate_\n\t*TemplateMessage_HydratedFourRowTemplate_\n\t*TemplateMessage_InteractiveMessageTemplate"
hydratedTemplate:
$ref: '#/definitions/waE2E.TemplateMessage_HydratedFourRowTemplate'
templateID:
type: string
type: object
waE2E.TemplateMessage_HydratedFourRowTemplate:
properties:
hydratedButtons:
items:
$ref: '#/definitions/waE2E.HydratedTemplateButton'
type: array
hydratedContentText:
type: string
hydratedFooterText:
type: string
maskLinkedDevices:
type: boolean
templateID:
type: string
title:
description: "Types that are valid to be assigned to Title:\n\n\t*TemplateMessage_HydratedFourRowTemplate_DocumentMessage\n\t*TemplateMessage_HydratedFourRowTemplate_HydratedTitleText\n\t*TemplateMessage_HydratedFourRowTemplate_ImageMessage\n\t*TemplateMessage_HydratedFourRowTemplate_VideoMessage\n\t*TemplateMessage_HydratedFourRowTemplate_LocationMessage"
type: object
waE2E.ThreadID:
properties:
threadKey:
$ref: '#/definitions/waCommon.MessageKey'
threadType:
$ref: '#/definitions/waE2E.ThreadID_ThreadType'
type: object
waE2E.ThreadID_ThreadType:
enum:
- 0
- 1
- 2
format: int32
type: integer
x-enum-varnames:
- ThreadID_UNKNOWN
- ThreadID_VIEW_REPLIES
- ThreadID_AI_THREAD
waE2E.URLMetadata:
properties:
fbExperimentID:
type: integer
type: object
waE2E.UrlTrackingMap:
properties:
urlTrackingMapElements:
items:
$ref: '#/definitions/waE2E.UrlTrackingMap_UrlTrackingMapElement'
type: array
type: object
waE2E.UrlTrackingMap_UrlTrackingMapElement:
properties:
cardIndex:
type: integer
consentedUsersURL:
type: string
originalURL:
type: string
unconsentedUsersURL:
type: string
type: object
waE2E.VideoEndCard:
properties:
caption:
type: string
profilePictureURL:
type: string
thumbnailImageURL:
type: string
username:
type: string
type: object
waE2E.VideoMessage:
properties:
JPEGThumbnail:
items:
type: integer
type: array
URL:
type: string
accessibilityLabel:
type: string
annotations:
items:
$ref: '#/definitions/waE2E.InteractiveAnnotation'
type: array
caption:
type: string
contextInfo:
$ref: '#/definitions/waE2E.ContextInfo'
directPath:
type: string
externalShareFullVideoDurationInSeconds:
type: integer
fileEncSHA256:
items:
type: integer
type: array
fileLength:
type: integer
fileSHA256:
items:
type: integer
type: array
gifAttribution:
$ref: '#/definitions/waE2E.VideoMessage_Attribution'
gifPlayback:
type: boolean
height:
type: integer
interactiveAnnotations:
items:
$ref: '#/definitions/waE2E.InteractiveAnnotation'
type: array
mediaKey:
items:
type: integer
type: array
mediaKeyTimestamp:
type: integer
metadataURL:
type: string
mimetype:
type: string
motionPhotoPresentationOffsetMS:
type: integer
processedVideos:
items:
$ref: '#/definitions/waE2E.ProcessedVideo'
type: array
seconds:
type: integer
staticURL:
type: string
streamingSidecar:
items:
type: integer
type: array
thumbnailDirectPath:
type: string
thumbnailEncSHA256:
items:
type: integer
type: array
thumbnailSHA256:
items:
type: integer
type: array
videoSourceType:
$ref: '#/definitions/waE2E.VideoMessage_VideoSourceType'
viewOnce:
type: boolean
width:
type: integer
type: object
waE2E.VideoMessage_Attribution:
enum:
- 0
- 1
- 2
- 3
format: int32
type: integer
x-enum-varnames:
- VideoMessage_NONE
- VideoMessage_GIPHY
- VideoMessage_TENOR
- VideoMessage_KLIPY
waE2E.VideoMessage_VideoSourceType:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- VideoMessage_USER_VIDEO
- VideoMessage_AI_GENERATED
waE2E.WebLinkRenderConfig:
enum:
- 0
- 1
format: int32
type: integer
x-enum-varnames:
- WebLinkRenderConfig_WEBVIEW
- WebLinkRenderConfig_SYSTEM
waMmsRetry.MediaRetryNotification_ResultType:
enum:
- 0
- 1
- 2
- 3
format: int32
type: integer
x-enum-varnames:
- MediaRetryNotification_GENERAL_ERROR
- MediaRetryNotification_SUCCESS
- MediaRetryNotification_NOT_FOUND
- MediaRetryNotification_DECRYPTION_ERROR
waStatusAttributions.StatusAttribution:
properties:
actionURL:
type: string
attributionData:
description: "Types that are valid to be assigned to AttributionData:\n\n\t*StatusAttribution_StatusReshare_\n\t*StatusAttribution_ExternalShare_\n\t*StatusAttribution_Music_\n\t*StatusAttribution_GroupStatus_\n\t*StatusAttribution_RlAttribution\n\t*StatusAttribution_AiCreatedAttribution_"
type:
$ref: '#/definitions/waStatusAttributions.StatusAttribution_Type'
type: object
waStatusAttributions.StatusAttribution_Type:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
format: int32
type: integer
x-enum-varnames:
- StatusAttribution_UNKNOWN
- StatusAttribution_RESHARE
- StatusAttribution_EXTERNAL_SHARE
- StatusAttribution_MUSIC
- StatusAttribution_STATUS_MENTION
- StatusAttribution_GROUP_STATUS
- StatusAttribution_RL_ATTRIBUTION
- StatusAttribution_AI_CREATED
- StatusAttribution_LAYOUTS
- StatusAttribution_NEWSLETTER_STATUS
- StatusAttribution_STATUS_CLOSE_SHARING
waVnameCert.LocalizedName:
properties:
lc:
type: string
lg:
type: string
verifiedName:
type: string
type: object
waVnameCert.VerifiedNameCertificate:
properties:
details:
items:
type: integer
type: array
serverSignature:
items:
type: integer
type: array
signature:
items:
type: integer
type: array
type: object
waVnameCert.VerifiedNameCertificate_Details:
properties:
issueTime:
type: integer
issuer:
type: string
localizedNames:
items:
$ref: '#/definitions/waVnameCert.LocalizedName'
type: array
serial:
type: integer
verifiedName:
type: string
type: object
whatsmeow.ParticipantChange:
enum:
- add
- remove
- promote
- demote
type: string
x-enum-varnames:
- ParticipantChangeAdd
- ParticipantChangeRemove
- ParticipantChangePromote
- ParticipantChangeDemote
info:
contact: {}
description: Evolution GO - whatsmeow
title: Evolution GO
version: "1.0"
paths:
/call/reject:
post:
consumes:
- application/json
description: Reject call
parameters:
- description: Call data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_call_service.RejectCallStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Reject call
tags:
- Call
/chat/archive:
post:
consumes:
- application/json
description: Archive a chat
parameters:
- description: Chat
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_chat_service.BodyStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Archive a chat
tags:
- Chat
/chat/history-sync:
post:
consumes:
- application/json
description: HistorySyncRequest a chat
parameters:
- description: Chat
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_chat_service.HistorySyncRequestStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: HistorySyncRequest a chat
tags:
- Chat
/chat/mute:
post:
consumes:
- application/json
description: Mute a chat
parameters:
- description: Chat
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_chat_service.BodyStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Mute a chat
tags:
- Chat
/chat/pin:
post:
consumes:
- application/json
description: Pin a chat
parameters:
- description: Chat
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_chat_service.BodyStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Pin a chat
tags:
- Chat
/chat/unarchive:
post:
consumes:
- application/json
description: Unarchive a chat
parameters:
- description: Chat
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_chat_service.BodyStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Unarchive a chat
tags:
- Chat
/chat/unmute:
post:
consumes:
- application/json
description: Unmute a chat
parameters:
- description: Chat
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_chat_service.BodyStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Unmute a chat
tags:
- Chat
/chat/unpin:
post:
consumes:
- application/json
description: Unpin a chat
parameters:
- description: Chat
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_chat_service.BodyStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Unpin a chat
tags:
- Chat
/community/add:
post:
consumes:
- application/json
description: Add participant to community
parameters:
- description: Participant data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_community_service.AddParticipantStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Add participant to community
tags:
- Community
/community/create:
post:
consumes:
- application/json
description: Create community
parameters:
- description: Community data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_community_service.CreateCommunityStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Create community
tags:
- Community
/community/remove:
post:
consumes:
- application/json
description: Remove participant from community
parameters:
- description: Participant data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_community_service.AddParticipantStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Remove participant from community
tags:
- Community
/group/create:
post:
consumes:
- application/json
description: Create group
parameters:
- description: Group data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_group_service.CreateGroupStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Create group
tags:
- Group
/group/description:
post:
consumes:
- application/json
description: Set group description
parameters:
- description: Group data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_group_service.SetGroupDescriptionStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Set group description
tags:
- Group
/group/info:
post:
consumes:
- application/json
description: Get group info
parameters:
- description: Group data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_group_service.GetGroupInfoStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Get group info
tags:
- Group
/group/invitelink:
post:
consumes:
- application/json
description: Get group invite link
parameters:
- description: Group data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_group_service.GetGroupInviteLinkStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Get group invite link
tags:
- Group
/group/join:
post:
consumes:
- application/json
description: Join group link
parameters:
- description: Group data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_group_service.JoinGroupStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Join group link
tags:
- Group
/group/leave:
post:
consumes:
- application/json
description: Leave group
parameters:
- description: Group data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_group_service.LeaveGroupStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Leave group
tags:
- Group
/group/list:
get:
consumes:
- application/json
description: List groups
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: List groups
tags:
- Group
/group/myall:
get:
consumes:
- application/json
description: Get my groups
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Get my groups
tags:
- Group
/group/name:
post:
consumes:
- application/json
description: Set group name
parameters:
- description: Group data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_group_service.SetGroupNameStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Set group name
tags:
- Group
/group/participant:
post:
consumes:
- application/json
description: Update participant
parameters:
- description: Group data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_group_service.AddParticipantStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Update participant
tags:
- Group
/group/photo:
post:
consumes:
- application/json
description: Set group photo
parameters:
- description: Group data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_group_service.SetGroupPhotoStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Set group photo
tags:
- Group
/group/settings:
post:
consumes:
- application/json
description: Update group settings (announcement, not_announcement, locked,
unlocked, approval_on, approval_off, admin_add, all_member_add)
parameters:
- description: Group data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_group_service.UpdateGroupSettingsStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Update group settings
tags:
- Group
/instance/{instanceId}/advanced-settings:
get:
description: Get advanced settings for a specific instance
parameters:
- description: Instance ID
in: path
name: instanceId
required: true
type: string
produces:
- application/json
responses:
"200":
description: Advanced settings retrieved successfully
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_instance_model.AdvancedSettings'
"400":
description: Invalid instance ID
schema:
$ref: '#/definitions/gin.H'
"404":
description: Instance not found
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Get advanced settings
tags:
- Instance
put:
consumes:
- application/json
description: Update advanced settings for a specific instance
parameters:
- description: Instance ID
in: path
name: instanceId
required: true
type: string
- description: Advanced settings data
in: body
name: settings
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_instance_model.AdvancedSettings'
produces:
- application/json
responses:
"200":
description: Advanced settings updated successfully
schema:
$ref: '#/definitions/gin.H'
"400":
description: Invalid request data
schema:
$ref: '#/definitions/gin.H'
"404":
description: Instance not found
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Update advanced settings
tags:
- Instance
/instance/all:
get:
consumes:
- application/json
description: Get all instances
produces:
- application/json
responses:
"200":
description: All instances
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Get all instances
tags:
- Instance
/instance/connect:
post:
consumes:
- application/json
description: Connect to instance with the provided data
parameters:
- description: Instance data
in: body
name: instance
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_instance_service.ConnectStruct'
produces:
- application/json
responses:
"200":
description: Instance connected successfully
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Connect to instance
tags:
- Instance
/instance/create:
post:
consumes:
- application/json
description: Creates a new instance with the provided data including optional
advanced settings
parameters:
- description: Instance data with optional advanced settings
in: body
name: instance
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_instance_service.CreateStruct'
produces:
- application/json
responses:
"200":
description: Instance created successfully
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Create a new instance
tags:
- Instance
/instance/delete/{instanceId}:
delete:
consumes:
- application/json
description: Delete instance
parameters:
- description: Instance Id
in: path
name: instanceId
required: true
type: string
produces:
- application/json
responses:
"200":
description: Instance deleted successfully
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Delete instance
tags:
- Instance
/instance/disconnect:
post:
consumes:
- application/json
description: Disconnect from instance
produces:
- application/json
responses:
"200":
description: Instance disconnected successfully
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Disconnect from instance
tags:
- Instance
/instance/forcereconnect/{instanceId}:
post:
consumes:
- application/json
description: Force reconnect
parameters:
- description: Instance Id
in: path
name: instanceId
required: true
type: string
- description: Instance data
in: body
name: instance
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_instance_service.ForceReconnectStruct'
produces:
- application/json
responses:
"200":
description: Instance force reconnected successfully
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Force reconnect
tags:
- Instance
/instance/info/{instanceId}:
get:
consumes:
- application/json
description: Get instance
parameters:
- description: Instance Id
in: path
name: instanceId
required: true
type: string
produces:
- application/json
responses:
"200":
description: Instance
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Get instance
tags:
- Instance
/instance/logout:
delete:
consumes:
- application/json
description: Logout from instance
produces:
- application/json
responses:
"200":
description: Instance logged out successfully
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Logout from instance
tags:
- Instance
/instance/logs/{instanceId}:
get:
description: Returns log entries for an instance, filterable by date range,
level and limit
parameters:
- description: Instance Id
in: path
name: instanceId
required: true
type: string
- description: Start date (YYYY-MM-DD, defaults to 7 days ago)
in: query
name: start_date
type: string
- description: End date (YYYY-MM-DD, defaults to now)
in: query
name: end_date
type: string
- description: Log level filter
in: query
name: level
type: string
- description: Max number of entries
in: query
name: limit
type: integer
produces:
- application/json
responses:
"200":
description: Logs
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Get instance logs
tags:
- Instance
/instance/pair:
post:
consumes:
- application/json
description: Request pairing code
parameters:
- description: Instance data
in: body
name: instance
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_instance_service.PairStruct'
produces:
- application/json
responses:
"200":
description: Pairing code
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Request pairing code
tags:
- Instance
/instance/proxy/{instanceId}:
delete:
consumes:
- application/json
description: Delete proxy
parameters:
- description: Instance id
in: path
name: instanceId
required: true
type: string
produces:
- application/json
responses:
"200":
description: Proxy deleted successfully
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Delete proxy
tags:
- Instance
post:
consumes:
- application/json
description: Set proxy configuration for an instance
parameters:
- description: Instance id
in: path
name: instanceId
required: true
type: string
- description: Proxy configuration
in: body
name: proxy
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_instance_service.SetProxyStruct'
produces:
- application/json
responses:
"200":
description: Proxy set successfully
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Set proxy configuration
tags:
- Instance
/instance/qr:
get:
consumes:
- application/json
description: Get instance QR code
produces:
- application/json
responses:
"200":
description: Instance QR code
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Get instance QR code
tags:
- Instance
/instance/reconnect:
post:
consumes:
- application/json
description: Reconnect to instance
produces:
- application/json
responses:
"200":
description: Instance reconnected successfully
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Reconnect to instance
tags:
- Instance
/instance/status:
get:
consumes:
- application/json
description: Get instance status
produces:
- application/json
responses:
"200":
description: Instance status
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Get instance status
tags:
- Instance
/label/chat:
post:
consumes:
- application/json
description: Add label to chat
parameters:
- description: Label data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_label_service.ChatLabelStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Add label to chat
tags:
- Label
/label/edit:
post:
consumes:
- application/json
description: Edit label
parameters:
- description: Label data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_label_service.EditLabelStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Edit label
tags:
- Label
/label/list:
get:
consumes:
- application/json
description: Get all labels
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Get all labels
tags:
- Label
/label/message:
post:
consumes:
- application/json
description: Add label to message
parameters:
- description: Label data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_label_service.MessageLabelStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Add label to message
tags:
- Label
/license/activate:
get:
description: Exchanges an authorization code (from the registration callback)
for an api_key and persists it. Provide the code via the query string.
parameters:
- description: Authorization code from the registration callback
in: query
name: code
required: true
type: string
produces:
- application/json
responses:
"200":
description: Activation result
schema:
$ref: '#/definitions/gin.H'
"400":
description: Missing code parameter
schema:
$ref: '#/definitions/gin.H'
summary: Activate license
tags:
- License
/license/register:
get:
description: Checks the GLOBAL_API_KEY with the licensing server. If not yet
registered, initiates registration and returns a register_url. Accepts an
optional redirect_uri for the post-registration redirect.
parameters:
- description: Post-registration redirect URI
in: query
name: redirect_uri
type: string
produces:
- application/json
responses:
"200":
description: Registration state (status/message or register_url)
schema:
$ref: '#/definitions/gin.H'
summary: Register / get registration URL
tags:
- License
/license/status:
get:
description: Returns whether the instance license is active, along with the
instance id and a masked api key.
produces:
- application/json
responses:
"200":
description: License status ({status, instance_id, api_key?})
schema:
$ref: '#/definitions/gin.H'
summary: Get license status
tags:
- License
/message/delete:
post:
consumes:
- application/json
description: Delete a message for everyone
parameters:
- description: Delete a message for everyone
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_message_service.MessageStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Delete a message for everyone
tags:
- Message
/message/downloadmedia:
post:
consumes:
- application/json
description: Download the media content of a message (image, video, audio or
document)
parameters:
- description: Download media
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_message_service.DownloadMediaStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Download media
tags:
- Message
/message/edit:
post:
consumes:
- application/json
description: Edit a message
parameters:
- description: Edit a message
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_message_service.EditMessageStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Edit a message
tags:
- Message
/message/markplayed:
post:
consumes:
- application/json
description: Mark an audio message as played
parameters:
- description: Mark an audio message as played
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_message_service.MarkPlayedStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Mark an audio message as played
tags:
- Message
/message/markread:
post:
consumes:
- application/json
description: Mark a message as read
parameters:
- description: Mark a message as read
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_message_service.MarkReadStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Mark a message as read
tags:
- Message
/message/presence:
post:
consumes:
- application/json
description: Set chat presence
parameters:
- description: Set chat presence
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_message_service.ChatPresenceStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Set chat presence
tags:
- Message
/message/react:
post:
consumes:
- application/json
description: React to a message with support for fromMe field and participant
field for group messages
parameters:
- description: React to a message with fromMe and participant fields
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_message_service.ReactStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: React a message
tags:
- Message
/message/status:
post:
consumes:
- application/json
description: Get message status
parameters:
- description: Get message status
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_message_service.MessageStatusStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Get message status
tags:
- Message
/newsletter/create:
post:
consumes:
- application/json
description: Create newsletter
parameters:
- description: Newsletter data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_newsletter_service.CreateNewsletterStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Create newsletter
tags:
- Newsletter
/newsletter/info:
post:
consumes:
- application/json
description: Get newsletter
parameters:
- description: Newsletter data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_newsletter_service.GetNewsletterStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Get newsletter
tags:
- Newsletter
/newsletter/link:
post:
consumes:
- application/json
description: Get newsletter invite
parameters:
- description: Newsletter data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_newsletter_service.GetNewsletterInviteStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Get newsletter invite
tags:
- Newsletter
/newsletter/list:
get:
consumes:
- application/json
description: List newsletters
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: List newsletters
tags:
- Newsletter
/newsletter/messages:
post:
consumes:
- application/json
description: Get newsletter messages
parameters:
- description: Newsletter data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_newsletter_service.GetNewsletterMessagesStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Get newsletter messages
tags:
- Newsletter
/newsletter/subscribe:
post:
consumes:
- application/json
description: Subscribe newsletter
parameters:
- description: Newsletter data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_newsletter_service.GetNewsletterStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Subscribe newsletter
tags:
- Newsletter
/passkey-ceremony/{token}:
get:
description: Returns the current WebAuthn passkey-pairing ceremony state for
a token. PUBLIC endpoint (no apikey) — access is gated by the opaque short-lived
ceremony token. Polled by the Evolution Passkey Helper browser extension.
parameters:
- description: Ceremony token
in: path
name: token
required: true
type: string
produces:
- application/json
responses:
"200":
description: Ceremony state ({stage, skipHandoffUX, publicKey?, code?, error?})
schema:
$ref: '#/definitions/gin.H'
"400":
description: token is required
schema:
$ref: '#/definitions/gin.H'
"404":
description: ceremony not found or expired
schema:
$ref: '#/definitions/gin.H'
"503":
description: passkey ceremony unavailable
schema:
$ref: '#/definitions/gin.H'
summary: Get passkey ceremony state
tags:
- Passkey
/passkey-ceremony/{token}/confirm:
post:
description: Finishes the passkey pairing after the user verified the confirmation
code. PUBLIC endpoint (no apikey) — gated by the ceremony token.
parameters:
- description: Ceremony token
in: path
name: token
required: true
type: string
produces:
- application/json
responses:
"200":
description: ok
schema:
$ref: '#/definitions/gin.H'
"400":
description: token is required
schema:
$ref: '#/definitions/gin.H'
"404":
description: ceremony not found or expired
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
"503":
description: passkey ceremony unavailable
schema:
$ref: '#/definitions/gin.H'
summary: Confirm passkey pairing
tags:
- Passkey
/passkey-ceremony/{token}/response:
post:
consumes:
- application/json
description: Receives the WebAuthn assertion produced by the browser extension
and forwards it to WhatsApp. PUBLIC endpoint (no apikey) — gated by the ceremony
token. Body is the WebAuthnResponse shape (id, rawId, type, response{clientDataJSON,
authenticatorData, signature, userHandle?}), base64url-unpadded.
parameters:
- description: Ceremony token
in: path
name: token
required: true
type: string
- description: WebAuthn assertion
in: body
name: response
required: true
schema:
$ref: '#/definitions/types.WebAuthnResponse'
produces:
- application/json
responses:
"200":
description: ok
schema:
$ref: '#/definitions/gin.H'
"400":
description: token is required / invalid body
schema:
$ref: '#/definitions/gin.H'
"404":
description: ceremony not found or expired
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
"503":
description: passkey ceremony unavailable
schema:
$ref: '#/definitions/gin.H'
summary: Submit passkey WebAuthn response
tags:
- Passkey
/polls/{pollMessageId}/results:
get:
consumes:
- application/json
description: Retorna todos os votos de uma enquete específica
parameters:
- description: ID da mensagem da enquete
in: path
name: pollMessageId
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_poll_model.PollResults'
"400":
description: Bad Request
schema:
$ref: '#/definitions/gin.H'
"404":
description: Not Found
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/gin.H'
summary: Get poll results
tags:
- Polls
/send/button:
post:
consumes:
- application/json
description: |-
Send an interactive message with buttons. Each button has a `type`: `reply`, `copy`, `url`, `call` or `pix`.
Combination rules enforced by the server:
- Up to 3 `reply` buttons per message.
- `reply` buttons cannot be mixed with any other type.
- `pix` button must be sent ALONE (no other button in the same message).
WhatsApp client rendering quirks (NOT enforced by the server, but verified in the field):
- WhatsApp Web: only `reply`-only messages (up to 3) OR CTAs grouped together (`copy` + `url` + `call`) render correctly.
- Do NOT mix `reply` with CTA buttons (`copy`/`url`/`call`) — the message will not appear on WhatsApp Web.
Required body fields: `number`, `title`, `description`, `footer`, `buttons`.
parameters:
- description: Message data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.ButtonStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Send a button message
tags:
- Send Message
/send/carousel:
post:
consumes:
- application/json
description: |-
Send an interactive carousel (multiple swipeable cards). Each card carries its own image or video, body and optional buttons.
Card button `type` accepted values (case-insensitive, uppercased internally): `REPLY` (default), `URL`, `CALL`, `COPY`.
The `PIX` button type is NOT supported in carousel cards — use `/send/button` for PIX.
IMPORTANT — `CarouselButtonStruct` is different from the flat button used in `/send/button`:
- URL button: put the link in the `id` field (NOT in a `url` field).
- CALL button: put the phone number in the `id` field (NOT in a `phoneNumber` field).
- COPY button: put the code to be copied in `copyCode`.
- REPLY button: put the payload/callback ID in `id`.
Per-card combination rules (NOT enforced by the server, but verified in the field):
- Same WhatsApp Web quirk as `/send/button`: avoid mixing REPLY with CTA buttons (URL/CALL/COPY) in the same card — mixed sets do not render on Web.
- Stick to either "only REPLY" or "only CTAs grouped together" per card.
Required body fields: `number`, `cards` (at least one). Each card requires `header` + `body`.
parameters:
- description: Message data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.CarouselStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Send a carousel message
tags:
- Send Message
/send/contact:
post:
consumes:
- application/json
description: Send a contact message
parameters:
- description: Message data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.ContactStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Send a contact message
tags:
- Send Message
/send/link:
post:
consumes:
- application/json
description: Send a link message
parameters:
- description: Message data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.LinkStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Send a link message
tags:
- Send Message
/send/list:
post:
consumes:
- application/json
description: |-
Send an interactive list message (single-select) rendered as a tappable menu.
Required body fields: `number`, `title`, `description`, `footerText`, `buttonText`, `sections`.
Each section must contain one or more `rows`. When `rowId` is omitted, the server generates a fallback ID.
When `buttonText` is empty, the server falls back to "Ver Menu".
Uses legacy `ListMessage` format (no ViewOnceMessage wrapper) so it renders on iOS, Android and WhatsApp Web.
parameters:
- description: Message data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.ListStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Send a list message
tags:
- Send Message
/send/location:
post:
consumes:
- application/json
description: Send a location message
parameters:
- description: Message data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.LocationStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Send a location message
tags:
- Send Message
/send/media:
post:
consumes:
- application/json
description: Send a media message
parameters:
- description: Message data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.MediaStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Send a media message
tags:
- Send Message
/send/poll:
post:
consumes:
- application/json
description: Send a poll message
parameters:
- description: Message data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.PollStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Send a poll message
tags:
- Send Message
/send/status/media:
post:
consumes:
- application/json
- ' multipart/form-data'
description: Send an image or video status to status@broadcast. Supports JSON
(URL) or multipart/form-data (file upload)
parameters:
- description: 'Media type: image or video'
in: formData
name: type
required: true
type: string
- description: Media file (for multipart upload)
in: formData
name: file
type: file
- description: Media URL (for JSON upload)
in: formData
name: url
type: string
- description: Caption for the media
in: formData
name: caption
type: string
- description: Custom message ID
in: formData
name: id
type: string
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Send a WhatsApp media status (image/video)
tags:
- Send Message
/send/status/text:
post:
consumes:
- application/json
description: Send a WhatsApp text status to status@broadcast
parameters:
- description: Status text data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.StatusTextStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Send a WhatsApp text status
tags:
- Send Message
/send/sticker:
post:
consumes:
- application/json
description: Send a sticker message
parameters:
- description: Message data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.StickerStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Send a sticker message
tags:
- Send Message
/send/text:
post:
consumes:
- application/json
description: Send a text message
parameters:
- description: Message data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_sendMessage_service.TextStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Send a text message
tags:
- Send Message
/unlabel/chat:
post:
consumes:
- application/json
description: Remove label from chat
parameters:
- description: Label data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_label_service.ChatLabelStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Remove label from chat
tags:
- Label
/unlabel/message:
post:
consumes:
- application/json
description: Remove label from message
parameters:
- description: Label data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_label_service.MessageLabelStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Remove label from message
tags:
- Label
/user/avatar:
post:
consumes:
- application/json
description: Get a user's avatar
parameters:
- description: Avatar data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_user_service.GetAvatarStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Get a user's avatar
tags:
- User
/user/block:
post:
consumes:
- application/json
description: Block a contact
parameters:
- description: Block data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_user_service.BlockStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Block a contact
tags:
- User
/user/blocklist:
get:
consumes:
- application/json
description: Get a user's block list
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Get a user's block list
tags:
- User
/user/check:
post:
consumes:
- application/json
description: Check a user
parameters:
- description: User data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_user_service.CheckUserStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Check a user
tags:
- User
/user/contacts:
get:
consumes:
- application/json
description: Get a user's contacts
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Get a user's contacts
tags:
- User
/user/info:
post:
consumes:
- application/json
description: Get a user
parameters:
- description: User data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_user_service.CheckUserStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Get a user
tags:
- User
/user/privacy:
get:
consumes:
- application/json
description: Get a user's privacy settings
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Get a user's privacy settings
tags:
- User
post:
consumes:
- application/json
description: Set a user's privacy settings
parameters:
- description: Privacy data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_user_service.PrivacyStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Set a user's privacy settings
tags:
- User
/user/profileName:
post:
consumes:
- application/json
description: Set a user's profile name
parameters:
- description: Profile name data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_user_service.SetProfilePictureStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Set a user's profile name
tags:
- User
/user/profilePicture:
post:
consumes:
- application/json
description: Set a user's profile picture
parameters:
- description: Profile picture data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_user_service.SetProfilePictureStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Set a user's profile picture
tags:
- User
/user/profileStatus:
post:
consumes:
- application/json
description: Set a user's profile status
parameters:
- description: Profile status data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_user_service.SetProfilePictureStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Set a user's profile status
tags:
- User
/user/unblock:
post:
consumes:
- application/json
description: Unblock a contact
parameters:
- description: Block data
in: body
name: message
required: true
schema:
$ref: '#/definitions/github_com_EvolutionAPI_evolution-go_pkg_user_service.BlockStruct'
produces:
- application/json
responses:
"200":
description: success
schema:
$ref: '#/definitions/gin.H'
"400":
description: Error on validation
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal server error
schema:
$ref: '#/definitions/gin.H'
summary: Unblock a contact
tags:
- User
swagger: "2.0"