Skip to content

docs(webhooks): add status reply message examples (text, image, video, audio) #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
paolamayuri wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(webhooks): add status reply message examples (text, image, video, audio) #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
135 changes: 127 additions & 8 deletions en/webhooks/on-message-received-examples.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1607,11 +1607,11 @@ All webhook callbacks share the following common attributes:

<AccordionGroup>

<Accordion title="Status reply">
<Accordion title="Text status reply">
```json
{
"isStatusReply": true,
"senderLid": "81896604192873@lid",
"chatLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
Expand All @@ -1621,28 +1621,147 @@ All webhook callbacks share the following common attributes:
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228638000,
"momment": 1779134507000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderPhoto": null,
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"participantLid": null,
"referenceMessageId": "3EB054C12BAAC70228AAB6",
"messageExpirationSeconds": 0,
"forwarded": false,
"type": "ReceivedCallback",
"fromApi": false,
"text": {
"message": "test"
}
}
```

</Accordion>

<Accordion title="Image status reply">
```json
{
"isStatusReply": true,
"chatLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1779134507000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": null,
"senderName": "name",
"photo": "https://",
"broadcast": false,
"participantLid": null,
"referenceMessageId": "3EB054C12BAAC70228AAB6",
"messageExpirationSeconds": 0,
"forwarded": false,
"type": "ReceivedCallback",
"fromApi": false,
"text": {
"message": "test"
},
"statusImage": {
"imageUrl": "https://",
"thumbnailUrl": "https://",
"mimetype": "image/jpeg",
"viewOnce": false
"caption": "teste",
"mimeType": "image/jpeg",
"width": 960,
"height": 1280
}
}
```

</Accordion>

<Accordion title="Video status reply">
```json
{
"isStatusReply": true,
"chatLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1779134507000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": null,
"senderName": "name",
"photo": "https://",
"broadcast": false,
"participantLid": null,
"referenceMessageId": "3EB054C12BAAC70228AAB6",
"messageExpirationSeconds": 0,
"forwarded": false,
"type": "ReceivedCallback",
"fromApi": false,
"text": {
"message": "test"
},
"statusVideo": {
"videoUrl": "https://f004.backblazeb2.com/file/temp-file-download/instances/3FXXXXXXXXXXXXXXXXXXXXXXXF/3XXXXXXXXXXXXXXXX64/9bXXXXXPu_WXXXXXYgcA==.mp4",
"caption": "Teste",
"mimeType": "video/mp4"
}
}
```

</Accordion>

<Accordion title="Audio status reply">
```json
{
"isStatusReply": true,
"chatLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1779134507000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": null,
"senderName": "name",
"photo": "https://",
"broadcast": false,
"participantLid": null,
"referenceMessageId": "3EB054C12BAAC70228AAB6",
"messageExpirationSeconds": 0,
"forwarded": false,
"type": "ReceivedCallback",
"fromApi": false,
"text": {
"message": "test"
},
"statusAudio": {
"audioUrl": "https://f004.backblazeb2.com/file/temp-file-download/instances/3FXXXXXXXXXXXXXXXXXXXXXXXF/3XXXXXXXXXXXXXXXX64/dXXXXXXXXXXXXXXXXQ==.ogg",
"mimeType": "audio/ogg; codecs=opus"
}
}
```

</Accordion>

</AccordionGroup>
Expand Down
131 changes: 123 additions & 8 deletions webhooks/on-message-received-examples.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1607,11 +1607,11 @@ Todos os retornos de webhook possuem os seguintes atributos em comum:

<AccordionGroup>

<Accordion title="Resposta de status">
<Accordion title="Resposta de status de texto">
```json
{
"isStatusReply": true,
"senderLid": "81896604192873@lid",
"chatLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
Expand All @@ -1621,25 +1621,140 @@ Todos os retornos de webhook possuem os seguintes atributos em comum:
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228638000,
"momment": 1779134507000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderPhoto": null,
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"participantLid": null,
"referenceMessageId": "3EB054C12BAAC70228AAB6",
"messageExpirationSeconds": 0,
"forwarded": false,
"type": "ReceivedCallback",
"fromApi": false,
"text": {
"message": "teste"
}
}
```
</Accordion>

<Accordion title="Resposta de status de imagem">
```json
{
"isStatusReply": true,
"chatLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1779134507000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": null,
"senderName": "name",
"photo": "https://",
"broadcast": false,
"participantLid": null,
"referenceMessageId": "3EB054C12BAAC70228AAB6",
"messageExpirationSeconds": 0,
"forwarded": false,
"type": "ReceivedCallback",
"fromApi": false,
"text": {
"message": "teste"
},
"statusImage": {
"imageUrl": "https://",
"thumbnailUrl": "https://",
"mimetype": "image/jpeg",
"viewOnce": false
"caption": "teste",
"mimeType": "image/jpeg",
"width": 960,
"height": 1280
}
}
```
</Accordion>

<Accordion title="Resposta de status de video">
```json
{
"isStatusReply": true,
"chatLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1779134507000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": null,
"senderName": "name",
"photo": "https://",
"broadcast": false,
"participantLid": null,
"referenceMessageId": "3EB054C12BAAC70228AAB6",
"messageExpirationSeconds": 0,
"forwarded": false,
"type": "ReceivedCallback",
"fromApi": false,
"text": {
"message": "teste"
},
"statusVideo": {
"videoUrl": "https://f004.backblazeb2.com/file/temp-file-download/instances/3FXXXXXXXXXXXXXXXXXXXXXXXF/3XXXXXXXXXXXXXXXX64/9bXXXXXPu_WXXXXXYgcA==.mp4",
"caption": "Teste",
"mimeType": "video/mp4"
}
}
```
</Accordion>

<Accordion title="Resposta de status de audio">
```json
{
"isStatusReply": true,
"chatLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1779134507000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": null,
"senderName": "name",
"photo": "https://",
"broadcast": false,
"participantLid": null,
"referenceMessageId": "3EB054C12BAAC70228AAB6",
"messageExpirationSeconds": 0,
"forwarded": false,
"type": "ReceivedCallback",
"fromApi": false,
"text": {
"message": "teste"
},
"statusAudio": {
"audioUrl": "https://f004.backblazeb2.com/file/temp-file-download/instances/3FXXXXXXXXXXXXXXXXXXXXXXXF/3XXXXXXXXXXXXXXXX64/dXXXXXXXXXXXXXXXXQ==.ogg",
"mimeType": "audio/ogg; codecs=opus"
}
}
```
Expand Down