Pular para o conteúdo principal
Esta página é uma referência de nomes de campos. Utilize as páginas de funcionalidades e a Referência completa de endpoints para comportamento, exemplos e solução de problemas.

BlockContact

CampoTipoObrigatório
PhonestringNão

BotMessage

CampoTipoObrigatório
BodystringNão
PersonaIDstringNão

BroadcastListParticipants

CampoTipoObrigatório
IDstringSim

BusinessAddressUpdate

CampoTipoObrigatório
AddressstringNão

BusinessCatalogCreate

CampoTipoObrigatório
IdstringNão
NamestringNão
Imagesarray<string>Não
DescriptionstringNão
PricestringNão
CurrencystringNão
UrlstringNão
IsHiddenbooleanNão

BusinessCatalogDelete

CampoTipoObrigatório
IdstringNão

BusinessCatalogHide

CampoTipoObrigatório
IdstringNão

BusinessCatalogInfo

CampoTipoObrigatório
JidstringNão
IdstringNão

BusinessCatalogList

CampoTipoObrigatório
JidstringNão

BusinessCatalogMessage

CampoTipoObrigatório
PhonestringSim
TextstringSim
MatchedTextstringSim
TitlestringSim

BusinessCatalogShow

CampoTipoObrigatório
IdstringNão

BusinessDescUpdate

CampoTipoObrigatório
DescstringNão

BusinessEmailUpdate

CampoTipoObrigatório
EmailstringNão

BusinessOrderDetails

CampoTipoObrigatório
OrderIdstringSim
TokenstringSim

BusinessProfile

CampoTipoObrigatório
JidstringNão

CallMake

CampoTipoObrigatório
CallTostringNão

CallReject

CampoTipoObrigatório
CallFromstringNão
CallIDstringNão

ChatArchive

CampoTipoObrigatório
ChatstringSim

ChatDelete

CampoTipoObrigatório
PhonestringSim

ChatMute

CampoTipoObrigatório
ChatstringSim

ChatPin

CampoTipoObrigatório
ChatstringSim

ChatPresence

CampoTipoObrigatório
PhonestringSim
StatestringSim
MediastringNão

ChatPresenceBody

CampoTipoObrigatório
JidstringSim

ChatTypingStart

CampoTipoObrigatório
JidstringSim

ChatTypingStop

CampoTipoObrigatório
JidstringSim

Checkavatar

CampoTipoObrigatório
PhonestringSim
PreviewboolSim

Checkuser

CampoTipoObrigatório
PhoneobjectSim

CommunityAdd

CampoTipoObrigatório
CommunityJIDstringNão
GroupJIDArrayNão

CommunityCreate

CampoTipoObrigatório
CommunityNamestringNão

CommunityRemove

CampoTipoObrigatório
CommunityJIDstringNão
GroupJIDArrayNão

Connect

CampoTipoObrigatório
SubscribestringNão
ImmediatebooleanNão

ContactAdd

CampoTipoObrigatório
PhonestringNão
FirstNamestringNão
FullNamestringNão
SaveOnBookbooleanNão

ContactRemove

CampoTipoObrigatório
PhonestringNão

DownloadMessageBody

CampoTipoObrigatório
UrlstringSim
DirectPathstringNão
MediaKeystringSim
MimetypestringSim
FileEncSHA256stringNão
FileSHA256stringSim
FileLengthnumberSim

GroupAdminOnly

CampoTipoObrigatório
GroupJIDstringNão
AdminOnlybooleanNão

GroupCreate

CampoTipoObrigatório
GroupNamestringNão
Participantsarray<any>Não

GroupInfo

CampoTipoObrigatório
GroupJIDstringNão
CampoTipoObrigatório
GroupJIDstringNão
ResetbooleanNão

GroupJoin

CampoTipoObrigatório
CodestringNão

GroupLeave

CampoTipoObrigatório
GroupIdstringSim

GroupLock

CampoTipoObrigatório
GroupJIDstringNão
LockbooleanNão

GroupName

CampoTipoObrigatório
GroupJIDstringNão
NamestringNão

GroupPhoto

CampoTipoObrigatório
GroupJIDstringNão
ImagestringNão

GroupUpdate

CampoTipoObrigatório
GroupJIDstringNão
ParticipantJIDarray<any>Não
ActionstringNão

GroupUpdateDescription

CampoTipoObrigatório
GroupJIDstringNão
DescriptionstringNão

InitUser

CampoTipoObrigatório
NamestringNão
TokenstringNão
OsstringNão

LabelChat

CampoTipoObrigatório
JidstringNão
LabelIdstringNão

LabelEdit

CampoTipoObrigatório
LabelIdstringNão
NamestringNão
ColornumberNão
ActionbooleanNão

LabelMessage

CampoTipoObrigatório
JidstringNão
LabelIdstringNão
MessageIdstringNão

Markread

CampoTipoObrigatório
IdobjectSim
ChatstringSim
SenderstringNão

MessageAudio

CampoTipoObrigatório
PhonestringSim
AudiostringSim
PttbooleanNão
DurationnumberNão
IdstringNão
ContextInfoobjectNão

MessageButtons

CampoTipoObrigatório
PhonestringSim
TitlestringSim
ContentstringSim
FooterstringSim
ButtonsobjectSim

MessageCarouselButton

Nenhum corpo JSON é necessário.

MessageCarouselButtonMedia

Nenhum corpo JSON é necessário.

MessageContact

CampoTipoObrigatório
PhonestringSim
IdstringNão
VcardobjectSim
ContextInfoobjectNão

MessageDelete

CampoTipoObrigatório
ChatstringSim
MessageIDstringSim

MessageDocument

CampoTipoObrigatório
PhonestringSim
DocumentstringSim
FileNamestringSim
CaptionstringNão
MimetypestringNão
IdstringNão
ContextInfoobjectNão

MessageEdit

CampoTipoObrigatório
ChatstringSim
MessagestringSim
MessageIDstringSim

MessageFlow

CampoTipoObrigatório
PhonestringSim
BodystringSim
FlowNamestringSim

MessageImage

CampoTipoObrigatório
PhonestringSim
ImagestringSim
CaptionstringNão
IdstringNão
ContextInfoobjectNão

MessageInvite

CampoTipoObrigatório
PhonestringSim
TextstringSim
MatchedTextstringSim
TitlestringSim

MessageLinkPreview

CampoTipoObrigatório
PhonestringSim
TextstringSim
MatchedURLstringSim
TitlestringSim
DescriptionstringSim
ImagestringSim

MessageList

CampoTipoObrigatório
PhonestringSim
ButtonTextstringSim
DescstringSim
TopTextstringSim
ListobjectSim

MessageLocation

CampoTipoObrigatório
PhonestringSim
NamestringNão
IdstringNão
LatitudefloatSim
LongitudefloatSim
ContextInfoobjectNão

MessageLocationButton

CampoTipoObrigatório
PhonestringNão
BodystringNão

MessageMediaButtons

CampoTipoObrigatório
PhonestringSim
ContentstringSim
FooterstringNão
TitlestringNão
FilenamestringNão
MessageIdstringNão
Buttonsarray<object>Sim
TypestringSim
MediastringSim

MessageMediaUrl

CampoTipoObrigatório
JidstringSim
UrlstringSim
TypestringSim
DurationnumberNão
CaptionstringSim
FilenamestringSim

MessagePixButton

CampoTipoObrigatório
PhonestringSim
TitlestringNão
BodystringSim
FooterstringNão
PixKeystringSim
MerchantNamestringNão
PixTypestringNão

MessagePoll

CampoTipoObrigatório
PhonestringSim
QuestionstringSim
MaxAnswernumberSim
Optionsarray<any>Sim
ContextInfoobjectNão

MessageReviewPay

CampoTipoObrigatório
PhonestringSim
TitlestringNão
BodystringSim
CaptionstringNão
FooterstringNão
PixKeystringSim
MerchantNamestringNão
PixTypestringNão
CurrencystringNão
ReferenceIDstringNão
TotalValueintegerNão
TotalOffsetintegerNão
Itemsarray<object>Não

MessageStatus

CampoTipoObrigatório
IdstringSim

MessageSticker

CampoTipoObrigatório
PhonestringSim
StickerstringSim
IdstringNão
PngThumbnailstringNão
ContextInfoobjectNão

MessageTemplate

CampoTipoObrigatório
PhonestringSim
TitlestringNão
ContentstringSim
FooterstringNão
ButtonsobjectNão

MessageText

CampoTipoObrigatório
PhonestringSim
BodystringSim
IdstringNão
ContextInfoobjectNão

MessageVideo

CampoTipoObrigatório
PhonestringSim
VideostringSim
CaptionstringNão
IdstringNão
JpegThumbnailstringNão
ContextInfoobjectNão

NewsletterCreate

CampoTipoObrigatório
NamestringNão
DescriptionstringNão

NewsletterInfo

CampoTipoObrigatório
JidstringNão
CampoTipoObrigatório
KeystringNão

NewsletterMessages

CampoTipoObrigatório
JidstringNão
CountnumberNão
BeforeIdnumberNão

NewsletterSubscribe

CampoTipoObrigatório
JidstringNão

Pair

CampoTipoObrigatório
PhonestringNão

ParseLID

CampoTipoObrigatório
LIDstringNão

ProfilePicture

CampoTipoObrigatório
ImagestringSim

ReactionText

CampoTipoObrigatório
PhonestringSim
BodystringSim
IdstringSim
IsFromMebooleanSim

StatusImage

CampoTipoObrigatório
ImagestringNão
CaptionstringNão

StatusText

CampoTipoObrigatório
TextstringNão
TextColornumberNão
BackgroundColornumberNão
FontnumberNão

TextMessage

CampoTipoObrigatório
sessionIdstringSim
textstringSim

UpdatePresence

CampoTipoObrigatório
PresencestringNão

UpdateProfileName

CampoTipoObrigatório
NamestringNão

Webhook

CampoTipoObrigatório
WebhookURLstringSim