API atual/Referência completa/WhatsApp: caixa de entrada

Assumir e devolver

Passa a conversa do assistente para uma pessoa e de volta, ou zera o estado operacional da conversa.

Assumir a conversa

Força o modo pessoa (H): o assistente deixa de responder naquela conversa até alguém devolvê-la. Use quando um atendente quer entrar na conversa antes de escrever.

POST/api/v1/admin/whatsapp-confluence/threads/{id}/take-overAdmin

Assume a conversa

Parâmetros de caminho

iduuidobrigatório

Id da conversa.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/admin/whatsapp-confluence/threads/e661b36c-fe1b-450f-b75b-49d10c1ead48/take-over" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Feito

json

{
  "success": true
}

Campos da resposta

successboolean

Sempre true.

Erros

Status	Quando	Corpo de exemplo
500	Falha ao gravar.	`{"error":"..."}`
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem papel de administrador.	`{"error":"insufficient permissions"}`

Encerrar o atendimento

Devolve a conversa ao assistente (A). Chame quando a equipe terminou.

POST/api/v1/admin/whatsapp-confluence/threads/{id}/end-serviceAdmin

Devolve a conversa ao assistente

Parâmetros de caminho

iduuidobrigatório

Id da conversa.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/admin/whatsapp-confluence/threads/e661b36c-fe1b-450f-b75b-49d10c1ead48/end-service" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Feito

json

{
  "success": true
}

Campos da resposta

successboolean

Sempre true.

Erros

Status	Quando	Corpo de exemplo
500	Falha ao gravar.	`{"error":"..."}`
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem papel de administrador.	`{"error":"insufficient permissions"}`

Zerar a sessão

Volta a conversa ao estado inicial de operação sem apagar mensagens: assistente em A, atribuição removida e contador de não lidas zerado.

POST/api/v1/admin/whatsapp-confluence/threads/{id}/clear-sessionAdmin

Zera a sessão operacional

Parâmetros de caminho

iduuidobrigatório

Id da conversa.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/admin/whatsapp-confluence/threads/e661b36c-fe1b-450f-b75b-49d10c1ead48/clear-session" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Feito

json

{
  "success": true
}

Campos da resposta

successboolean

Sempre true.

Erros

Status	Quando	Corpo de exemplo
500	Falha ao gravar.	`{"error":"..."}`
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem papel de administrador.	`{"error":"insufficient permissions"}`

Veja também

API atual/Referência completa/WhatsApp: caixa de entrada

Assumir e devolver

Passa a conversa do assistente para uma pessoa e de volta, ou zera o estado operacional da conversa.

Assumir a conversa

Força o modo pessoa (H): o assistente deixa de responder naquela conversa até alguém devolvê-la. Use quando um atendente quer entrar na conversa antes de escrever.

POST/api/v1/admin/whatsapp-confluence/threads/{id}/take-overAdmin

Assume a conversa

Parâmetros de caminho

iduuidobrigatório

Id da conversa.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/admin/whatsapp-confluence/threads/e661b36c-fe1b-450f-b75b-49d10c1ead48/take-over" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Feito

json

{
  "success": true
}

Campos da resposta

successboolean

Sempre true.

Erros

Status	Quando	Corpo de exemplo
500	Falha ao gravar.	`{"error":"..."}`
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem papel de administrador.	`{"error":"insufficient permissions"}`

Encerrar o atendimento

Devolve a conversa ao assistente (A). Chame quando a equipe terminou.

POST/api/v1/admin/whatsapp-confluence/threads/{id}/end-serviceAdmin

Devolve a conversa ao assistente

Parâmetros de caminho

iduuidobrigatório

Id da conversa.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/admin/whatsapp-confluence/threads/e661b36c-fe1b-450f-b75b-49d10c1ead48/end-service" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Feito

json

{
  "success": true
}

Campos da resposta

successboolean

Sempre true.

Erros

Status	Quando	Corpo de exemplo
500	Falha ao gravar.	`{"error":"..."}`
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem papel de administrador.	`{"error":"insufficient permissions"}`

Zerar a sessão

Volta a conversa ao estado inicial de operação sem apagar mensagens: assistente em A, atribuição removida e contador de não lidas zerado.

POST/api/v1/admin/whatsapp-confluence/threads/{id}/clear-sessionAdmin

Zera a sessão operacional

Parâmetros de caminho

iduuidobrigatório

Id da conversa.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/admin/whatsapp-confluence/threads/e661b36c-fe1b-450f-b75b-49d10c1ead48/clear-session" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Feito

json

{
  "success": true
}

Campos da resposta

successboolean

Sempre true.

Erros

Status	Quando	Corpo de exemplo
500	Falha ao gravar.	`{"error":"..."}`
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem papel de administrador.	`{"error":"insufficient permissions"}`