Pular para o conteúdo principal

Criando uma instância

Método#

/on-demand#

POST https://api.z-api.io/instances/integrator/on-demand


Conceituação#

Método utilizado para criar uma instância vinculada a sua conta.

Dica

Você não precisa necessáriamente assinar a instância neste momento pois você tem 2 dias de para utilizar como trial.

Atenção

Exclusão de instância

Caso você não realize a assinatura em até 2 dias nosso devops vai automaticamente excluir a maquina conectada a instância. Então em casos de não assinaturas não precisa se preocupar :)


Atributos#

Obrigatórios#

AtributosTipoDescrição
namestringNome da instância a ser criada

Opcionais#

AtributosTipoDescrição
sessionNamestringAtributo para alterar o nome da sessão no whatsapp (em aparelhos conectados)
deliveryCallbackUrlstringEndPoint do webhook de mensagens entregues - delivery
receivedCallbackUrlstringEndPoint do webhook de mensagens recebidas - receive
receivedAndDeliveryCallbackUrlstringEndPoint do webhook de mensagens recebidas e enviadas por mim - receive
disconnectedCallbackUrlstringEndPoint do webhook de desconexão ou perca de comunicação - disconnected
connectedCallbackUrlstringEndPoint do webhook de conexão - connected
messageStatusCallbackUrlstringEndPoint do webhook de Status
callRejectAutobooleantrue ou false - Rejeitar chamadas automático
callRejectMessagestringMensagem após rejeitar uma chamada automáticamente
autoReadMessagebooleantrue ou false - Leitura automática
isDevicebooleanDefine se a instância será mobile ou web
businessDevicebooleanEscolha entre a versão empresarial ou normal do WhatsApp

Request Body#

Método

POST https://api.z-api.io/instances/integrator/on-demand

Exemplo

{
"name": "Instancia Z-API - 9292812",
"sessionName": "Testes testes",
"deliveryCallbackUrl": "https://meuwebhook.com.br/delivery",
"receivedCallbackUrl": "https://meuwebhook.com.br/receive",
"disconnectedCallbackUrl": "https://meuwebhook.com.br/disconnected",
"connectedCallbackUrl": "https://meuwebhook.com.br/connected",
"messageStatusCallbackUrl": "https://meuwebhook.com.br/status",
"isDevice": false,
"businessDevice": true
}

Response#

200#

AtributosTipoDescrição
idstringID da instância criada
tokenstringTOKEN da instância criada
duetimestampData de validade da instância

Exemplo

{
"id": "8823XWIE982KII99012K2L"
"token": "8900LS009W0011OOOPPIPIP00912OOLCKAOOOE009919"
"due": "329000002121"
}

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.

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


Code#