API atual/Referência completa/WhatsApp: atendimento

Estado da conversa

Marca como lida, atribui a um atendente, assume do assistente, devolve ao assistente e reinicia a sessão da conversa.

Cada conversa tem um contador de não lidas, um responsável opcional e um modo de atendimento (bot_mode): A o assistente responde, P o assistente está pausado por um tempo, H uma pessoa atende. Estas cinco ações movem a conversa entre esses estados. Todas respondem {"success": true} e usam o mesmo corpo vazio.

Marcar como lida

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

Zera o contador de não lidas

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/read" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Feito

json

{
  "success": true
}

Campos da resposta

successboolean

Sempre true.

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":"..."}`

Atribuir

Para tirar o responsável, mande user_id vazio ou um corpo vazio.

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

Define ou limpa o responsável

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

user_iduuid

Usuário da equipe responsável. Vazio desatribui.

assignee_iduuid

Apelido de user_id. null desatribui.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/whatsapp-confluence/threads/7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60/assign" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "user_id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d"
}'

Resposta

200Feito

json

{
  "success": true
}

Campos da resposta

successboolean

Sempre true.

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"}`
400	O corpo tem um campo do tipo errado, por exemplo `assignee_id: 5`. A conversa não é alterada.	`{"error":"invalid request body: json: cannot unmarshal number into Go struct field .assignee_id of type string"}`
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	`user_id` não é um UUID válido, ou falha interna.	`{"error":"..."}`

Assumir

Coloca bot_mode em H: o assistente deixa de responder até alguém devolver. Responder pela caixa já faz isso sozinho; use esta rota para assumir antes de escrever.

POST/api/v1/vendor/whatsapp-confluence/threads/{id}/take-overSeller

Passa a conversa para o atendimento humano

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/take-over" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Feito

json

{
  "success": true
}

Campos da resposta

successboolean

Sempre true.

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":"..."}`

Encerrar atendimento

Coloca bot_mode em A. Use quando o atendente terminou. A conversa também volta sozinha ao assistente quando ninguém responde a tempo ou o cliente não retorna (veja handoff_timeout).

POST/api/v1/vendor/whatsapp-confluence/threads/{id}/end-serviceSeller

Devolve a conversa ao assistente

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/end-service" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Feito

json

{
  "success": true
}

Campos da resposta

successboolean

Sempre true.

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":"..."}`

Reiniciar a sessão

Faz três coisas de uma vez: devolve ao assistente (A), remove o responsável e zera as não lidas. As mensagens não são apagadas. A próxima saudação do cliente recebe a mensagem de boas-vindas de novo.

POST/api/v1/vendor/whatsapp-confluence/threads/{id}/clear-sessionSeller

Recomeça a conversa do zero para o assistente

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/clear-session" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Feito

json

{
  "success": true
}

Campos da resposta

successboolean

Sempre true.

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

Estado da conversa

Marca como lida, atribui a um atendente, assume do assistente, devolve ao assistente e reinicia a sessão da conversa.

Marcar como lida

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

Zera o contador de não lidas

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/read" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Feito

json

{
  "success": true
}

Campos da resposta

successboolean

Sempre true.

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":"..."}`

Atribuir

Para tirar o responsável, mande user_id vazio ou um corpo vazio.

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

Define ou limpa o responsável

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

user_iduuid

Usuário da equipe responsável. Vazio desatribui.

assignee_iduuid

Apelido de user_id. null desatribui.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/whatsapp-confluence/threads/7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60/assign" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "user_id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d"
}'

Resposta

200Feito

json

{
  "success": true
}

Campos da resposta

successboolean

Sempre true.

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"}`
400	O corpo tem um campo do tipo errado, por exemplo `assignee_id: 5`. A conversa não é alterada.	`{"error":"invalid request body: json: cannot unmarshal number into Go struct field .assignee_id of type string"}`
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	`user_id` não é um UUID válido, ou falha interna.	`{"error":"..."}`

Assumir

Coloca bot_mode em H: o assistente deixa de responder até alguém devolver. Responder pela caixa já faz isso sozinho; use esta rota para assumir antes de escrever.

POST/api/v1/vendor/whatsapp-confluence/threads/{id}/take-overSeller

Passa a conversa para o atendimento humano

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/take-over" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Feito

json

{
  "success": true
}

Campos da resposta

successboolean

Sempre true.

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":"..."}`

Encerrar atendimento

Coloca bot_mode em A. Use quando o atendente terminou. A conversa também volta sozinha ao assistente quando ninguém responde a tempo ou o cliente não retorna (veja handoff_timeout).

POST/api/v1/vendor/whatsapp-confluence/threads/{id}/end-serviceSeller

Devolve a conversa ao assistente

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/end-service" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Feito

json

{
  "success": true
}

Campos da resposta

successboolean

Sempre true.

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":"..."}`

Reiniciar a sessão

POST/api/v1/vendor/whatsapp-confluence/threads/{id}/clear-sessionSeller

Recomeça a conversa do zero para o assistente

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/clear-session" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Feito

json

{
  "success": true
}

Campos da resposta

successboolean

Sempre true.

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":"..."}`