Skip to content

docs(send-video/send-image): add codec warning and edit caption atributes #18

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

Merged
Lucas0204 merged 6 commits into from
May 11, 2026
+31 −3
Merged

docs(send-video/send-image): add codec warning and edit caption atributes #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
73da2f1
docs(send-video/send-image): add codec warning and edit caption atrib…
paolamayuri May 6, 2026
84945b2
Update message/send-message-image.mdx
paolamayuri May 11, 2026
96021bd
Update message/send-message-video.mdx
paolamayuri May 11, 2026
a17fd54
fix: adjust codec warning message
paolamayuri May 11, 2026
05fc50c
Update en/message/send-message-image.mdx
paolamayuri May 11, 2026
1bbedf4
Update en/message/send-message-video.mdx
paolamayuri May 11, 2026
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
6 changes: 5 additions & 1 deletion en/message/send-message-image.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Tools to convert images to Base64:
### Optional

<ParamField body="caption" type="string">
Image caption
Message to send along with the image
</ParamField>

<ParamField body="messageId" type="string">
Expand All @@ -58,6 +58,10 @@ Tools to convert images to Base64:
Whether it will be a view-once message or not
</ParamField>

<ParamField body="editImageMessageId" type="string">
Allows editing the message caption of a previously sent image. It is required to configure the webhook before using this feature.
</ParamField>

---

## Request Body
Expand Down
10 changes: 10 additions & 0 deletions en/message/send-message-video.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ Method responsible for sending videos to your chats. You can work with videos in
- **By Link**: if you have the video hosted somewhere on the internet, just send the link;
- **By Base64**: if you want to send the video in Base64 format.

<Warning>
For more predictable API behavior, we recommend using videos encoded with the **H.264** codec, which is the format supported by WhatsApp. Videos using other codecs go through an internal conversion process to H.264, which may cause intermittent sending issues or increase the final file size, potentially exceeding WhatsApp's allowed limit.

The file size must not exceed **100MB**.
</Warning>

---

## Attributes
Expand Down Expand Up @@ -54,6 +60,10 @@ Method responsible for sending videos to your chats. You can work with videos in
If enabled, the request will respond immediately with success and the file processing will be done in the background
</ParamField>

<ParamField body="editVideoMessageId" type="string">
Allows editing the message caption of a previously sent video. It is required to configure the webhook before using this feature.
</ParamField>

---

## Request Body
Expand Down
6 changes: 5 additions & 1 deletion message/send-message-image.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Ferramentas para converter imagens em Base64:
### Opcionais

<ParamField body="caption" type="string">
Título da sua imagem
Mensagem a ser enviada junto com a imagem
</ParamField>

<ParamField body="messageId" type="string">
Expand All @@ -63,6 +63,10 @@ Ferramentas para converter imagens em Base64:
Define se será uma mensagem de visualização única ou não
</ParamField>

<ParamField body="editImageMessageId" type="string">
Permite editar o caption da mensagem de imagem enviada anteriormente. É necessário configurar o webhook antes de utilizar.
</ParamField>

---

## Request Body
Expand Down
12 changes: 11 additions & 1 deletion message/send-message-video.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ Método responsável por enviar vídeos para os seus chats. Você pode trabalhar
- **Por Link**: caso você tenha o vídeo hospedado em algum lugar da internet, basta enviar somente o link;
- **Por Base64**: caso você queira enviar o vídeo em formato Base64.

<Warning>
Para um funcionamento mais previsível da API, recomendamos utilizar vídeos com CODEC **H.264**, que é o formato aceito pelo WhatsApp. Vídeos em outros CODECs passam por uma conversão interna para H.264, o que pode gerar intermitências no envio ou aumentar o tamanho final do arquivo, podendo ultrapassar o limite aceito pelo WhatsApp.

O tamanho do arquivo não deve ultrapassar **100MB**.
</Warning>

#### Exemplo no WhatsApp
<div style={{ display: "flex", justifyContent: "center" }}>
<img src="/images/send-message-video.jpeg" width="400" />
Expand All @@ -40,7 +46,7 @@ Método responsável por enviar vídeos para os seus chats. Você pode trabalhar
### Opcionais

<ParamField body="caption" type="string">
Mensagem que desejar enviar junto com o vídeo
Mensagem a ser enviada junto com o vídeo
</ParamField>

<ParamField body="messageId" type="string">
Expand All @@ -59,6 +65,10 @@ Método responsável por enviar vídeos para os seus chats. Você pode trabalhar
Se ativo, a request responderá imediatamente com sucesso e o processamento do arquivo será realizado em segundo plano
</ParamField>

<ParamField body="editVideoMessageId" type="string">
Permite editar o caption da mensagem de vídeo enviado anteriormente. É necessário configurar o webhook antes de utilizar.
</ParamField>

---

## Request Body
Expand Down