Skip to main content
GET
/
followups
/
configs
Listar configurações
curl --request GET \
  --url https://api.cordialy.ai/integrations/v1/followups/configs \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "is_active": true,
    "trigger_delay_minutes": 123,
    "message": "<string>",
    "objective": "<string>",
    "max_attempts": 123,
    "min_interval_minutes": 123,
    "created_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
X-API-Key
string
header
required

Chave de API gerada na plataforma em Integrações → API Keys

Response

200 - application/json

Lista de configurações

​
id
string<uuid>
​
name
string

Nome da configuração

​
is_active
boolean
​
trigger_type
enum<string>

silence = inatividade do lead, post_handover = após transferência, post_contact = após primeiro contato

Available options:
silence,
post_handover,
post_contact
​
trigger_delay_minutes
integer

Minutos após o trigger para disparar

​
followup_type
enum<string>

fixed_message = mensagem fixa, ai_objective = IA gera com base no objetivo

Available options:
fixed_message,
ai_objective
​
message
string | null

Mensagem enviada quando followup_type = fixed_message

​
objective
string | null

Objetivo passado à IA quando followup_type = ai_objective

​
max_attempts
integer

Número máximo de tentativas

​
min_interval_minutes
integer

Intervalo mínimo entre tentativas

​
created_at
string<date-time>