Pular para o conteúdo principal
POST
/
instances
/
{id}
/
typebots
/
sessions
/
{session}
/
close
Encerrar sessao TypeBot
curl --request POST \
  --url https://api.vzaps.com/instances/{id}/typebots/sessions/{session}/close \
  --header 'Authorization: Bearer <token>'
{
  "status": "ok",
  "closed": 123,
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "phone": "<string>"
}

Autorizações

​
Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

​
id
string
obrigatório

Identificador publico da instancia no formato gerado pela plataforma: prefixo VZ seguido de caracteres alfanumericos.

Exemplo:

"VZ9K2M4N8P1Q3R5S7T0WABCD01EF"

​
session
string
obrigatório

Identificador da sessao TypeBot. Aceita dois formatos:

  • UUID da sessao (string<uuid>) — encerra exatamente aquela sessao. Use quando voce obteve o ID pela listagem de sessoes.
  • Numero de telefone do contato (so os digitos, ex.: 5532988776655; +, espacos e tracos sao ignorados) — encerra todas as sessoes ativas (opened ou paused) desse contato na instancia. Util quando o atendente humano precisa assumir a conversa e so tem o numero em maos.
Exemplo:

"5532988776655"

Resposta

OK

​
status
string
Exemplo:

"ok"

​
closed
integer

Quantidade de sessoes encerradas.

​
session_id
string<uuid>

Presente quando o path traz um UUID.

​
phone
string

Digitos normalizados quando o path traz um telefone.