Skip to main content
POST
/
api
/
companies
/
{companyId}
/
blocked-contacts
curl -X POST https://api.disparador.com/api/companies/1/blocked-contacts \
  -H "Content-Type: application/json" \
  -H "X-Access-Token: seu-access-token" \
  -d '{
    "phoneNumber": "5511999887766",
    "reason": "Solicitação do cliente"
  }'

{
  "success": true,
  "message": "Contato bloqueado com sucesso",
  "data": {
    "id": 123,
    "phoneNumber": "5511999887766",
    "formattedPhoneNumber": "+55 11 99988-7766",
    "reason": "Solicitação do cliente",
    "blockedAt": "2024-01-20T14:30:00",
    "blockedBy": "[email protected]",
    "isActive": true
  }
}
Contatos bloqueados são automaticamente excluídos de todas as campanhas futuras da empresa.

​
Headers

​
X-Access-Token
string
required
Token de acesso da empresa
​
Content-Type
string
required
application/json

​
Path Parameters

​
companyId
number
required
ID da empresa (deve corresponder ao token)

​
Body

​
phoneNumber
string
required
Número de telefone a ser bloqueado
O número pode ser fornecido em qualquer formato. A API realizará a normalização automaticamente.
​
reason
string
Motivo do bloqueio (recomendado para auditoria)Exemplos:
  • “Solicitação do cliente”
  • “Número inválido/inexistente”
  • “Reclamação no SAC”
  • “Lista de opt-out LGPD”
curl -X POST https://api.disparador.com/api/companies/1/blocked-contacts \
  -H "Content-Type: application/json" \
  -H "X-Access-Token: seu-access-token" \
  -d '{
    "phoneNumber": "5511999887766",
    "reason": "Solicitação do cliente"
  }'

​
Response

​
success
boolean
Indica se a operação foi bem-sucedida
​
message
string
Mensagem de sucesso ou erro
​
data
object
Dados do contato bloqueado (quando sucesso)
{
  "success": true,
  "message": "Contato bloqueado com sucesso",
  "data": {
    "id": 123,
    "phoneNumber": "5511999887766",
    "formattedPhoneNumber": "+55 11 99988-7766",
    "reason": "Solicitação do cliente",
    "blockedAt": "2024-01-20T14:30:00",
    "blockedBy": "[email protected]",
    "isActive": true
  }
}

​
Validações

  • O número deve ser um telefone válido (mínimo 8 dígitos)
  • Números já bloqueados retornarão erro
  • O motivo do bloqueio não pode exceder 500 caracteres
  • O token deve ter permissão para a empresa especificada

​
Formatação de Números

A API aceita números em diversos formatos: 
// Todos estes formatos são aceitos:
"5511999887766"
"+5511999887766"
"55 11 99988-7766"
"(11) 99988-7766"
"+55 (11) 99988-7766"
"11999887766"  // Assumirá código do país +55

​
Auditoria

Todos os bloqueios são registrados com:
  • Data e hora exata do bloqueio
  • Usuário que realizou a ação (baseado no token)
  • Motivo fornecido (quando disponível)
Estas informações são importantes para conformidade com LGPD e outras regulamentações.