Assinando uma instância

Método#

/subscription#

POST https://api.z-api.io/instances/{id}/token/{token}/integrator/on-demand/subscription

Conceituação#

Método utilizado para assinar uma instância.

Atributos#

Obrigatórios#

Atributos	Tipo	Descrição

Opcionais#

Atributos	Tipo	Descrição
withCalls	boolean	Define se a instância será criada com suporte a chamadas (ligações)

Atenção

O atributo withCalls é opcional. Caso não seja enviado, a requisição continuará funcionando normalmente com o comportamento padrão. Este recurso está disponível apenas para contas que possuem a funcionalidade de chamadas habilitada.

Request Params#

Método

POST https://api.z-api.io/instances/SUA_INSTANCIA/token/{SEU_TOKEN}/integrator/on-demand/subscription

Request Body#

{
  "withCalls": true
}

Response#

201#

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