Skip to content

docs(webhooks): add errorCode field, update shadowban errors on DeliveryCallback and Blockednumbernew #22

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 errorCode field, update shadowban errors on DeliveryCallback and Blockednumbernew #22

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
1 change: 0 additions & 1 deletion en/tips/blockednumbernew.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,6 @@ This type of restriction can be identified through the [On Message Send](/webhoo
When attempting to send a message, you may receive errors such as:

- `"The message was not sent due to a likely shadow ban"`
- `"Did not have permission to send this message"`
- `"Whatsapp rejected sending this message"`

These responses indicate that the number is temporarily restricted from sending messages.
Expand Down
8 changes: 7 additions & 1 deletion en/webhooks/on-message-send-examples.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,11 @@ All **On Send** webhook responses contain the following attributes:
Present **only in error cases**. Contains the description of the error that occurred when sending the message
</ResponseField>

<ResponseField name="errorCode" type="string (enum)">
Error identifier code. Present **only in specific error cases**.
Currently sent only when the error is related to a temporary message sending restriction (shadow ban), with the value `"SHADOW_BAN"`
</ResponseField>

---

## Return Examples
Expand Down Expand Up @@ -93,7 +98,8 @@ When an error occurs during sending, the response includes the `error` field wit
WhatsApp did not allow sending this message.
</Accordion>
<Accordion title="The message was not sent due to a likely shadow ban">
The number is probably temporarily restricted from sending messages (shadow ban)
The phone number is likely under a temporary message sending restriction (shadow ban).
When this error occurs, the `errorCode` field is sent with the value `"SHADOW_BAN"`
</Accordion>
<Accordion title="Does not have permission to send the message">
Your account does not have permission to send this message.
Expand Down
1 change: 0 additions & 1 deletion tips/blockednumbernew.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,6 @@ Quando um número está sob shadowban, podem ocorrer os seguintes comportamentos
Ao tentar enviar uma mensagem, você pode receber erros como:

- `"The message was not sent due to a likely shadow ban"`
- `"Did not have permission to send this message"`
- `"Whatsapp rejected sending this message"`

Esses retornos indicam que o número está temporariamente impedido de enviar mensagens.
Expand Down
8 changes: 7 additions & 1 deletion webhooks/on-message-send-examples.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,11 @@ Todos os retornos do webhook **Ao enviar** possuem os seguintes atributos:
Presente **apenas em casos de erro**. Contém a descrição do erro ocorrido no envio da mensagem
</ResponseField>

<ResponseField name="errorCode" type="string (enum)">
Código identificador do erro. Presente **apenas em casos específicos de erro**.
Atualmente enviado somente quando o erro for relacionado a restrição temporária de envio de mensagens (shadow ban), com o valor `"SHADOW_BAN"`
</ResponseField>

---

## Exemplos de retorno
Expand Down Expand Up @@ -93,7 +98,8 @@ Quando ocorre um erro no envio, o retorno inclui o campo `error` com a descriç
O WhatsApp não permitiu o envio desta mensagem.
</Accordion>
<Accordion title="The message was not sent due to a likely shadow ban">
O número provavelmente está com uma restrição temporária de envio de mensagens (shadow ban).
O número provavelmente está com uma restrição temporária de envio de mensagens (shadow ban).
Quando este erro ocorre, o campo `errorCode` é enviado com o valor `"SHADOW_BAN"`
</Accordion>
<Accordion title="Does not have permission to send the message">
Sua conta não tem autorização para enviar esta mensagem.
Expand Down