BlockContact
| Campo | Tipo | Obrigatório |
|---|---|---|
Phone | string | Não |
BotMessage
| Campo | Tipo | Obrigatório |
|---|---|---|
Body | string | Não |
PersonaID | string | Não |
BroadcastListParticipants
| Campo | Tipo | Obrigatório |
|---|---|---|
ID | string | Sim |
BusinessAddressUpdate
| Campo | Tipo | Obrigatório |
|---|---|---|
Address | string | Não |
BusinessCatalogCreate
| Campo | Tipo | Obrigatório |
|---|---|---|
Id | string | Não |
Name | string | Não |
Images | array<string> | Não |
Description | string | Não |
Price | string | Não |
Currency | string | Não |
Url | string | Não |
IsHidden | boolean | Não |
BusinessCatalogDelete
| Campo | Tipo | Obrigatório |
|---|---|---|
Id | string | Não |
BusinessCatalogHide
| Campo | Tipo | Obrigatório |
|---|---|---|
Id | string | Não |
BusinessCatalogInfo
| Campo | Tipo | Obrigatório |
|---|---|---|
Jid | string | Não |
Id | string | Não |
BusinessCatalogList
| Campo | Tipo | Obrigatório |
|---|---|---|
Jid | string | Não |
BusinessCatalogMessage
| Campo | Tipo | Obrigatório |
|---|---|---|
Phone | string | Sim |
Text | string | Sim |
MatchedText | string | Sim |
Title | string | Sim |
BusinessCatalogShow
| Campo | Tipo | Obrigatório |
|---|---|---|
Id | string | Não |
BusinessDescUpdate
| Campo | Tipo | Obrigatório |
|---|---|---|
Desc | string | Não |
BusinessEmailUpdate
| Campo | Tipo | Obrigatório |
|---|---|---|
Email | string | Não |
BusinessOrderDetails
| Campo | Tipo | Obrigatório |
|---|---|---|
OrderId | string | Sim |
Token | string | Sim |
BusinessProfile
| Campo | Tipo | Obrigatório |
|---|---|---|
Jid | string | Não |
CallMake
| Campo | Tipo | Obrigatório |
|---|---|---|
CallTo | string | Não |
CallReject
| Campo | Tipo | Obrigatório |
|---|---|---|
CallFrom | string | Não |
CallID | string | Não |
ChatArchive
| Campo | Tipo | Obrigatório |
|---|---|---|
Chat | string | Sim |
ChatDelete
| Campo | Tipo | Obrigatório |
|---|---|---|
Phone | string | Sim |
ChatMute
| Campo | Tipo | Obrigatório |
|---|---|---|
Chat | string | Sim |
ChatPin
| Campo | Tipo | Obrigatório |
|---|---|---|
Chat | string | Sim |
ChatPresence
| Campo | Tipo | Obrigatório |
|---|---|---|
Phone | string | Sim |
State | string | Sim |
Media | string | Não |
ChatPresenceBody
| Campo | Tipo | Obrigatório |
|---|---|---|
Jid | string | Sim |
ChatTypingStart
| Campo | Tipo | Obrigatório |
|---|---|---|
Jid | string | Sim |
ChatTypingStop
| Campo | Tipo | Obrigatório |
|---|---|---|
Jid | string | Sim |
Checkavatar
| Campo | Tipo | Obrigatório |
|---|---|---|
Phone | string | Sim |
Preview | bool | Sim |
Checkuser
| Campo | Tipo | Obrigatório |
|---|---|---|
Phone | object | Sim |
CommunityAdd
| Campo | Tipo | Obrigatório |
|---|---|---|
CommunityJID | string | Não |
GroupJID | Array | Não |
CommunityCreate
| Campo | Tipo | Obrigatório |
|---|---|---|
CommunityName | string | Não |
CommunityRemove
| Campo | Tipo | Obrigatório |
|---|---|---|
CommunityJID | string | Não |
GroupJID | Array | Não |
Connect
| Campo | Tipo | Obrigatório |
|---|---|---|
Subscribe | string | Não |
Immediate | boolean | Não |
ContactAdd
| Campo | Tipo | Obrigatório |
|---|---|---|
Phone | string | Não |
FirstName | string | Não |
FullName | string | Não |
SaveOnBook | boolean | Não |
ContactRemove
| Campo | Tipo | Obrigatório |
|---|---|---|
Phone | string | Não |
DownloadMessageBody
| Campo | Tipo | Obrigatório |
|---|---|---|
Url | string | Sim |
DirectPath | string | Não |
MediaKey | string | Sim |
Mimetype | string | Sim |
FileEncSHA256 | string | Não |
FileSHA256 | string | Sim |
FileLength | number | Sim |
GroupAdminOnly
| Campo | Tipo | Obrigatório |
|---|---|---|
GroupJID | string | Não |
AdminOnly | boolean | Não |
GroupCreate
| Campo | Tipo | Obrigatório |
|---|---|---|
GroupName | string | Não |
Participants | array<any> | Não |
GroupInfo
| Campo | Tipo | Obrigatório |
|---|---|---|
GroupJID | string | Não |
GroupInviteLink
| Campo | Tipo | Obrigatório |
|---|---|---|
GroupJID | string | Não |
Reset | boolean | Não |
GroupJoin
| Campo | Tipo | Obrigatório |
|---|---|---|
Code | string | Não |
GroupLeave
| Campo | Tipo | Obrigatório |
|---|---|---|
GroupId | string | Sim |
GroupLock
| Campo | Tipo | Obrigatório |
|---|---|---|
GroupJID | string | Não |
Lock | boolean | Não |
GroupName
| Campo | Tipo | Obrigatório |
|---|---|---|
GroupJID | string | Não |
Name | string | Não |
GroupPhoto
| Campo | Tipo | Obrigatório |
|---|---|---|
GroupJID | string | Não |
Image | string | Não |
GroupUpdate
| Campo | Tipo | Obrigatório |
|---|---|---|
GroupJID | string | Não |
ParticipantJID | array<any> | Não |
Action | string | Não |
GroupUpdateDescription
| Campo | Tipo | Obrigatório |
|---|---|---|
GroupJID | string | Não |
Description | string | Não |
InitUser
| Campo | Tipo | Obrigatório |
|---|---|---|
Name | string | Não |
Token | string | Não |
Os | string | Não |
LabelChat
| Campo | Tipo | Obrigatório |
|---|---|---|
Jid | string | Não |
LabelId | string | Não |
LabelEdit
| Campo | Tipo | Obrigatório |
|---|---|---|
LabelId | string | Não |
Name | string | Não |
Color | number | Não |
Action | boolean | Não |
LabelMessage
| Campo | Tipo | Obrigatório |
|---|---|---|
Jid | string | Não |
LabelId | string | Não |
MessageId | string | Não |
Markread
| Campo | Tipo | Obrigatório |
|---|---|---|
Id | object | Sim |
Chat | string | Sim |
Sender | string | Não |
MessageAudio
| Campo | Tipo | Obrigatório |
|---|---|---|
Phone | string | Sim |
Audio | string | Sim |
Ptt | boolean | Não |
Duration | number | Não |
Id | string | Não |
ContextInfo | object | Não |
MessageButtons
| Campo | Tipo | Obrigatório |
|---|---|---|
Phone | string | Sim |
Title | string | Sim |
Content | string | Sim |
Footer | string | Sim |
Buttons | object | Sim |
MessageCarouselButton
Nenhum corpo JSON é necessário.
MessageCarouselButtonMedia
Nenhum corpo JSON é necessário.
MessageContact
| Campo | Tipo | Obrigatório |
|---|---|---|
Phone | string | Sim |
Id | string | Não |
Vcard | object | Sim |
ContextInfo | object | Não |
MessageDelete
| Campo | Tipo | Obrigatório |
|---|---|---|
Chat | string | Sim |
MessageID | string | Sim |
MessageDocument
| Campo | Tipo | Obrigatório |
|---|---|---|
Phone | string | Sim |
Document | string | Sim |
FileName | string | Sim |
Caption | string | Não |
Mimetype | string | Não |
Id | string | Não |
ContextInfo | object | Não |
MessageEdit
| Campo | Tipo | Obrigatório |
|---|---|---|
Chat | string | Sim |
Message | string | Sim |
MessageID | string | Sim |
MessageFlow
| Campo | Tipo | Obrigatório |
|---|---|---|
Phone | string | Sim |
Body | string | Sim |
FlowName | string | Sim |
MessageImage
| Campo | Tipo | Obrigatório |
|---|---|---|
Phone | string | Sim |
Image | string | Sim |
Caption | string | Não |
Id | string | Não |
ContextInfo | object | Não |
MessageInvite
| Campo | Tipo | Obrigatório |
|---|---|---|
Phone | string | Sim |
Text | string | Sim |
MatchedText | string | Sim |
Title | string | Sim |
MessageLinkPreview
| Campo | Tipo | Obrigatório |
|---|---|---|
Phone | string | Sim |
Text | string | Sim |
MatchedURL | string | Sim |
Title | string | Sim |
Description | string | Sim |
Image | string | Sim |
MessageList
| Campo | Tipo | Obrigatório |
|---|---|---|
Phone | string | Sim |
ButtonText | string | Sim |
Desc | string | Sim |
TopText | string | Sim |
List | object | Sim |
MessageLocation
| Campo | Tipo | Obrigatório |
|---|---|---|
Phone | string | Sim |
Name | string | Não |
Id | string | Não |
Latitude | float | Sim |
Longitude | float | Sim |
ContextInfo | object | Não |
MessageLocationButton
| Campo | Tipo | Obrigatório |
|---|---|---|
Phone | string | Não |
Body | string | Não |
MessageMediaButtons
| Campo | Tipo | Obrigatório |
|---|---|---|
Phone | string | Sim |
Content | string | Sim |
Footer | string | Não |
Title | string | Não |
Filename | string | Não |
MessageId | string | Não |
Buttons | array<object> | Sim |
Type | string | Sim |
Media | string | Sim |
MessageMediaUrl
| Campo | Tipo | Obrigatório |
|---|---|---|
Jid | string | Sim |
Url | string | Sim |
Type | string | Sim |
Duration | number | Não |
Caption | string | Sim |
Filename | string | Sim |
MessagePixButton
| Campo | Tipo | Obrigatório |
|---|---|---|
Phone | string | Sim |
Title | string | Não |
Body | string | Sim |
Footer | string | Não |
PixKey | string | Sim |
MerchantName | string | Não |
PixType | string | Não |
MessagePoll
| Campo | Tipo | Obrigatório |
|---|---|---|
Phone | string | Sim |
Question | string | Sim |
MaxAnswer | number | Sim |
Options | array<any> | Sim |
ContextInfo | object | Não |
MessageReviewPay
| Campo | Tipo | Obrigatório |
|---|---|---|
Phone | string | Sim |
Title | string | Não |
Body | string | Sim |
Caption | string | Não |
Footer | string | Não |
PixKey | string | Sim |
MerchantName | string | Não |
PixType | string | Não |
Currency | string | Não |
ReferenceID | string | Não |
TotalValue | integer | Não |
TotalOffset | integer | Não |
Items | array<object> | Não |
MessageStatus
| Campo | Tipo | Obrigatório |
|---|---|---|
Id | string | Sim |
MessageSticker
| Campo | Tipo | Obrigatório |
|---|---|---|
Phone | string | Sim |
Sticker | string | Sim |
Id | string | Não |
PngThumbnail | string | Não |
ContextInfo | object | Não |
MessageTemplate
| Campo | Tipo | Obrigatório |
|---|---|---|
Phone | string | Sim |
Title | string | Não |
Content | string | Sim |
Footer | string | Não |
Buttons | object | Não |
MessageText
| Campo | Tipo | Obrigatório |
|---|---|---|
Phone | string | Sim |
Body | string | Sim |
Id | string | Não |
ContextInfo | object | Não |
MessageVideo
| Campo | Tipo | Obrigatório |
|---|---|---|
Phone | string | Sim |
Video | string | Sim |
Caption | string | Não |
Id | string | Não |
JpegThumbnail | string | Não |
ContextInfo | object | Não |
NewsletterCreate
| Campo | Tipo | Obrigatório |
|---|---|---|
Name | string | Não |
Description | string | Não |
NewsletterInfo
| Campo | Tipo | Obrigatório |
|---|---|---|
Jid | string | Não |
NewsletterLink
| Campo | Tipo | Obrigatório |
|---|---|---|
Key | string | Não |
NewsletterMessages
| Campo | Tipo | Obrigatório |
|---|---|---|
Jid | string | Não |
Count | number | Não |
BeforeId | number | Não |
NewsletterSubscribe
| Campo | Tipo | Obrigatório |
|---|---|---|
Jid | string | Não |
Pair
| Campo | Tipo | Obrigatório |
|---|---|---|
Phone | string | Não |
ParseLID
| Campo | Tipo | Obrigatório |
|---|---|---|
LID | string | Não |
ProfilePicture
| Campo | Tipo | Obrigatório |
|---|---|---|
Image | string | Sim |
ReactionText
| Campo | Tipo | Obrigatório |
|---|---|---|
Phone | string | Sim |
Body | string | Sim |
Id | string | Sim |
IsFromMe | boolean | Sim |
StatusImage
| Campo | Tipo | Obrigatório |
|---|---|---|
Image | string | Não |
Caption | string | Não |
StatusText
| Campo | Tipo | Obrigatório |
|---|---|---|
Text | string | Não |
TextColor | number | Não |
BackgroundColor | number | Não |
Font | number | Não |
TextMessage
| Campo | Tipo | Obrigatório |
|---|---|---|
sessionId | string | Sim |
text | string | Sim |
UpdatePresence
| Campo | Tipo | Obrigatório |
|---|---|---|
Presence | string | Não |
UpdateProfileName
| Campo | Tipo | Obrigatório |
|---|---|---|
Name | string | Não |
Webhook
| Campo | Tipo | Obrigatório |
|---|---|---|
WebhookURL | string | Sim |

