diff --git a/docs/business/delete-product.md b/docs/business/delete-product.md index 02b0105..9a3789a 100644 --- a/docs/business/delete-product.md +++ b/docs/business/delete-product.md @@ -33,7 +33,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/business/edit-product.md b/docs/business/edit-product.md index f57e314..a61e370 100644 --- a/docs/business/edit-product.md +++ b/docs/business/edit-product.md @@ -67,7 +67,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/business/get-product-id.md b/docs/business/get-product-id.md index 0abe8c4..409c0df 100644 --- a/docs/business/get-product-id.md +++ b/docs/business/get-product-id.md @@ -51,7 +51,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/business/get-products-phone.md b/docs/business/get-products-phone.md index a23ee0e..62f5f62 100644 --- a/docs/business/get-products-phone.md +++ b/docs/business/get-products-phone.md @@ -53,7 +53,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/business/get-products.md b/docs/business/get-products.md index 9c48192..251fdc2 100644 --- a/docs/business/get-products.md +++ b/docs/business/get-products.md @@ -53,7 +53,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/chats/archive-chat.md b/docs/chats/archive-chat.md index f4af13a..892f360 100644 --- a/docs/chats/archive-chat.md +++ b/docs/chats/archive-chat.md @@ -13,7 +13,7 @@ title: Arquivar chats ## Conceituação -Este método é reponsavel por arquivar e desarquivarseus chats. +Este método é responsável por arquivar e desarquivarseus chats. --- @@ -59,7 +59,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/chats/chat-expiration.md b/docs/chats/chat-expiration.md new file mode 100644 index 0000000..49d5390 --- /dev/null +++ b/docs/chats/chat-expiration.md @@ -0,0 +1,74 @@ +--- +id: send-chat-expiration +title: Expiração do chats +--- + +## Método + +#### POST /send-chat-expiration + +`POST` https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/send-chat-expiration + +--- + +## Conceituação + +Este método é responsável por enviar expiração do chat. + +--- + +## Atributos + +### Obrigatórios + +| Atributos | Tipo | Descrição | +| :-- | :-: | :-- | +| phone | integer | Número de telefone que você deseja inserir o tempo de expiração do **SEU** chat | +| chatExpiration | string | Atributo para enviar expiração do chat | + +--- + +## Request Body + +Exemplo + +```json +{ + "phone": "554497050785", + "chatExpiration": "90_days" +} +``` + +**Opcões do chatExpiration**: "24_hours", "7_days", "90_days", "off" + +--- + +## Response + +### 200 + +| Atributos | Tipo | Descrição | +| :-------- | :------ | :------------------------------ | +| value | boolean | Atributo de confirmação da ação | + +Exemplo + +```json +{ + "value": true +} +``` + +### 405 + +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. + +### 415 + +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" + +--- + +## Code + + diff --git a/docs/chats/delete-chat.md b/docs/chats/delete-chat.md index 9812134..373951d 100644 --- a/docs/chats/delete-chat.md +++ b/docs/chats/delete-chat.md @@ -13,7 +13,7 @@ title: Deletar Chats ## Conceituação -Este método é reponsavel por deletar seus chats. +Este método é responsável por deletar seus chats. --- @@ -47,7 +47,7 @@ Exemplo | Atributos | Tipo | Descrição | | :-------- | :------ | :------------------------------ | -| value | boolean | Atributo de confirmaçaõ da ação | +| value | boolean | Atributo de confirmação da ação | Exemplo @@ -59,7 +59,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/chats/get-chats.md b/docs/chats/get-chats.md index acdb751..c77887b 100644 --- a/docs/chats/get-chats.md +++ b/docs/chats/get-chats.md @@ -13,7 +13,7 @@ title: Pegar chats ## Conceituação -Este método é reponsavel por retornar todos os chats. +Este método é responsável por retornar todos os chats. --- @@ -88,7 +88,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/chats/get-message-chats.md b/docs/chats/get-message-chats.md index 825a34b..e5c24b7 100644 --- a/docs/chats/get-message-chats.md +++ b/docs/chats/get-message-chats.md @@ -13,7 +13,7 @@ title: Pegar mensagens do chat ## Conceituação -Este método é reponsavel por retornar todas conversas de um chat. +Este método é responsável por retornar todas conversas de um chat. --- @@ -187,7 +187,7 @@ Segue Json conforme sequência abaixo: ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/chats/get-metadata-chat.md b/docs/chats/get-metadata-chat.md index 5ca89a4..b6888d1 100644 --- a/docs/chats/get-metadata-chat.md +++ b/docs/chats/get-metadata-chat.md @@ -13,7 +13,7 @@ title: Pegar metadata do Chat ## Conceituação -Este método é reponsavel por retornar as informações do metadata de um chat. +Este método é responsável por retornar as informações do metadata de um chat. --- @@ -73,7 +73,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/contacts/get-contacts.md b/docs/contacts/get-contacts.md index e2b3a4d..4c4a135 100644 --- a/docs/contacts/get-contacts.md +++ b/docs/contacts/get-contacts.md @@ -13,7 +13,7 @@ title: Pegar contatos ## Conceituação -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. +Este método é responsável 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. --- @@ -72,7 +72,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/contacts/get-iswhatsapp.md b/docs/contacts/get-iswhatsapp.md index 2b1bdc2..bbe553d 100644 --- a/docs/contacts/get-iswhatsapp.md +++ b/docs/contacts/get-iswhatsapp.md @@ -67,7 +67,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/contacts/get-metadata-contact.md b/docs/contacts/get-metadata-contact.md index aa49dca..48146d4 100644 --- a/docs/contacts/get-metadata-contact.md +++ b/docs/contacts/get-metadata-contact.md @@ -13,7 +13,7 @@ title: Pegar metadata do contato ## Conceituação -Este método é reponsavel por retornar as informações do metadata do contato. +Este método é responsável por retornar as informações do metadata do contato. :::tip Dica sobre imagem do contato @@ -76,7 +76,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/contacts/get-profile-picture.md b/docs/contacts/get-profile-picture.md index 0973d07..5456627 100644 --- a/docs/contacts/get-profile-picture.md +++ b/docs/contacts/get-profile-picture.md @@ -13,7 +13,7 @@ title: Pegar imagem do contato ## Conceituação -Este método é reponsavel por retornar a url com a imagem do contato atualizada. +Este método é responsável por retornar a url com a imagem do contato atualizada. Como já dito no tópico anterior **Lembre-se** @@ -67,7 +67,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/group/add-admin.md b/docs/group/add-admin.md index ae7203b..fa96d86 100644 --- a/docs/group/add-admin.md +++ b/docs/group/add-admin.md @@ -12,7 +12,7 @@ title: Promover admin do grupo ## Conceituação -Este método é reponsavel por promover participamentes do grupo à administradores, você pode provomover um ou mais participamente à administrador. +Este método é responsável por promover participamentes do grupo à administradores, você pode provomover um ou mais participamente à administrador. :::caution Atenção @@ -84,7 +84,7 @@ Forma nova - ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/group/add-participant.md b/docs/group/add-participant.md index 3342de9..104b1a6 100644 --- a/docs/group/add-participant.md +++ b/docs/group/add-participant.md @@ -11,7 +11,7 @@ title: Adicionar Participantes ## Conceituação -Este método é reponsável por adicionar novos participantes ao grupo. +Este método é responsável por adicionar novos participantes ao grupo. :::caution Atenção @@ -83,7 +83,7 @@ Forma nova - ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/group/create-group.md b/docs/group/create-group.md index 1091f10..8ae09c5 100644 --- a/docs/group/create-group.md +++ b/docs/group/create-group.md @@ -13,7 +13,7 @@ title: Criando grupos ## Conceituação -Este método é reponsavel por criar um grupo com seus respectivos participantes. Infelizmente não é possivel criar o grupo com imagem, mas você pode logo após a criação utilizar-se do método Update-group-photo que esta nesta mesma sessão. +Este método é responsável por criar um grupo com seus respectivos participantes. Infelizmente não é possivel criar o grupo com imagem, mas você pode logo após a criação utilizar-se do método Update-group-photo que esta nesta mesma sessão. :::tip Dica @@ -94,7 +94,7 @@ Forma nova ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/group/group-invitation-metadata.md b/docs/group/group-invitation-metadata.md index 171c71e..a346673 100644 --- a/docs/group/group-invitation-metadata.md +++ b/docs/group/group-invitation-metadata.md @@ -102,7 +102,7 @@ Forma antiga - ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/group/leave-group.md b/docs/group/leave-group.md index eec8720..201185e 100644 --- a/docs/group/leave-group.md +++ b/docs/group/leave-group.md @@ -81,7 +81,7 @@ Forma nova - ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/group/metadata-group.md b/docs/group/metadata-group.md index dd4b106..e54f8ba 100644 --- a/docs/group/metadata-group.md +++ b/docs/group/metadata-group.md @@ -125,7 +125,7 @@ Forma antiga - ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/group/remove-admin.md b/docs/group/remove-admin.md index 81b5d47..d114bf5 100644 --- a/docs/group/remove-admin.md +++ b/docs/group/remove-admin.md @@ -11,7 +11,7 @@ title: Remover admin do grupo ## Conceituação -Este método é reponsavel remover um ou mais admistradores de um grupo. +Este método é responsável remover um ou mais admistradores de um grupo. :::caution Atenção @@ -85,7 +85,7 @@ Forma nova - ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/group/remove-participant.md b/docs/group/remove-participant.md index 882434c..b6c3a5b 100644 --- a/docs/group/remove-participant.md +++ b/docs/group/remove-participant.md @@ -12,7 +12,7 @@ title: Remove Participantes ## Conceituação -Este método é reponsável por remover participantes do grupo. +Este método é responsável por remover participantes do grupo. :::caution Atenção @@ -84,7 +84,7 @@ Forma nova - ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/group/update-group-description.md b/docs/group/update-group-description.md index 23d2a92..cc1257f 100644 --- a/docs/group/update-group-description.md +++ b/docs/group/update-group-description.md @@ -78,7 +78,7 @@ Forma nova - ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/group/update-group-name.md b/docs/group/update-group-name.md index 67a9733..8478594 100644 --- a/docs/group/update-group-name.md +++ b/docs/group/update-group-name.md @@ -13,7 +13,7 @@ title: Atualizar nome do grupo ## Conceituação -Este método é reponsavel alterar o nome de um grupo já existente. +Este método é responsável alterar o nome de um grupo já existente. :::caution Atenção @@ -85,7 +85,7 @@ Forma nova - ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/group/update-group-photo.md b/docs/group/update-group-photo.md index d6c3de4..06097fd 100644 --- a/docs/group/update-group-photo.md +++ b/docs/group/update-group-photo.md @@ -13,7 +13,7 @@ title: Atualizar imagem do grupo ## Conceituação -Este método é reponsavel alterar a imagem de um grupo já existente. +Este método é responsável alterar a imagem de um grupo já existente. :::caution Atenção @@ -82,7 +82,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/group/update-group-settings.md b/docs/group/update-group-settings.md index 97b89d5..431345c 100644 --- a/docs/group/update-group-settings.md +++ b/docs/group/update-group-settings.md @@ -79,7 +79,7 @@ Forma nova - ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/instance/rename-instance.md b/docs/instance/rename-instance.md new file mode 100644 index 0000000..0a6c1a7 --- /dev/null +++ b/docs/instance/rename-instance.md @@ -0,0 +1,68 @@ +--- +id: rename-instance +title: Renomear instância +--- + +## Método + +#### /update-name + +`PUT` + +--- + +## Conceituação + +Método utilizado para renomear uma instância. + +--- + +## Atributos + +| Atributos | Tipo | Descrição | +| :-------- | :----: | :------------------------- | +| value | string | Novo nome para a instância | + +--- + +## Request Body + +**Método** + +`PUT` + +**Exemplo** + +```json +Body +{ +"value": "novo nome" +} +``` + +--- + +## Response + +### 200 + +```json +Return +{ + "value": true +} +``` + +### 405 + +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. + +### 415 + +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" + +--- + +## Code + + diff --git a/docs/instance/restart.md b/docs/instance/restart.md index fb0d017..f58ca34 100644 --- a/docs/instance/restart.md +++ b/docs/instance/restart.md @@ -33,7 +33,7 @@ Este método basicamente é o botão "Reiniciar" do seu sistema operacional ou s ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/instance/restore-session.md b/docs/instance/restore-session.md index 286513d..3a6e32a 100644 --- a/docs/instance/restore-session.md +++ b/docs/instance/restore-session.md @@ -29,7 +29,7 @@ Este método tenta restaurar a sua conexão com Whatsapp com base nas informaç ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/message/delete-message.md b/docs/message/delete-message.md index 05ca2cd..04a9d34 100644 --- a/docs/message/delete-message.md +++ b/docs/message/delete-message.md @@ -65,7 +65,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/message/read-message.md b/docs/message/read-message.md index 08daf6d..a59bc2e 100644 --- a/docs/message/read-message.md +++ b/docs/message/read-message.md @@ -63,7 +63,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/message/reply-message.md b/docs/message/reply-message.md index 2322e6f..1bcef70 100644 --- a/docs/message/reply-message.md +++ b/docs/message/reply-message.md @@ -53,7 +53,7 @@ Caso tenha qualquer dúvida sobre como enviar uma mensagem de texto, você pode ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/message/send-button-list.md b/docs/message/send-button-list.md index 110764d..52f9882 100644 --- a/docs/message/send-button-list.md +++ b/docs/message/send-button-list.md @@ -96,7 +96,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/message/send-message-audio.md b/docs/message/send-message-audio.md index ca77ad2..4ca6773 100644 --- a/docs/message/send-message-audio.md +++ b/docs/message/send-message-audio.md @@ -13,7 +13,7 @@ title: Enviar áudio ## Conceituação -Método responsavel por enviar audios para os seus chats, você pode trabalhar com as audios de 2 formas que são: +Método responsável por enviar audios para os seus chats, você pode trabalhar com as audios de 2 formas que são: Por Link, onde você temum audio hospedado em algum lugar da internet e envia apenas o link da mesma. @@ -78,7 +78,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/message/send-message-contact.md b/docs/message/send-message-contact.md index 7cbea4f..6306b49 100644 --- a/docs/message/send-message-contact.md +++ b/docs/message/send-message-contact.md @@ -70,7 +70,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/message/send-message-document.md b/docs/message/send-message-document.md index e5ae049..bcbf117 100644 --- a/docs/message/send-message-document.md +++ b/docs/message/send-message-document.md @@ -80,7 +80,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/message/send-message-image.md b/docs/message/send-message-image.md index bd178c0..065a232 100644 --- a/docs/message/send-message-image.md +++ b/docs/message/send-message-image.md @@ -13,7 +13,7 @@ title: Enviar imagem ## Conceituação -Método responsavel por enviar imagens para os seus chats você pode trabalhar com as imagens de 2 formas que são: +Método responsável por enviar imagens para os seus chats você pode trabalhar com as imagens de 2 formas que são: - Por Link, onde você tem uma imagem hospedada em algum lugar da internet e envia apenas o link da mesma. @@ -105,7 +105,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/message/send-message-link.md b/docs/message/send-message-link.md index bae2b0b..0221847 100644 --- a/docs/message/send-message-link.md +++ b/docs/message/send-message-link.md @@ -13,7 +13,7 @@ title: Enviar link ## Conceituação -Método responsavel por enviar um link aos seus contatos, muito utilzado para compartilhar links para que os usuários sejam direcionados a um site. +Método responsável por enviar um link aos seus contatos, muito utilzado para compartilhar links para que os usuários sejam direcionados a um site. :::tip Sobre links @@ -80,7 +80,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/message/send-message-location.md b/docs/message/send-message-location.md index 6a23278..4dc04a1 100644 --- a/docs/message/send-message-location.md +++ b/docs/message/send-message-location.md @@ -13,7 +13,7 @@ title: Enviar localização ## Conceituação -Método responsavel por enviar uma localização fixa aos seus contatos, muito utilizado para enviar a localização de um endereços. +Método responsável por enviar uma localização fixa aos seus contatos, muito utilizado para enviar a localização de um endereços. --- @@ -72,7 +72,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/message/send-message-sticker.md b/docs/message/send-message-sticker.md index af843b5..3da49b7 100644 --- a/docs/message/send-message-sticker.md +++ b/docs/message/send-message-sticker.md @@ -13,7 +13,7 @@ title: Enviar sticker ## Conceituação -Método responsavel por enviar imagens para os seus chats você pode trabalhar com as imagens de 2 formas que são: +Método responsável por enviar imagens para os seus chats você pode trabalhar com as imagens de 2 formas que são: - Por Link, onde você tem um sticker hospedada em algum lugar da internet e envia apenas o link da mesma. @@ -102,7 +102,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/message/send-message-text.md b/docs/message/send-message-text.md index c39cec7..057aba3 100644 --- a/docs/message/send-message-text.md +++ b/docs/message/send-message-text.md @@ -92,7 +92,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/message/send-message-video.md b/docs/message/send-message-video.md index 75e3b04..7b19038 100644 --- a/docs/message/send-message-video.md +++ b/docs/message/send-message-video.md @@ -13,7 +13,7 @@ title: Enviar video ## Conceituação -Método responsavel por enviar audios para os seus chats, você pode trabalhar com as audios de 2 formas que são: +Método responsável por enviar audios para os seus chats, você pode trabalhar com as audios de 2 formas que são: Por Link, onde você temum video hospedado em algum lugar da internet e envia apenas o link da mesmo. @@ -78,7 +78,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/message/send-option-list.md b/docs/message/send-option-list.md index a3b347e..50e9571 100644 --- a/docs/message/send-option-list.md +++ b/docs/message/send-option-list.md @@ -109,7 +109,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/partner/create-instance.md b/docs/partner/create-instance.md index 190059a..0000dce 100644 --- a/docs/partner/create-instance.md +++ b/docs/partner/create-instance.md @@ -92,7 +92,7 @@ Caso você não realize a assinatura em até 2 dias nosso devops vai automaticam ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/partner/list-instances.md b/docs/partner/list-instances.md new file mode 100644 index 0000000..a126d00 --- /dev/null +++ b/docs/partner/list-instances.md @@ -0,0 +1,112 @@ +--- +id: list-instances +title: Listando instâncias +--- + +## Método + +#### /instances + +`GET` + +--- + +## Conceituação + +Método utilizado para listar todas as instâncias criadas. + +--- + +## Atributos + +### Obrigatórios + +| Atributos | Tipo | Descrição | +| :-- | :-: | :-- | +| page | integer | Utilizado para paginação você de informar aqui a pagina de chats que quer buscar | +| pageSize | integer | Especifica o tamanho do retorno de chats por pagina | +| query | number | Busca pelo nome e id da instancia | + +--- + +## Request Body + +**Método** + +`GET` + +**Exemplo** + +```json +{ + "pageSize": 1, + "page": 1, + "query": "8823XWIE982KII99012K2L" +} +``` + +--- + +## Response + +### 201 + +| Atributos | Tipo | Descrição | +| :-------- | :-------- | :---------------------------- | +| id | string | ID da instância criada | +| token | string | TOKEN da instância criada | +| due | timestamp | Data de validade da instância | + +**Exemplo** + +```json +{ + "total": 1, + "totalPage": 1, + "pageSize": 1, + "page": 1, + "content": [ + { + "token": "", + "tenant": "", + "created": "", + "due": 1648565999675, + "paymentStatus": "", + "deliveryCallbackUrl": "", + "receivedCallbackUrl": "", + "disconnectedCallbackUrl": "", + "messageStatusCallbackUrl": "", + "receivedAndDeliveryCallbackUrl": "", + "presenceChatCallbackUrl": "", + "connectedCallbackUrl": "", + "receivedStatusCallbackUrl": "", + "phoneConnected": false, + "whatsappConnected": false, + "name": "", + "id": "" + } + ] +} +``` + +### 405 + +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. + +### 415 + +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" + +--- + +## Webhook Response + +Link para a response do webhook (ao receber) + +[Webhook](../webhooks/on-message-received#response) + +--- + +## Code + + diff --git a/docs/partner/sign-instance.md b/docs/partner/sign-instance.md index 3c6e653..d2a06cd 100644 --- a/docs/partner/sign-instance.md +++ b/docs/partner/sign-instance.md @@ -55,7 +55,7 @@ OK ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/partner/unsubscribe-instance.md b/docs/partner/unsubscribe-instance.md index de964ee..7232dd2 100644 --- a/docs/partner/unsubscribe-instance.md +++ b/docs/partner/unsubscribe-instance.md @@ -55,7 +55,7 @@ OK ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/queue/delete-queue-id.md b/docs/queue/delete-queue-id.md index 7f52245..843ce96 100644 --- a/docs/queue/delete-queue-id.md +++ b/docs/queue/delete-queue-id.md @@ -11,7 +11,7 @@ title: Apagando msg fila ## Conceituação -Este método é reponsavel por deletar uma mensagem dentro de fila aguardando para ser processada. +Este método é responsável por deletar uma mensagem dentro de fila aguardando para ser processada. --- @@ -47,7 +47,7 @@ Método ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/queue/delete-queue.md b/docs/queue/delete-queue.md index c49789b..ad021de 100644 --- a/docs/queue/delete-queue.md +++ b/docs/queue/delete-queue.md @@ -11,7 +11,7 @@ title: Apagando uma Fila ## Conceituação -Este método é reponsavel por DELETAR todas mensagens que estão em sua fila aguardando para ser processada. +Este método é responsável por DELETAR todas mensagens que estão em sua fila aguardando para ser processada. --- @@ -47,7 +47,7 @@ Método ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/queue/get-queue.md b/docs/queue/get-queue.md index 0c537f2..ee17268 100644 --- a/docs/queue/get-queue.md +++ b/docs/queue/get-queue.md @@ -11,7 +11,7 @@ title: Fila ## Conceituação -Este método é reponsavel por retornar todas mensagens que estão em sua fila aguardando para ser processada. +Este método é responsável por retornar todas mensagens que estão em sua fila aguardando para ser processada. --- @@ -87,7 +87,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/status/send-image-status.md b/docs/status/send-image-status.md index 1d7d6df..c1294d9 100644 --- a/docs/status/send-image-status.md +++ b/docs/status/send-image-status.md @@ -13,7 +13,7 @@ title: Enviando imagem status ## Conceituação -Método responsavel por enviar uma imagem para seu status, lembre-se que os status somem após 24 horas. +Método responsável por enviar uma imagem para seu status, lembre-se que os status somem após 24 horas. --- @@ -77,7 +77,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/status/send-text-status.md b/docs/status/send-text-status.md index 1be285b..1bdbc19 100644 --- a/docs/status/send-text-status.md +++ b/docs/status/send-text-status.md @@ -13,7 +13,7 @@ title: Enviando texto status ## Conceituação -Você pode postar textos no seu status e este método é responsavel por isso, lembre-se que os status somem após 24 horas. +Você pode postar textos no seu status e este método é responsável por isso, lembre-se que os status somem após 24 horas. --- @@ -73,7 +73,7 @@ Exemplo ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/webhooks/introduction.md b/docs/webhooks/introduction.md index 6a16c96..fadc815 100644 --- a/docs/webhooks/introduction.md +++ b/docs/webhooks/introduction.md @@ -29,7 +29,7 @@ Então se você está se integrando com o Z-API e precisa receber informações #### Delivery -Responsavel por avisar você que sua mensagem foi entregue ao Whatsapp, mas isso não significa necessáriamente que seu contato a recebeu, para informações de recebimento e leitura você vai precisar observar o webhook de status. +Responsável por avisar você que sua mensagem foi entregue ao Whatsapp, mas isso não significa necessáriamente que seu contato a recebeu, para informações de recebimento e leitura você vai precisar observar o webhook de status. #### Receive diff --git a/docs/webhooks/on-chat-presence.md b/docs/webhooks/on-chat-presence.md index e72e66b..1b8d0dc 100644 --- a/docs/webhooks/on-chat-presence.md +++ b/docs/webhooks/on-chat-presence.md @@ -137,7 +137,7 @@ O stauts **RECORDING** apenas é retornado se estiver usando o beta multi-device ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/webhooks/on-message-received.md b/docs/webhooks/on-message-received.md index 7222e32..3df2aa5 100644 --- a/docs/webhooks/on-message-received.md +++ b/docs/webhooks/on-message-received.md @@ -462,7 +462,7 @@ Para atualizar a rota do webhook é possível fazer isso pela API ou pelo painel ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/webhooks/on-message-send.md b/docs/webhooks/on-message-send.md index f0b15a8..d58402d 100644 --- a/docs/webhooks/on-message-send.md +++ b/docs/webhooks/on-message-send.md @@ -85,7 +85,7 @@ Os possíveis retornos do webhook **on-message-send** estão cadastrado logo aba ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/webhooks/on-webhook-connected.md b/docs/webhooks/on-webhook-connected.md new file mode 100644 index 0000000..dd195f8 --- /dev/null +++ b/docs/webhooks/on-webhook-connected.md @@ -0,0 +1,89 @@ +--- +id: on-webhook-connected +title: Confirmar conexão +--- + +## Método + +#### `POST` on-whatsapp-connected + +## Conceituação + +Esse é o webhook de retorno de conexão do Celular com o Z-api + +:::caution Atenção + +O Z-API não aceita webhooks que não sejam HTTPS + +::: + +--- + +## Atualizando Webhook + +Para atualizar a rota do webhook é possível fazer isso pela API ou pelo painel administrativo. + +### API + +#### /update-webhook-connected + +`PUT` + +#### Request Body + +#### Body + +```json +{ + "value": "https://endereco-do-seu-sistema.com.br/instancia/SUA_INSTANCIA/status" +} +``` + +--- + +### Painel Administrativo + +![img](../../img/status.png) + +--- + +## Atributos + +### Obrigatórios + +| Atributos | Tipo | Descrição | +| :-- | :-: | :-- | +| status | string | Tipo do status no qual a mensagem se encontra. | +| id | string | Identificador(es) da(s) mensagem(ns). | +| phone | string | Número de telefone de destino da mensagem. | +| momment | string | Momento em que a instância foi desconectada do número. | +| type | string | Tipo do evento da instância, nesse caso será "MessageStatusCallback". | + +--- + +## Response + +### 200 + +```json +{ + "status": "MESSAGE_RECEIVED", + "ids": ["999999999999999999999"], + "momment": 1632234645000, + "phone": "5544999999999", + "type": "MessageStatusCallback" +} +``` + +### 405 + +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. + +### 415 + +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" + + diff --git a/docs/webhooks/on-whatsapp-disconnected.md b/docs/webhooks/on-whatsapp-disconnected.md index e242aa5..eb7bb13 100644 --- a/docs/webhooks/on-whatsapp-disconnected.md +++ b/docs/webhooks/on-whatsapp-disconnected.md @@ -75,7 +75,7 @@ Para atualizar a rota do webhook é possível fazer isso pela API ou pelo painel ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/webhooks/on-whatsapp-message-status-changes.md b/docs/webhooks/on-whatsapp-message-status-changes.md index 63bb0e4..601e31b 100644 --- a/docs/webhooks/on-whatsapp-message-status-changes.md +++ b/docs/webhooks/on-whatsapp-message-status-changes.md @@ -77,7 +77,7 @@ Para atualizar a rota do webhook é possível fazer isso pela API ou pelo painel ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/webhooks/webhooksConf/update-webhook-delivery.md b/docs/webhooks/webhooksConf/update-webhook-delivery.md index e6f503a..ec1a54b 100644 --- a/docs/webhooks/webhooksConf/update-webhook-delivery.md +++ b/docs/webhooks/webhooksConf/update-webhook-delivery.md @@ -12,7 +12,7 @@ title: Delivery ## Conceituação -O Este método é reponsavel por atualizar/adicionar o seu EndPoint para o webhook de **delivery** via API, ou seja, sem a necessidade de acessar o admin Z-API. +O Este método é responsável por atualizar/adicionar o seu EndPoint para o webhook de **delivery** via API, ou seja, sem a necessidade de acessar o admin Z-API. :::caution Atenção @@ -63,7 +63,7 @@ O Z-API não aceita webhooks que não sejam HTTPS ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/webhooks/webhooksConf/update-webhook-disconnected.md b/docs/webhooks/webhooksConf/update-webhook-disconnected.md index fd9861a..724eccc 100644 --- a/docs/webhooks/webhooksConf/update-webhook-disconnected.md +++ b/docs/webhooks/webhooksConf/update-webhook-disconnected.md @@ -12,7 +12,7 @@ title: Disconnected ## Conceituação -O Z-API oferece dentro das configurações da instância no painel admin o apontamento de webhooks para que ele possa notificar você sobre interações com seus chats/contatos. Este método é reponsavel por atualizar/adicionar esta informação via API, com ele você pode configurar os webhooks sem a necessidade de acessar o admin Z-API. +O Z-API oferece dentro das configurações da instância no painel admin o apontamento de webhooks para que ele possa notificar você sobre interações com seus chats/contatos. Este método é responsável por atualizar/adicionar esta informação via API, com ele você pode configurar os webhooks sem a necessidade de acessar o admin Z-API. :::caution Atenção @@ -59,7 +59,7 @@ O Z-API não aceita webhooks que não sejam HTTPS ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/webhooks/webhooksConf/update-webhook-message-status.md b/docs/webhooks/webhooksConf/update-webhook-message-status.md index 5398c4f..6820ee9 100644 --- a/docs/webhooks/webhooksConf/update-webhook-message-status.md +++ b/docs/webhooks/webhooksConf/update-webhook-message-status.md @@ -14,7 +14,7 @@ title: Status ## Conceituação -O Este método é reponsavel por atualizar/adicionar o seu EndPoint para o webhook de status via API ou seja, sem a necessidade de acessar o admin Z-API. +O Este método é responsável por atualizar/adicionar o seu EndPoint para o webhook de status via API ou seja, sem a necessidade de acessar o admin Z-API. :::caution Atenção @@ -61,7 +61,7 @@ O Z-API não aceita webhooks que não sejam HTTPS ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/docs/webhooks/webhooksConf/update-webhook-receive.md b/docs/webhooks/webhooksConf/update-webhook-receive.md index f9019ff..ea318ec 100644 --- a/docs/webhooks/webhooksConf/update-webhook-receive.md +++ b/docs/webhooks/webhooksConf/update-webhook-receive.md @@ -12,7 +12,7 @@ title: Receive ## Conceituação -O Z-API oferece dentro das configurações da instância no painel admin o apontamento de webhooks para que ele possa notificar você sobre interações com seus chats/contatos. Este método é reponsavel por atualizar/adicionar esta informação via API, com ele você pode configurar os webhooks sem a necessidade de acessar o admin Z-API. +O Z-API oferece dentro das configurações da instância no painel admin o apontamento de webhooks para que ele possa notificar você sobre interações com seus chats/contatos. Este método é responsável por atualizar/adicionar esta informação via API, com ele você pode configurar os webhooks sem a necessidade de acessar o admin Z-API. :::caution Atenção @@ -59,7 +59,7 @@ O Z-API não aceita webhooks que não sejam HTTPS ### 405 -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. +Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico. ### 415 diff --git a/json-examples/list-instances.json b/json-examples/list-instances.json new file mode 100644 index 0000000..9015f63 --- /dev/null +++ b/json-examples/list-instances.json @@ -0,0 +1,21 @@ +{ + "method": "GET", + "url": "https://api.z-api.io/instances", + "httpVersion": "HTTP/1.1", + "queryString": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "Bearer SEU-TOKEN-AQUI" + } + ], + "cookies": [], + "postData": { + "mimeType": "application/json", + "text": "{\"pageSize\": \"1\", \"page\": \"1\", \"query\": \"8823XWIE982KII99012K2L\"}" + } +} diff --git a/json-examples/rename-instance.json b/json-examples/rename-instance.json new file mode 100644 index 0000000..593994a --- /dev/null +++ b/json-examples/rename-instance.json @@ -0,0 +1,21 @@ +{ + "method": "PUT", + "url": "https://api.z-api.io/instances", + "httpVersion": "HTTP/1.1", + "queryString": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "Bearer SEU-TOKEN-AQUI" + } + ], + "cookies": [], + "postData": { + "mimeType": "application/json", + "text": "{\"value\": \"Name\"}" + } +} diff --git a/package-lock.json b/package-lock.json index afd6316..637e48f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -5,6 +5,7 @@ "requires": true, "packages": { "": { + "name": "z-api-docs", "version": "1.0.0", "dependencies": { "@docusaurus/core": "2.0.0-alpha.75", @@ -7617,11 +7618,28 @@ "resolved": "https://registry.npmjs.org/@types/parse-json/-/parse-json-4.0.0.tgz", "integrity": "sha512-//oorEZjL6sbPcKUaCdIGlIUeH26mgzimjBB77G6XRgnDl/L5wOnpyBGRe/Mmf5CVW3PwEBE1NjiMZ/ssFh4wA==" }, + "node_modules/@types/prop-types": { + "version": "15.7.5", + "resolved": "https://registry.npmjs.org/@types/prop-types/-/prop-types-15.7.5.tgz", + "integrity": "sha512-JCB8C6SnDoQf0cNycqd/35A7MjcnK+ZTqE7judS6o7utxUCg6imJg3QK2qzHKszlTjcj2cn+NwMB2i96ubpj7w==", + "peer": true + }, "node_modules/@types/q": { "version": "1.5.4", "resolved": "https://registry.npmjs.org/@types/q/-/q-1.5.4.tgz", "integrity": "sha512-1HcDas8SEj4z1Wc696tH56G8OlRaH/sqZOynNNB+HF0WOeXPaxTtbYzJY2oEfiUxjSKjhCKr+MvR7dCHcEelug==" }, + "node_modules/@types/react": { + "version": "17.0.50", + "resolved": "https://registry.npmjs.org/@types/react/-/react-17.0.50.tgz", + "integrity": "sha512-ZCBHzpDb5skMnc1zFXAXnL3l1FAdi+xZvwxK+PkglMmBrwjpp9nKaWuEvrGnSifCJmBFGxZOOFuwC6KH/s0NuA==", + "peer": true, + "dependencies": { + "@types/prop-types": "*", + "@types/scheduler": "*", + "csstype": "^3.0.2" + } + }, "node_modules/@types/sax": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/@types/sax/-/sax-1.2.1.tgz", @@ -7630,6 +7648,12 @@ "@types/node": "*" } }, + "node_modules/@types/scheduler": { + "version": "0.16.2", + "resolved": "https://registry.npmjs.org/@types/scheduler/-/scheduler-0.16.2.tgz", + "integrity": "sha512-hppQEBDmlwhFAXKJX2KnWLYu5yMfi91yazPb2l+lbJiwW+wdo1gNeRA+3RgNSO39WYX2euey41KEwnqesU2Jew==", + "peer": true + }, "node_modules/@types/unist": { "version": "2.0.3", "resolved": "https://registry.npmjs.org/@types/unist/-/unist-2.0.3.tgz", @@ -10766,6 +10790,12 @@ "node": ">=8.0.0" } }, + "node_modules/csstype": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.1.1.tgz", + "integrity": "sha512-DJR/VvkAvSZW9bTouZue2sSxDwdTN92uHjqeKVm+0dAqdfNykRzQ95tay8aXMBAAPpUiq4Qcug2L7neoRh2Egw==", + "peer": true + }, "node_modules/dashdash": { "version": "1.14.1", "resolved": "https://registry.npmjs.org/dashdash/-/dashdash-1.14.1.tgz", @@ -29438,11 +29468,28 @@ "resolved": "https://registry.npmjs.org/@types/parse-json/-/parse-json-4.0.0.tgz", "integrity": "sha512-//oorEZjL6sbPcKUaCdIGlIUeH26mgzimjBB77G6XRgnDl/L5wOnpyBGRe/Mmf5CVW3PwEBE1NjiMZ/ssFh4wA==" }, + "@types/prop-types": { + "version": "15.7.5", + "resolved": "https://registry.npmjs.org/@types/prop-types/-/prop-types-15.7.5.tgz", + "integrity": "sha512-JCB8C6SnDoQf0cNycqd/35A7MjcnK+ZTqE7judS6o7utxUCg6imJg3QK2qzHKszlTjcj2cn+NwMB2i96ubpj7w==", + "peer": true + }, "@types/q": { "version": "1.5.4", "resolved": "https://registry.npmjs.org/@types/q/-/q-1.5.4.tgz", "integrity": "sha512-1HcDas8SEj4z1Wc696tH56G8OlRaH/sqZOynNNB+HF0WOeXPaxTtbYzJY2oEfiUxjSKjhCKr+MvR7dCHcEelug==" }, + "@types/react": { + "version": "17.0.50", + "resolved": "https://registry.npmjs.org/@types/react/-/react-17.0.50.tgz", + "integrity": "sha512-ZCBHzpDb5skMnc1zFXAXnL3l1FAdi+xZvwxK+PkglMmBrwjpp9nKaWuEvrGnSifCJmBFGxZOOFuwC6KH/s0NuA==", + "peer": true, + "requires": { + "@types/prop-types": "*", + "@types/scheduler": "*", + "csstype": "^3.0.2" + } + }, "@types/sax": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/@types/sax/-/sax-1.2.1.tgz", @@ -29451,6 +29498,12 @@ "@types/node": "*" } }, + "@types/scheduler": { + "version": "0.16.2", + "resolved": "https://registry.npmjs.org/@types/scheduler/-/scheduler-0.16.2.tgz", + "integrity": "sha512-hppQEBDmlwhFAXKJX2KnWLYu5yMfi91yazPb2l+lbJiwW+wdo1gNeRA+3RgNSO39WYX2euey41KEwnqesU2Jew==", + "peer": true + }, "@types/unist": { "version": "2.0.3", "resolved": "https://registry.npmjs.org/@types/unist/-/unist-2.0.3.tgz", @@ -31739,6 +31792,12 @@ "css-tree": "^1.1.2" } }, + "csstype": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.1.1.tgz", + "integrity": "sha512-DJR/VvkAvSZW9bTouZue2sSxDwdTN92uHjqeKVm+0dAqdfNykRzQ95tay8aXMBAAPpUiq4Qcug2L7neoRh2Egw==", + "peer": true + }, "dashdash": { "version": "1.14.1", "resolved": "https://registry.npmjs.org/dashdash/-/dashdash-1.14.1.tgz", diff --git a/sidebars.js b/sidebars.js index 35f2e2b..e385f20 100644 --- a/sidebars.js +++ b/sidebars.js @@ -29,6 +29,7 @@ module.exports = { 'instance/disconnect', 'instance/status', 'instance/device', + 'instance/rename-instance', ], Mensagens: [ 'message/introduction', @@ -41,7 +42,7 @@ module.exports = { 'message/send-message-link', 'message/send-message-location', /* 'send-message/send-message-product', - 'send-message/send-message-catalog',*/ + 'send-message/send-message-catalog', */ 'message/send-message-contact', 'message/send-button-list', 'message/send-option-list', @@ -63,6 +64,7 @@ module.exports = { 'chats/get-metadata-chat', 'chats/archive-chat', 'chats/delete-chat', + 'chats/send-chat-expiration', ], Grupos: [ 'group/introduction', @@ -106,12 +108,14 @@ module.exports = { 'webhooks/on-whatsapp-disconnected', 'webhooks/on-whatsapp-message-status-changes', 'webhooks/on-chat-presence', + 'webhooks/on-webhook-connected', ], Parceiros: [ 'partner/introduction', 'partner/create-instance', 'partner/sign-instance', 'partner/unsubscribe-instance', + 'partner/list-instances', ], Integradores: ['integrators/find-my-pack'], diff --git a/yarn.lock b/yarn.lock index 271eec9..15efb78 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1938,11 +1938,25 @@ "resolved" "https://registry.npmjs.org/@types/parse5/-/parse5-5.0.3.tgz" "version" "5.0.3" +"@types/prop-types@*": + "integrity" "sha512-JCB8C6SnDoQf0cNycqd/35A7MjcnK+ZTqE7judS6o7utxUCg6imJg3QK2qzHKszlTjcj2cn+NwMB2i96ubpj7w==" + "resolved" "https://registry.npmjs.org/@types/prop-types/-/prop-types-15.7.5.tgz" + "version" "15.7.5" + "@types/q@^1.5.1": "integrity" "sha512-1HcDas8SEj4z1Wc696tH56G8OlRaH/sqZOynNNB+HF0WOeXPaxTtbYzJY2oEfiUxjSKjhCKr+MvR7dCHcEelug==" "resolved" "https://registry.npmjs.org/@types/q/-/q-1.5.4.tgz" "version" "1.5.4" +"@types/react@>= 16.8.0 < 18.0.0": + "integrity" "sha512-ZCBHzpDb5skMnc1zFXAXnL3l1FAdi+xZvwxK+PkglMmBrwjpp9nKaWuEvrGnSifCJmBFGxZOOFuwC6KH/s0NuA==" + "resolved" "https://registry.npmjs.org/@types/react/-/react-17.0.50.tgz" + "version" "17.0.50" + dependencies: + "@types/prop-types" "*" + "@types/scheduler" "*" + "csstype" "^3.0.2" + "@types/sax@^1.2.1": "integrity" "sha512-dqYdvN7Sbw8QT/0Ci5rhjE4/iCMJEM0Y9rHpCu+gGXD9Lwbz28t6HI2yegsB6BoV1sShRMU6lAmAcgRjmFy7LA==" "resolved" "https://registry.npmjs.org/@types/sax/-/sax-1.2.1.tgz" @@ -1950,6 +1964,11 @@ dependencies: "@types/node" "*" +"@types/scheduler@*": + "integrity" "sha512-hppQEBDmlwhFAXKJX2KnWLYu5yMfi91yazPb2l+lbJiwW+wdo1gNeRA+3RgNSO39WYX2euey41KEwnqesU2Jew==" + "resolved" "https://registry.npmjs.org/@types/scheduler/-/scheduler-0.16.2.tgz" + "version" "0.16.2" + "@types/unist@*", "@types/unist@^2.0.0", "@types/unist@^2.0.3": "integrity" "sha512-FvUupuM3rlRsRtCN+fDudtmytGO6iHJuuRKS1Ss0pG5z8oX0diNEw94UEL7hgDbpN94rgaK5R7sWm6RrSkZuAQ==" "resolved" "https://registry.npmjs.org/@types/unist/-/unist-2.0.3.tgz" @@ -3637,6 +3656,11 @@ dependencies: "css-tree" "^1.1.2" +"csstype@^3.0.2": + "integrity" "sha512-DJR/VvkAvSZW9bTouZue2sSxDwdTN92uHjqeKVm+0dAqdfNykRzQ95tay8aXMBAAPpUiq4Qcug2L7neoRh2Egw==" + "resolved" "https://registry.npmjs.org/csstype/-/csstype-3.1.1.tgz" + "version" "3.1.1" + "damerau-levenshtein@^1.0.6": "integrity" "sha512-JVrozIeElnj3QzfUIt8tB8YMluBJom4Vw9qTPpjGYQ9fYlB3D/rb6OordUxf3xeFB35LKWs0xqcO5U6ySvBtug==" "resolved" "https://registry.npmjs.org/damerau-levenshtein/-/damerau-levenshtein-1.0.6.tgz"