Skip to main content
GET
Get User State

Descrição

Gerencie o status operacional de um usuário dentro do seu canal. Você pode verificar se um contato está no modo manual ou automático e atualizar essa configuração para controlar quem responde às conversas.

Obter Status do Usuário

Endpoint

Parâmetros de Path

string
obrigatório
Número de telefone do usuário (sem o sinal +).

Exemplo de Resposta

Alterar Status do Usuário

Endpoint

Corpo da Requisição

number
Tempo em segundos que o estado manual permanecerá antes de expirar automaticamente.
string
obrigatório
Identificador do canal associado ao usuário.
string
obrigatório
Número de telefone do usuário (sem o sinal +).
string
obrigatório
Estado alvo. Valores permitidos: "manual" ou "auto".

Exemplo de Requisição

cURL

Exemplo de Resposta

Quando um usuário está no estado manual, o canal para de responder automaticamente e mensagens manuais devem ser enviadas usando os endpoints de envio. Certifique-se de coordenar a mudança de estado com sua equipe de suporte.

Erros Comuns

  • 400 - Não foi possível obter ou atualizar o status do usuário.
  • 401 - Credenciais inválidas ou ausentes.
  • 404 - Usuário ou canal não encontrado.

Autorizações

Authorization
string
header
obrigatório

Basic authentication using Base64 encoded clientId:clientSecret

Parâmetros de caminho

userId
string
obrigatório

Phone number without + sign

Resposta

User state retrieved

id
string
names
string
botId
string
groupId
string
state
enum<string>
Opções disponíveis:
auto,
manual