Iniciar sessao TypeBot

curl --request POST \ --url https://api.vzaps.com/instances/{id}/typebots/sessions/start \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "public_id": "dev", "phone": "5532999999999", "push_name": "Gustavo Almeida", "message": "Ola" } '

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

string

obrigatório

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

Exemplo:

"VZ9K2M4N8P1Q3R5S7T0WABCD01EF"

Corpo

application/json

public_id

string

obrigatório

ID publico do TypeBot configurado na instancia.

Exemplo:

"dev"

phone

string

obrigatório

Telefone do contato, com DDI e somente digitos.

Exemplo:

"5532999999999"

message

string

obrigatório

Mensagem inicial enviada ao TypeBot.

Exemplo:

"Ola"

push_name

string

Nome opcional do contato enviado ao TypeBot como pushName.

Exemplo:

"Gustavo Almeida"

Resposta

status

string

Exemplo:

"ok"