Skip to content

Commit dced4f8

Browse files
cesar-grandscesar-grands
committed
delete
1 parent b8a0487 commit dced4f8

14 files changed

+140
-28
lines changed

‎docs/message/delete-message.md‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
id: delete-message
3+
title: Deletando mensagens
4+
---
5+
6+
## Método
7+
8+
#### /send-audio
9+
10+
`DELETE` https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/messages
11+
12+
---
13+
14+
## Conceituação
15+
16+
Método utilizado para apagar uma mensagem em um chat, você pode deletar tanto uma mensagem que enviou quanto uma mensagen enviada por um contato, para utilizar este recurso você só vai precisar do messageId da mensagem que quer apagar.
17+
18+
---
19+
20+
## Atributos
21+
22+
### Obrigatórios
23+
24+
| Atributos | Tipo | Descrição |
25+
| :-- | :-: | :-- |
26+
| messageId | string | id original da mensagem, no caso de mensagem enviada por você é o código que vem no seu reponse, caso seja uma mensagem enviada por um contato você vai receber este messageId pelo seu webhook de receive |
27+
| phone | string | Telefone do destinatário/remetente no formato DDI DDD NUMERO Ex: 551199999999. **IMPORTANTE** Envie somente números, sem formatação ou máscara |
28+
| owner | boolean | Informe true caso você tenha enviado a mensagem ou false para casos onde seja uma mensagem recebida |
29+
30+
### Opcionais
31+
32+
| Atributos | Tipo | Descrição |
33+
| :-------- | :--: | :-------- |
34+
| | | |
35+
36+
---
37+
38+
## Request Body
39+
40+
```json
41+
{
42+
"messageId": "3999984263738042930CD6ECDE9VDWSA",
43+
"phone": "5511999998888",
44+
"owner": true
45+
}
46+
```
47+
48+
---
49+
50+
## Response
51+
52+
### 200
53+
54+
| Atributos | Tipo | Descrição |
55+
| :-------- | :--- | :-------- |
56+
| | | |
57+
58+
Exemplo
59+
60+
```json
61+
{}
62+
```
63+
64+
### 405
65+
66+
Neste caso certifique que esteja enviando o corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no inicio deste tópico.
67+
68+
### 415
69+
70+
Caso você receba um erro 415, certifique de adicionar na headers da requisição o "Content-Type" do objeto que você está enviando, em sua grande maioria "application/json"
71+
72+
---
73+
74+
## Code
75+
76+
<iframe src="//api.apiembed.com/?source=https://raw.githubusercontent.com/Z-API/z-api-docs/main/json-examples/send-video.json&targets=all" frameborder="0" scrolling="no" width="100%" height="500px" seamless></iframe>

docs/send-message/introduction.md renamed to docs/message/introduction.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,24 @@ Primeiramente você precisa entender sobre as mensagens é que elas podem ser en
1010
No tópico "contatos" vou voltar a relatar sobre isso, mas é importante você também saber que para o Whatsapp tudo é um chat seja um contato, grupo ou uma lista de transmissão.
1111

1212
Para enviar qualquer mensagem ele precisa de ID do chat, sendo eles:
13+
1314
- Para contatos é o próprio número;
1415
- Para grupos é a concatenação do número do fundador do grupo com um timestamp e
1516
- Para listas de transmissão é a concatenação da string 'broadcast' com o timestamp.
1617

1718
Esses IDs são todos retornados pelo método get/chats que você irá conhecer um pouco mais a frente.
1819

19-
Dica: Você pode formatar seus textos, enviando caracteres de formatação e deixar sua mensagem mais elegante.
20+
Falando em ID, recomendamos fortemente que você utilize armazene em sua aplicação o messageId que nosso response irá retornar conforme imagem abaixo, pois caso precise responder, marcar ou mesmo deletar uma mensagem você precisará informar o messageId como atributo no método.
21+
22+
```json
23+
{
24+
"zaapId": "3999984263738042930CD6ECDE9VDWSA",
25+
"messageId": "D241XXXX732339502B68" // salve este ID
26+
}
27+
```
28+
29+
:::tip Dica
30+
31+
Você pode formatar seus textos, enviando caracteres de formatação e deixar sua mensagem mais elegante.
32+
33+
:::

docs/send-message/send-message-audio.md renamed to docs/message/send-message-audio.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ Por Base64, se você optar por esta opção precisará ter em sua aplicação um
3333
### Opcionais
3434

3535
| Atributos | Tipo | Descrição |
36-
| :-------- | :--: | :-------- |
37-
| | | |
36+
| :-- | :-: | :-- |
37+
| messageId | String | Atributo utilizado para responder uma mensagem do chat, basta adicionar o messageId da mensagem que queira responder neste atributo |
3838

3939
---
4040

docs/send-message/send-message-catalog.md renamed to docs/message/send-message-catalog.md

File renamed without changes.

docs/send-message/send-message-contact.md renamed to docs/message/send-message-contact.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ Simples e objetivo este método permite você enviar um contato, você não prec
3131
### Opcionais
3232

3333
| Atributos | Tipo | Descrição |
34-
| :-------- | :--: | :-------- |
35-
| | | |
34+
| :-- | :-: | :-- |
35+
| messageId | String | Atributo utilizado para responder uma mensagem do chat, basta adicionar o messageId da mensagem que queira responder neste atributo |
3636

3737
---
3838

docs/send-message/send-message-document.md renamed to docs/message/send-message-document.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,10 @@ Método responsavel por enviar documentos aos seus contatos ele é simples e obj
3232

3333
### Opcionais
3434

35-
| Atributos | Tipo | Descrição |
36-
| :-------- | :----: | :---------------- |
37-
| fileName | String | Nome do documento |
35+
| Atributos | Tipo | Descrição |
36+
| :-- | :-: | :-- |
37+
| fileName | String | Nome do documento |
38+
| messageId | String | Atributo utilizado para responder uma mensagem do chat, basta adicionar o messageId da mensagem que queira responder neste atributo |
3839

3940
---
4041

docs/send-message/send-message-image.md renamed to docs/message/send-message-image.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,10 @@ O Whatsapp limita o tamanho de imagens e sua politica muda constantemente para m
4242

4343
### Opcionais
4444

45-
| Atributos | Tipo | Descrição |
46-
| :-------- | :----: | :------------------- |
47-
| caption | string | Titulo da sua imagem |
45+
| Atributos | Tipo | Descrição |
46+
| :-- | :-: | :-- |
47+
| caption | string | Titulo da sua imagem |
48+
| messageId | String | Atributo utilizado para responder uma mensagem do chat, basta adicionar o messageId da mensagem que queira responder neste atributo |
4849

4950
---
5051

docs/send-message/send-message-link.md renamed to docs/message/send-message-link.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ Método responsavel por enviar um link aos seus contatos, muito utilzado para co
3939
### Opcionais
4040

4141
| Atributos | Tipo | Descrição |
42-
| :-------- | :--: | :-------- |
43-
| | | |
42+
| :-- | :-: | :-- |
43+
| messageId | String | Atributo utilizado para responder uma mensagem do chat, basta adicionar o messageId da mensagem que queira responder neste atributo |
4444

4545
---
4646

docs/send-message/send-message-location.md renamed to docs/message/send-message-location.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ Método responsavel por enviar uma localização fixa aos seus contatos, muito u
1717

1818
---
1919

20+
## Atributos
21+
2022
### Obrigatórios
2123

2224
| Atributos | Tipo | Descrição |
@@ -30,8 +32,8 @@ Método responsavel por enviar uma localização fixa aos seus contatos, muito u
3032
### Opcionais
3133

3234
| Atributos | Tipo | Descrição |
33-
| :-------- | :--: | :-------- |
34-
| | | |
35+
| :-- | :-: | :-- |
36+
| messageId | String | Atributo utilizado para responder uma mensagem do chat, basta adicionar o messageId da mensagem que queira responder neste atributo |
3537

3638
---
3739

docs/send-message/send-message-product.md renamed to docs/message/send-message-product.md

File renamed without changes.

0 commit comments

Comments
 (0)