- Investigated the real callcenter_config command surface via
'help callcenter_config' on the running FreeSWITCH before writing any
code: queues only have load/unload/reload (static XML + reload, no
'queue add' exists), while agents and tiers are fully dynamic via ESL
commands (agent add, tier add) -- no file involved. This shapes the next
phase (Agents/Tiers) differently from this one.
- queues table (tenant-scoped, RLS): strategy, moh/announce, wait times,
tier rules, discard/abandoned handling, skip-agents-with-external-calls,
recording_enabled
- packages/telephony: buildQueueXml()
- infrastructure/freeswitch: our own callcenter.conf.xml override (empties
the vanilla static agents/tiers -- those become fully dynamic in the next
phase) that includes callcenter_queues.conf.d/*.xml via X-PRE-PROCESS,
same pattern as the Sofia gateway directory
- apps/api/src/queues: CRUD (POST/GET/GET:id/DELETE) using the queues.view/
.manage permissions already in the seed
- b2bcall-fs-config (queue-sync.ts): one XML file per queue on a shared
volume, synced via Redis pub/sub (b2bcall:queues:sync) on create/delete
and once at boot -- same shape as trunk-sync.ts
- confirmed manually against the real FreeSWITCH, before coding the sync
logic: 'queue load <name>' fails ('Invalid Queue not found!') for a file
added after boot -- needs 'reloadxml' first to repopulate the in-memory
XML tree from disk; after that, 'queue reload <name>' alone handles both
create and update, no need to distinguish load vs reload
- verified end-to-end: created a queue (ROUND_ROBIN, maxWaitTime=120,
discardAbandonedAfter=90), 'callcenter_config queue list' showed the
correct values on the FreeSWITCH side; deleted it, list went back empty
docs/QUEUES.md
441 lines
14 KiB
Plaintext
441 lines
14 KiB
Plaintext
generator client {
|
|
provider = "prisma-client-js"
|
|
}
|
|
|
|
datasource db {
|
|
provider = "postgresql"
|
|
}
|
|
|
|
enum TenantStatus {
|
|
TRIAL
|
|
ACTIVE
|
|
SUSPENDED
|
|
PAST_DUE
|
|
CANCELLED
|
|
|
|
@@map("tenant_status")
|
|
}
|
|
|
|
model Tenant {
|
|
id String @id @default(uuid()) @db.Uuid
|
|
code String @unique
|
|
slug String @unique
|
|
legalName String @map("legal_name")
|
|
tradeName String? @map("trade_name")
|
|
taxId String? @map("tax_id")
|
|
status TenantStatus @default(TRIAL)
|
|
timezone String @default("America/Sao_Paulo")
|
|
locale String @default("pt-BR")
|
|
billingCurrency String @map("billing_currency") @default("BRL")
|
|
telephonyDomain String? @map("telephony_domain")
|
|
createdAt DateTime @default(now()) @map("created_at")
|
|
updatedAt DateTime @updatedAt @map("updated_at")
|
|
deletedAt DateTime? @map("deleted_at")
|
|
|
|
memberships TenantMembership[]
|
|
userRoles UserRole[]
|
|
extensions Extension[]
|
|
trunks Trunk[]
|
|
dialplanExtensions DialplanExtension[]
|
|
dialplanVersions DialplanVersion[]
|
|
queues Queue[]
|
|
|
|
@@map("tenants")
|
|
}
|
|
|
|
enum UserStatus {
|
|
ACTIVE
|
|
DISABLED
|
|
|
|
@@map("user_status")
|
|
}
|
|
|
|
// Identidade global do usuário. NUNCA carrega tenant_id diretamente — o tenant
|
|
// é sempre resolvido via TenantMembership (agente.md secao 31).
|
|
model User {
|
|
id String @id @default(uuid()) @db.Uuid
|
|
email String @unique
|
|
passwordHash String @map("password_hash")
|
|
name String
|
|
status UserStatus @default(ACTIVE)
|
|
mustChangePassword Boolean @default(false) @map("must_change_password")
|
|
createdAt DateTime @default(now()) @map("created_at")
|
|
updatedAt DateTime @updatedAt @map("updated_at")
|
|
deletedAt DateTime? @map("deleted_at")
|
|
|
|
memberships TenantMembership[]
|
|
userRoles UserRole[]
|
|
sessions Session[]
|
|
|
|
@@map("users")
|
|
}
|
|
|
|
enum RoleScope {
|
|
PLATFORM
|
|
TENANT
|
|
|
|
@@map("role_scope")
|
|
}
|
|
|
|
// Definições de role. Roles de sistema (isSystem=true) são criadas pelo seed
|
|
// (agente.md secao 142) e não podem ser removidas via API.
|
|
model Role {
|
|
id String @id @default(uuid()) @db.Uuid
|
|
key String @unique
|
|
name String
|
|
scope RoleScope
|
|
isSystem Boolean @default(false) @map("is_system")
|
|
createdAt DateTime @default(now()) @map("created_at")
|
|
updatedAt DateTime @updatedAt @map("updated_at")
|
|
|
|
rolePermissions RolePermission[]
|
|
userRoles UserRole[]
|
|
|
|
@@map("roles")
|
|
}
|
|
|
|
model Permission {
|
|
id String @id @default(uuid()) @db.Uuid
|
|
key String @unique
|
|
description String?
|
|
|
|
rolePermissions RolePermission[]
|
|
|
|
@@map("permissions")
|
|
}
|
|
|
|
model RolePermission {
|
|
roleId String @map("role_id") @db.Uuid
|
|
permissionId String @map("permission_id") @db.Uuid
|
|
|
|
role Role @relation(fields: [roleId], references: [id], onDelete: Cascade)
|
|
permission Permission @relation(fields: [permissionId], references: [id], onDelete: Cascade)
|
|
|
|
@@id([roleId, permissionId])
|
|
@@map("role_permissions")
|
|
}
|
|
|
|
// tenantId é obrigatório quando role.scope == TENANT e deve ser nulo quando
|
|
// role.scope == PLATFORM (invariante aplicado em packages/auth, não no banco —
|
|
// ver docs/AUTHENTICATION.md).
|
|
model UserRole {
|
|
id String @id @default(uuid()) @db.Uuid
|
|
userId String @map("user_id") @db.Uuid
|
|
roleId String @map("role_id") @db.Uuid
|
|
tenantId String? @map("tenant_id") @db.Uuid
|
|
createdAt DateTime @default(now()) @map("created_at")
|
|
|
|
user User @relation(fields: [userId], references: [id], onDelete: Cascade)
|
|
role Role @relation(fields: [roleId], references: [id], onDelete: Cascade)
|
|
tenant Tenant? @relation(fields: [tenantId], references: [id], onDelete: Cascade)
|
|
|
|
@@unique([userId, roleId, tenantId])
|
|
@@map("user_roles")
|
|
}
|
|
|
|
// Refresh-token de longa duração (rotacionado a cada uso). Nunca guardamos o
|
|
// token em texto puro — só o hash (SHA-256) usado para lookup/comparação.
|
|
model Session {
|
|
id String @id @default(uuid()) @db.Uuid
|
|
userId String @map("user_id") @db.Uuid
|
|
refreshTokenHash String @unique @map("refresh_token_hash")
|
|
activeTenantId String? @map("active_tenant_id") @db.Uuid
|
|
userAgent String? @map("user_agent")
|
|
ipAddress String? @map("ip_address")
|
|
createdAt DateTime @default(now()) @map("created_at")
|
|
expiresAt DateTime @map("expires_at")
|
|
revokedAt DateTime? @map("revoked_at")
|
|
|
|
user User @relation(fields: [userId], references: [id], onDelete: Cascade)
|
|
|
|
@@index([userId])
|
|
@@map("sessions")
|
|
}
|
|
|
|
// tenantId nulo = evento de escopo plataforma (agente.md secao 150).
|
|
model AuditLog {
|
|
id String @id @default(uuid()) @db.Uuid
|
|
tenantId String? @map("tenant_id") @db.Uuid
|
|
userId String? @map("user_id") @db.Uuid
|
|
action String
|
|
entityType String? @map("entity_type")
|
|
entityId String? @map("entity_id")
|
|
before Json?
|
|
after Json?
|
|
ipAddress String? @map("ip_address")
|
|
userAgent String? @map("user_agent")
|
|
createdAt DateTime @default(now()) @map("created_at")
|
|
|
|
@@index([tenantId, createdAt])
|
|
@@index([userId])
|
|
@@map("audit_logs")
|
|
}
|
|
|
|
// Tabela tenant-scoped protegida por Row Level Security (ver migration
|
|
// 'tenant_isolation' e docs/TENANT_ISOLATION.md).
|
|
model TenantMembership {
|
|
id String @id @default(uuid()) @db.Uuid
|
|
tenantId String @map("tenant_id") @db.Uuid
|
|
userId String @map("user_id") @db.Uuid
|
|
createdAt DateTime @default(now()) @map("created_at")
|
|
|
|
tenant Tenant @relation(fields: [tenantId], references: [id])
|
|
user User @relation(fields: [userId], references: [id])
|
|
|
|
@@unique([tenantId, userId])
|
|
@@index([tenantId])
|
|
@@map("tenant_memberships")
|
|
}
|
|
|
|
// Tabela tenant-scoped protegida por Row Level Security. sipPasswordEnc
|
|
// guarda a senha SIP cifrada (AES-256-GCM, ver packages/shared/src/crypto.ts)
|
|
// — nunca texto puro (agente.md secao 178).
|
|
model Extension {
|
|
id String @id @default(uuid()) @db.Uuid
|
|
tenantId String @map("tenant_id") @db.Uuid
|
|
|
|
number String
|
|
name String
|
|
domain String
|
|
|
|
sipPasswordEnc String @map("sip_password_enc")
|
|
|
|
callerIdName String? @map("caller_id_name")
|
|
callerIdNumber String? @map("caller_id_number")
|
|
|
|
context String @default("default")
|
|
sofiaProfile String @default("internal") @map("sofia_profile")
|
|
codecs String @default("PCMU,PCMA,OPUS") @map("codecs")
|
|
|
|
maxRegistrations Int @default(1) @map("max_registrations")
|
|
|
|
enabled Boolean @default(true)
|
|
|
|
createdAt DateTime @default(now()) @map("created_at")
|
|
updatedAt DateTime @updatedAt @map("updated_at")
|
|
deletedAt DateTime? @map("deleted_at")
|
|
|
|
tenant Tenant @relation(fields: [tenantId], references: [id])
|
|
|
|
@@unique([tenantId, number])
|
|
@@index([tenantId])
|
|
@@map("extensions")
|
|
}
|
|
|
|
enum TrunkStatus {
|
|
UP
|
|
DOWN
|
|
REGISTERED
|
|
TRYING
|
|
FAILED
|
|
UNREGISTERED
|
|
UNKNOWN
|
|
|
|
@@map("trunk_status")
|
|
}
|
|
|
|
enum DtmfMode {
|
|
RFC2833
|
|
INFO
|
|
INBAND
|
|
|
|
@@map("dtmf_mode")
|
|
}
|
|
|
|
enum SipTransport {
|
|
UDP
|
|
TCP
|
|
TLS
|
|
|
|
@@map("sip_transport")
|
|
}
|
|
|
|
// Tabela tenant-scoped protegida por Row Level Security. passwordEnc guarda
|
|
// a senha do tronco cifrada (AES-256-GCM), como sipPasswordEnc em Extension
|
|
// (agente.md secao 41, 178).
|
|
model Trunk {
|
|
id String @id @default(uuid()) @db.Uuid
|
|
tenantId String @map("tenant_id") @db.Uuid
|
|
|
|
name String
|
|
description String?
|
|
|
|
sofiaProfile String @default("external") @map("sofia_profile")
|
|
|
|
host String
|
|
proxy String?
|
|
realm String?
|
|
|
|
register Boolean @default(true)
|
|
|
|
username String?
|
|
passwordEnc String? @map("password_enc")
|
|
|
|
fromUser String? @map("from_user")
|
|
fromDomain String? @map("from_domain")
|
|
|
|
registerProxy String? @map("register_proxy")
|
|
outboundProxy String? @map("outbound_proxy")
|
|
|
|
expireSeconds Int @default(3600) @map("expire_seconds")
|
|
retrySeconds Int @default(30) @map("retry_seconds")
|
|
|
|
callerIdName String? @map("caller_id_name")
|
|
callerIdNumber String? @map("caller_id_number")
|
|
|
|
codecs String @default("PCMU,PCMA,OPUS")
|
|
|
|
dtmfMode DtmfMode @default(RFC2833) @map("dtmf_mode")
|
|
|
|
ping Boolean @default(true)
|
|
pingFrequency Int @default(30) @map("ping_frequency")
|
|
|
|
transport SipTransport @default(UDP)
|
|
|
|
inboundContext String @default("default") @map("inbound_context")
|
|
|
|
maxCps Int? @map("max_cps")
|
|
maxChannels Int? @map("max_channels")
|
|
|
|
enabled Boolean @default(true)
|
|
|
|
// Refletido pelos eventos sofia::gateway_state (agente.md secao 42) —
|
|
// b2bcall-fs-events atualiza isso, nunca escrito manualmente pela API.
|
|
status TrunkStatus @default(UNKNOWN)
|
|
statusUpdatedAt DateTime? @map("status_updated_at")
|
|
|
|
createdAt DateTime @default(now()) @map("created_at")
|
|
updatedAt DateTime @updatedAt @map("updated_at")
|
|
deletedAt DateTime? @map("deleted_at")
|
|
|
|
tenant Tenant @relation(fields: [tenantId], references: [id])
|
|
|
|
@@unique([tenantId, name])
|
|
@@index([tenantId])
|
|
@@map("trunks")
|
|
}
|
|
|
|
enum DialplanVersionStatus {
|
|
DRAFT
|
|
ACTIVE
|
|
SUPERSEDED
|
|
|
|
@@map("dialplan_version_status")
|
|
}
|
|
|
|
// Editor estruturado (agente.md secao 43) — fonte editável. As versões
|
|
// publicadas (DialplanVersion) são um snapshot gerado a partir destas
|
|
// linhas, não o que o FreeSWITCH consulta diretamente.
|
|
model DialplanExtension {
|
|
id String @id @default(uuid()) @db.Uuid
|
|
tenantId String @map("tenant_id") @db.Uuid
|
|
|
|
context String @default("default")
|
|
name String
|
|
|
|
conditionField String @map("condition_field")
|
|
conditionExpr String @map("condition_expr")
|
|
|
|
// Array de { application, data } — validado contra uma allowlist de
|
|
// applications seguras na camada de API (agente.md secao 180: nunca
|
|
// deixar input de usuário virar comando arbitrário no FreeSWITCH).
|
|
actions Json
|
|
antiActions Json? @map("anti_actions")
|
|
|
|
continueOnFalse Boolean @default(false) @map("continue_on_false")
|
|
order Int @default(0)
|
|
|
|
enabled Boolean @default(true)
|
|
|
|
createdAt DateTime @default(now()) @map("created_at")
|
|
updatedAt DateTime @updatedAt @map("updated_at")
|
|
deletedAt DateTime? @map("deleted_at")
|
|
|
|
tenant Tenant @relation(fields: [tenantId], references: [id])
|
|
|
|
@@index([tenantId, context])
|
|
@@map("dialplan_extensions")
|
|
}
|
|
|
|
// Versionamento (agente.md secao 44): gerar -> validar -> versionar ->
|
|
// ativar -> reloadxml -> verificar -> rollback se necessário. "Ativar" uma
|
|
// versão anterior é o próprio mecanismo de rollback — não existe endpoint
|
|
// separado.
|
|
model DialplanVersion {
|
|
id String @id @default(uuid()) @db.Uuid
|
|
tenantId String @map("tenant_id") @db.Uuid
|
|
|
|
context String
|
|
version Int
|
|
generatedXml String @map("generated_xml")
|
|
status DialplanVersionStatus @default(DRAFT)
|
|
|
|
createdByUserId String? @map("created_by_user_id") @db.Uuid
|
|
createdAt DateTime @default(now()) @map("created_at")
|
|
activatedAt DateTime? @map("activated_at")
|
|
|
|
tenant Tenant @relation(fields: [tenantId], references: [id])
|
|
|
|
@@unique([tenantId, context, version])
|
|
@@index([tenantId, context, status])
|
|
@@map("dialplan_versions")
|
|
}
|
|
|
|
enum QueueStrategy {
|
|
LONGEST_IDLE_AGENT
|
|
ROUND_ROBIN
|
|
TOP_DOWN
|
|
AGENT_WITH_LEAST_TALK_TIME
|
|
AGENT_WITH_FEWEST_CALLS
|
|
SEQUENTIALLY_BY_AGENT_ORDER
|
|
RING_ALL
|
|
RING_PROGRESSIVELY
|
|
|
|
@@map("queue_strategy")
|
|
}
|
|
|
|
// Tabela tenant-scoped protegida por RLS (agente.md secao 50-51). O nome no
|
|
// FreeSWITCH é `<queue.id>@<tenant.telephonyDomain>` — mod_callcenter usa
|
|
// um namespace unico compartilhado entre tenants (nao ha equivalente ao
|
|
// diretorio por-arquivo do Sofia pra isolar por tenant, ver docs/QUEUES.md).
|
|
model Queue {
|
|
id String @id @default(uuid()) @db.Uuid
|
|
tenantId String @map("tenant_id") @db.Uuid
|
|
|
|
name String
|
|
description String?
|
|
|
|
strategy QueueStrategy @default(LONGEST_IDLE_AGENT)
|
|
|
|
mohSound String? @map("moh_sound")
|
|
announceSound String? @map("announce_sound")
|
|
announceFrequency Int @default(0) @map("announce_frequency")
|
|
|
|
maxWaitTime Int @default(0) @map("max_wait_time")
|
|
maxWaitTimeWithNoAgent Int @default(0) @map("max_wait_time_with_no_agent")
|
|
|
|
agentNoAnswerStatus String? @map("agent_no_answer_status")
|
|
|
|
tierRulesApply Boolean @default(false) @map("tier_rules_apply")
|
|
tierRuleWaitSecond Int @default(300) @map("tier_rule_wait_second")
|
|
|
|
discardAbandonedAfter Int @default(60) @map("discard_abandoned_after")
|
|
abandonedResumeAllowed Boolean @default(false) @map("abandoned_resume_allowed")
|
|
|
|
skipAgentsWithExternalCalls Boolean @default(true) @map("skip_agents_with_external_calls")
|
|
|
|
recordingEnabled Boolean @default(false) @map("recording_enabled")
|
|
|
|
enabled Boolean @default(true)
|
|
|
|
createdAt DateTime @default(now()) @map("created_at")
|
|
updatedAt DateTime @updatedAt @map("updated_at")
|
|
deletedAt DateTime? @map("deleted_at")
|
|
|
|
tenant Tenant @relation(fields: [tenantId], references: [id])
|
|
|
|
@@unique([tenantId, name])
|
|
@@index([tenantId])
|
|
@@map("queues")
|
|
}
|