Pular para o conteúdo principal
POST
/
instances
/
integrator
/
on-demand
Criando uma instância
curl --request POST \
  --url https://api.z-api.io/instances/integrator/on-demand \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Conceituação

Método utilizado para criar uma instância vinculada a sua conta.
Você não precisa necessariamente assinar a instância neste momento pois você tem 2 dias para utilizar como trial. Após 2 dias sem assinatura, a instância é automaticamente deletada.
Para utilizar os endpoints de Partner, informe o Token de Parceiro no campo Authorization, no formato: Bearer <Partner-Token>Não é necessário enviar o Client-Token nessas requisições.

​
Atributos

​
Obrigatórios

​
name
string
obrigatório
Nome da instância

​
Opcionais

​
sessionName
string
Nome da sessão nos dispositivos conectados
​
deliveryCallbackUrl
string
URL webhook de mensagens enviadas
​
receivedCallbackUrl
string
URL webhook de mensagens recebidas
​
receivedAndDeliveryCallbackUrl
string
URL webhook de mensagens recebidas e enviadas por mim
​
presenceChatCallbackUrl
string
URL webhook status do chat
​
disconnectedCallbackUrl
string
URL webhook de desconexão
​
connectedCallbackUrl
string
URL webhook de conexão
​
messageStatusCallbackUrl
string
URL webhook status da mensagem
​
callRejectAuto
boolean
Rejeitar chamadas automaticamente
​
callRejectMessage
string
Mensagem ao rejeitar chamada
​
autoReadMessage
boolean
Leitura automática de mensagens
​
autoReadStatus
boolean
Leitura automática de status
​
isDevice
boolean
Instância mobile (true) ou web (false)
​
businessDevice
boolean
Versão WhatsApp Business
​
disableEnqueueWhenDisconnected
boolean
Habilitar/desabilitar fila quando desconectado

​
Request Body

{
  "name": "Minha instância"
}

​
Response

​
200

{
  "id": "instanceId",
  "token": "instanceToken",
  "due": 1648565999675
}

​
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”.