Skip to content

Commit f3a129b

Browse files
cesar-grandscesar-grands
committed
sendmsgfinish
1 parent bb426e0 commit f3a129b

File tree

8 files changed

+201
-25
lines changed

8 files changed

+201
-25
lines changed

‎docs/contacts/get-contacts.md‎

Lines changed: 60 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,81 @@ title: Pegar contatos
55

66
## Método
77

8-
#### /send-audio
8+
#### /contacts
99

10-
`GET` https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/
10+
`GET` https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/contacts
1111

1212
---
1313

1414
## Conceituação
1515

16+
Este método é reponsavel por retornar todos os contatos do Whatsapp. Lembre-se do que foi dito na introdução sobre numero de contatos, caso tenho pulado esta parte, sugiro que você volte um passo e leia a nossa introdução sobre contatos.
17+
18+
---
19+
1620
## Atributos
1721

22+
### Obrigatórios
23+
24+
| Atributos | Tipo | Descrição |
25+
| :-- | :-: | :-- |
26+
| page | integer | Utilizado para paginação você de informar aqui a pagina de contatos que quer buscar |
27+
| pageSize | integer | Especifica o tamanho do retorno de contatos por pagina |
28+
29+
### Opcionais
30+
1831
| Atributos | Tipo | Descrição |
1932
| :-------- | :--: | :-------- |
2033
| | | |
21-
| | | |
2234

2335
---
2436

25-
## Code
37+
## Request Params
38+
39+
#### URL exemplo
40+
41+
Método
42+
43+
`GET` https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/contacts?page=1&pageSize=20
2644

2745
---
2846

2947
## Response
48+
49+
### 200
50+
51+
| Atributos | Tipo | Descrição |
52+
| :-- | :-- | :-- |
53+
| phone | string | Phone do contato |
54+
| name | string | **Nome e sobrenome** do contato, só vai retornar preenchido caso você tenha o número em seus contatos |
55+
| short | string | **Nome** do contato, só vai retornar preenchido caso você tenha o número em seus contatos |
56+
| vname | string | Nome do Vcard do contato, caso ele tenha |
57+
| notify | string | Nome informado nas configurações de nome do Whatsapp |
58+
59+
Exemplo
60+
61+
```json
62+
[
63+
{
64+
"name": "Nome e sobrenome do contato 1",
65+
"short": "Nome do contato 1",
66+
"notify": "Nome no Whatsapp 1",
67+
"vname": "Nome no vcard",
68+
"phone": "559999999999"
69+
}
70+
]
71+
```
72+
73+
### 405
74+
75+
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.
76+
77+
### 415
78+
79+
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"
80+
81+
---
82+
83+
## Code
84+
85+
<iframe src="//api.apiembed.com/?source=https://raw.githubusercontent.com/Z-API/z-api-docs/main/json-examples/get-contacts.json&targets=all" frameborder="0" scrolling="no" width="100%" height="500px" seamless></iframe>

‎docs/contacts/get-metadata-contact.md‎

Lines changed: 64 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,85 @@ title: Pega Metadata do Contato
55

66
## Método
77

8-
#### /send-audio
8+
#### /contacts/{phone}
99

10-
`GET` https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/
10+
`GET` https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/contacts/{phone}
1111

1212
---
1313

1414
## Conceituação
1515

16+
Este método é reponsavel por retornar as informações do metadado do contato.
17+
18+
:::tip Dica sobre imagem do contato
19+
20+
Se você pretente armazenar a imagem do seu contato observe que sempre retornamos no get-contacts o atribucom imgUrl com ela para você, porém é importante lembrar que esta fica disponivel por apenas **48 horas**, após este periodo o link da imagem é excluido pelo próprio Whatsapp. Sugerimos que caso precise atualizar a imagem do seu contato você utilize o proximo método desta documentação, o **get-profile-picture**.
21+
22+
:::
23+
24+
---
25+
1626
## Atributos
1727

28+
### Obrigatórios
29+
30+
| Atributos | Tipo | Descrição |
31+
| :-- | :-: | :-- |
32+
| phone | string | Telefone do destinatário no formato DDI DDD NUMERO Ex: 551199999999. **IMPORTANTE** Envie somente números, sem formatação ou máscara |
33+
34+
### Opcionais
35+
1836
| Atributos | Tipo | Descrição |
1937
| :-------- | :--: | :-------- |
2038
| | | |
21-
| | | |
2239

2340
---
2441

25-
## Code
42+
## Request Params
43+
44+
#### URL exemplo
45+
46+
Método
47+
48+
`GET` https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/contacts/551199999999
2649

2750
---
2851

2952
## Response
53+
54+
### 200
55+
56+
| Atributos | Tipo | Descrição |
57+
| :-- | :-- | :-- |
58+
| phone | string | Phone do contato |
59+
| name | string | **Nome e sobrenome** do contato, só vai retornar preenchido caso você tenha o número em seus contatos |
60+
| short | string | **Nome** do contato, só vai retornar preenchido caso você tenha o número em seus contatos |
61+
| vname | string | Nome do Vcard do contato, caso ele tenha |
62+
| notify | string | Nome informado nas configurações de nome do Whatsapp |
63+
| imgUrl | string | URL da foto do contato **o Whatsapp apaga após 48h** |
64+
65+
Exemplo
66+
67+
```json
68+
{
69+
"name": "Nome e sobrenome do contato",
70+
"phone": "551199999999",
71+
"notify": "Nome do contado no Whatsapp",
72+
"short": "Nome do contato",
73+
"imgUrl": "url da foto do contato "
74+
}
75+
```
76+
77+
### 405
78+
79+
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.
80+
81+
### 415
82+
83+
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"
84+
85+
---
86+
87+
## Code
88+
89+
<iframe src="//api.apiembed.com/?source=https://raw.githubusercontent.com/Z-API/z-api-docs/main/json-examples/get-contacts-phone.json&targets=all" frameborder="0" scrolling="no" width="100%" height="500px" seamless></iframe>

‎docs/contacts/introduction.md‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@ title: Introdução
55

66
### Conceituação
77

8-
Introdução a contatos
8+
Neste tópico você vai entender um pouco mais sobre o que o **Z-API** pode fazer quando o assunto é contato, dividimos esta abordagem em alguns tópicos abaixo listados para melhor lhe explicar:
99

10-
Profile fica disponivel por 48 horas
10+
- Para o Whatsapp todo contato é simplesmente um Chat ! Parece ousado de se dizer mas é assim que ele trata o que chamamos de contato, ele utiliza o numero do seu contato apenas como identificador para o chat conforme ja dito em outros tópicos. Mas então qual a diferença entre get-chats e get-contacts ? O get-chats vai trazer todos contatos aos quais você ja manteve uma conversa ou seja tem um chat aberto com ele, o get-contacts vai retornar todos os seus contatos que tenham conta no Whatsapp somado aos contatos que participam de grupos com o seu numero.
11+
12+
- Tudo que o Z-API pode fazer quanto a contatos é o mesmo que o Whatsapp Web pode fazer ou seja, quase nada, não é possivel adicionar um contato, nem mesmo renomear ou mesmo excluir, basicamente o que você precisa entender é que o Whatsapp Web nao consegue manipular a agenda de contatos do seu celular, logo o **Z-API** também não.
13+
14+
:::caution Sobre contatos
15+
16+
O metodo que retorna contatos pode te deixar um pouco confuso pois provavelmente ele deve retornar um numero maior de contatos do que a quantidade que você tem em sua agenda, isso ocorre porque você provavelmente participa de grupos, o método get-contacts vai retornar todos os contatos que estão nos grupos que você participa.
17+
18+
:::

‎docs/message/delete-message.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Deletar mensagens
55

66
## Método
77

8-
#### /send-audio
8+
#### /messages
99

1010
`DELETE` https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/messages
1111

@@ -35,15 +35,15 @@ Método utilizado para apagar uma mensagem em um chat, você pode deletar tanto
3535

3636
---
3737

38-
## Request Body
38+
## Request Params
3939

40-
```json
41-
{
42-
"messageId": "3999984263738042930CD6ECDE9VDWSA",
43-
"phone": "5511999998888",
44-
"owner": true
45-
}
46-
```
40+
#### URL exemplo
41+
42+
Método
43+
44+
`DELETE`
45+
46+
https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/messages?messageId=123&phone=5511999998888&owner=true
4747

4848
---
4949

‎docs/message/read-message.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,4 +73,4 @@ Caso você receba um erro 415, certifique de adicionar na headers da requisiçã
7373

7474
## Code
7575

76-
<iframe src="//api.apiembed.com/?source=https://raw.githubusercontent.com/Z-API/z-api-docs/main/json-examples/delete-message.json&targets=all" frameborder="0" scrolling="no" width="100%" height="500px" seamless></iframe>
76+
<iframe src="//api.apiembed.com/?source=https://raw.githubusercontent.com/Z-API/z-api-docs/main/json-examples/read-message.json&targets=all" frameborder="0" scrolling="no" width="100%" height="500px" seamless></iframe>

‎json-examples/delete-message.json‎

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,29 @@
22
"method": "DELETE",
33
"url": "https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/message",
44
"httpVersion": "HTTP/1.1",
5-
"queryString": [],
5+
"queryString": [
6+
{
7+
"name": "messageId",
8+
"value": "3999984263738042930CD6ECDE9VDWSA",
9+
"comment": ""
10+
},
11+
{
12+
"name": "phone",
13+
"value": "5511999998888",
14+
"comment": ""
15+
},
16+
{
17+
"name": "owner",
18+
"value": true,
19+
"comment": ""
20+
}
21+
],
622
"headers": [
723
{
824
"name": "Content-Type",
925
"value": "application/json"
1026
}
1127
],
1228
"cookies": [],
13-
"postData": {
14-
"mimeType": "application/json",
15-
"text": "{\"messageId\": \"3999984263738042930CD6ECDE9VDWSA\",\"phone\": \"5511999998888\", \"owner\": true}"
16-
}
29+
"postData": {}
1730
}

‎json-examples/get-contact-phone.json‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"method": "GET",
3+
"url": "https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/contact/TELEFONE_DO_CONTATO",
4+
"httpVersion": "HTTP/1.1",
5+
"queryString": [],
6+
"headers": [
7+
{
8+
"name": "Content-Type",
9+
"value": "application/json"
10+
}
11+
],
12+
"cookies": [],
13+
"postData": {}
14+
}

‎json-examples/get-contact.json‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"method": "GET",
3+
"url": "https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/contact",
4+
"httpVersion": "HTTP/1.1",
5+
"queryString": [
6+
{
7+
"name": "page",
8+
"value": "1",
9+
"comment": ""
10+
},
11+
{
12+
"name": "pageSize",
13+
"value": "100",
14+
"comment": ""
15+
}
16+
],
17+
"headers": [
18+
{
19+
"name": "Content-Type",
20+
"value": "application/json"
21+
}
22+
],
23+
"cookies": [],
24+
"postData": {}
25+
}

0 commit comments

Comments
 (0)