API atual/Referência completa/WhatsApp: atendimento

Controle do assistente

Consulta, pausa por um tempo e retoma o assistente automático em uma conversa específica.

O assistente de vendas responde sozinho enquanto bot_mode é A. Além de assumir a conversa de vez (veja Estado da conversa), é possível pausar o assistente por alguns minutos, por exemplo quando alguém da equipe vai responder pelo celular. Quando a pausa acaba, ele volta.

Consultar o modo

GET/api/v1/vendor/whatsapp-confluence/threads/{id}/botSeller

Retorna o modo de atendimento da conversa

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Parâmetros de caminho

iduuidobrigatório

Id da conversa (id de Listar conversas).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/whatsapp-confluence/threads/7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60/bot" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Modo

json

{
  "thread_id": "7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60",
  "mode": "P",
  "paused_until": "2026-10-10T16:35:00Z"
}

Campos da resposta

thread_iduuid

O id pedido.

modestring

APH

A assistente ativo, P pausado, H atendimento humano.

paused_untilstring

Fim da pausa (RFC 3339). Só aparece com mode: P.

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não é um seller, ou o seller ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`
404	Conversa de outro seller. Um id desconhecido também dá 404 em algumas rotas, mas 200 ou 502 em outras quando não há escopo de seller (veja a visão geral da seção).	`{"error":"thread not found"}`

Pausar o assistente

POST/api/v1/vendor/whatsapp-confluence/threads/{id}/bot/pauseSeller

Pausa o assistente por alguns minutos

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Content-Typestringobrigatório

application/json.

Parâmetros de caminho

iduuidobrigatório

Id da conversa (id de Listar conversas).

Corpo da requisição

minutesintegerpadrão: 120

Duração da pausa. Zero, negativo ou omitido usa o padrão da loja (bot_pause_on_echo_minutes, 120).

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/whatsapp-confluence/threads/7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60/bot/pause" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "minutes": 30
}'

Resposta

200Pausado

json

{
  "paused_until": "2026-10-10T16:35:00Z"
}

Campos da resposta

paused_untilstring

Quando a pausa termina (RFC 3339).

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não é um seller, ou o seller ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`
404	Conversa de outro seller. Um id desconhecido também dá 404 em algumas rotas, mas 200 ou 502 em outras quando não há escopo de seller (veja a visão geral da seção).	`{"error":"thread not found"}`

Retomar o assistente

POST/api/v1/vendor/whatsapp-confluence/threads/{id}/bot/resumeSeller

Volta o assistente a responder

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Parâmetros de caminho

iduuidobrigatório

Id da conversa (id de Listar conversas).

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/whatsapp-confluence/threads/7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60/bot/resume" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Retomado

json

{
  "status": "ok"
}

Campos da resposta

statusstring

Sempre ok.

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não é um seller, ou o seller ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`
404	Conversa de outro seller. Um id desconhecido também dá 404 em algumas rotas, mas 200 ou 502 em outras quando não há escopo de seller (veja a visão geral da seção).	`{"error":"thread not found"}`
500	Falha interna ao ler ou gravar.	`{"error":"..."}`

Veja também

API atual/Referência completa/WhatsApp: atendimento

Controle do assistente

Consulta, pausa por um tempo e retoma o assistente automático em uma conversa específica.

Consultar o modo

GET/api/v1/vendor/whatsapp-confluence/threads/{id}/botSeller

Retorna o modo de atendimento da conversa

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Parâmetros de caminho

iduuidobrigatório

Id da conversa (id de Listar conversas).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/whatsapp-confluence/threads/7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60/bot" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Modo

json

{
  "thread_id": "7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60",
  "mode": "P",
  "paused_until": "2026-10-10T16:35:00Z"
}

Campos da resposta

thread_iduuid

O id pedido.

modestring

APH

A assistente ativo, P pausado, H atendimento humano.

paused_untilstring

Fim da pausa (RFC 3339). Só aparece com mode: P.

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não é um seller, ou o seller ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`
404	Conversa de outro seller. Um id desconhecido também dá 404 em algumas rotas, mas 200 ou 502 em outras quando não há escopo de seller (veja a visão geral da seção).	`{"error":"thread not found"}`

Pausar o assistente

POST/api/v1/vendor/whatsapp-confluence/threads/{id}/bot/pauseSeller

Pausa o assistente por alguns minutos

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Content-Typestringobrigatório

application/json.

Parâmetros de caminho

iduuidobrigatório

Id da conversa (id de Listar conversas).

Corpo da requisição

minutesintegerpadrão: 120

Duração da pausa. Zero, negativo ou omitido usa o padrão da loja (bot_pause_on_echo_minutes, 120).

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/whatsapp-confluence/threads/7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60/bot/pause" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "minutes": 30
}'

Resposta

200Pausado

json

{
  "paused_until": "2026-10-10T16:35:00Z"
}

Campos da resposta

paused_untilstring

Quando a pausa termina (RFC 3339).

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não é um seller, ou o seller ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`
404	Conversa de outro seller. Um id desconhecido também dá 404 em algumas rotas, mas 200 ou 502 em outras quando não há escopo de seller (veja a visão geral da seção).	`{"error":"thread not found"}`

Retomar o assistente

POST/api/v1/vendor/whatsapp-confluence/threads/{id}/bot/resumeSeller

Volta o assistente a responder

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Parâmetros de caminho

iduuidobrigatório

Id da conversa (id de Listar conversas).

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/whatsapp-confluence/threads/7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60/bot/resume" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Retomado

json

{
  "status": "ok"
}

Campos da resposta

statusstring

Sempre ok.

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não é um seller, ou o seller ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`
404	Conversa de outro seller. Um id desconhecido também dá 404 em algumas rotas, mas 200 ou 502 em outras quando não há escopo de seller (veja a visão geral da seção).	`{"error":"thread not found"}`
500	Falha interna ao ler ou gravar.	`{"error":"..."}`