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

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

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
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
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.
Copy link
Copy Markdown
Contributor

@Lucas0204 Lucas0204 May 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mesmo cenário dos arquivos em português:

Suggested change
Allows editing the message (caption) of a previously sent image. It is required to configure the webhook before using this feature.
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
8 changes: 8 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,10 @@ 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>
The video must be encoded in **H.264** before sending. Videos in other codecs may be rejected or not play correctly on WhatsApp. The file must not exceed **100MB**.
Copy link
Copy Markdown
Contributor

@Lucas0204 Lucas0204 May 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mesma coisa do comentário do arquivo em português

</Warning>

---

## Attributes
Expand Down Expand Up @@ -54,6 +58,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.
Copy link
Copy Markdown
Contributor

@Lucas0204 Lucas0204 May 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Allows editing the message (caption) of a previously sent video. It is required to configure the webhook before using this feature.
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 a mensagem (caption) de uma imagem enviada anteriormente. É necessário configurar o webhook antes de utilizar.
Copy link
Copy Markdown
Contributor

@Lucas0204 Lucas0204 May 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

aqui acredito que ficaria mais fluído e claro se deixasse o caption mais em evidência ao invés de dentro de parenteses, por exemplo:

Suggested change
Permite editar a mensagem (caption) de uma imagem enviada anteriormente. É necessário configurar o webhook antes de utilizar.
Permite editar o caption da mensagem de imagem enviada anteriormente. É necessário configurar o webhook antes de utilizar.

</ParamField>

---

## Request Body
Expand Down
10 changes: 9 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,10 @@ 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>
O vídeo deve estar codificado em **H.264** antes de ser enviado. Vídeos em outros codecs podem ser rejeitados ou não reproduzir corretamente no WhatsApp. O arquivo não deve ultrapassar **100MB**.
Copy link
Copy Markdown
Contributor

@Lucas0204 Lucas0204 May 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

seria melhor deixar essa parte como uma recomendação, exemplo: "Para um funcionamento mais previsível dessa API, procure sempre utilizar vídeos com CODEC H.264, pois é o formato aceito pelo Whatsapp. Em caso de vídeos outros CODECS, internamente fazemos um processamento e conversão do mesmo para H.264, o que pode gerar intermitências no envio, visto que esse processo de conversão de CODEC pode resultar em um vídeo mais pesado e, consequentemente, maior do que o aceito pelo Whatsapp. Ou seja, dependendo do CODEC do vídeo enviado para a API, caso ele seja pesado, o envio pode ou não ser executado, por conta disso, para uma operação mais previsível da API, recomendamos utilizar CODEC H.264"

Enfim, algo nesse sentido. Porque quando você coloca que o vídeo "deve estar codificado... ", dá a entender que o CODEC do vídeo é uma limitação, o que não é verdade, pois fazemos conversões de qualquer tipo de vídeo praticamente, daí poderia gerar confusão nos clientes. Ou seja, poderia acabar gerando uma preocupação desnecessário nos clientes que já utilizam hoje e funciona normalmente

</Warning>

#### Exemplo no WhatsApp
<div style={{ display: "flex", justifyContent: "center" }}>
<img src="/images/send-message-video.jpeg" width="400" />
Expand All @@ -40,7 +44,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 +63,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 a mensagem (caption) de um vídeo enviado anteriormente. É necessário configurar o webhook antes de utilizar.
Copy link
Copy Markdown
Contributor

@Lucas0204 Lucas0204 May 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mesma situação da imagem:

Suggested change
Permite editar a mensagem (caption) de um vídeo enviado anteriormente. É necessário configurar o webhook antes de utilizar.
Permite editar o caption da mensagem de vídeo enviado anteriormente. É necessário configurar o webhook antes de utilizar.

</ParamField>

---

## Request Body
Expand Down