Sign inSign up

phirumseng/plxy-callbot-api

By phirumseng

ā€¢Updated about 1 month ago

PLXY AI Call Center control plane ā€” scenarios, campaigns, calls and auth on PostgreSQL 18

Image
API management
Machine learning & AI
0

93

phirumseng/plxy-callbot-api repository overview

ā plxy-callbot-api

Control plane of the PLXY AI Call Center: the REST API behind the studio. It owns scenarios, campaigns, call records, users and tenants, and it is the only service that talks to the database.

Part of a five-image platform that answers calls from a SIP trunk, runs an AI conversation, and transfers to a 3CX agent when the flow says so.

šŸ“– Deployment guideā  Ā· Configuration referenceā  Ā· API referenceā 

ā Where it sits

 SIP trunk ā”€ā”€ā–¶ plxy-voice-gateway-media ā”€ā”€ā–¶ 3CX agents
                        ā–² ESL
                 plxy-voice-gateway
                        ā–² WebSocket
                 plxy-callbot-worker
                        ā–² REST (internal token)
   browser ā”€ā”€ā–¶  plxy-callbot-api  ā”€ā”€ā–¶ PostgreSQL 18
                        ā–²
                 plxy-callbot-ui

ā Ports

PortPurpose
29092REST API ā€” the studio (browser) and the voice gateway both call it

ā Configuration

Everything is environment variables. Nothing has a usable default that would let it start insecurely: the four marked required stop the container rather than guess.

VariableRequiredWhat it is
APP_DB_URL / APP_DB_USERāœ…JDBC URL and least-privilege runtime login
OWNER_DB_URL / OWNER_DB_USERāœ…The role that runs schema migrations at startup
CORS_ALLOWED_ORIGINSāœ…The studio's public origin. Wrong value = login blocked by the browser
VGW_BASE_URLāœ…Voice gateway base URL, for placing outbound calls
APP_DIALER_ENABLEDCampaign dialer loop. Default true
REDIS_ENABLED / REDIS_URIRequired only above one replica ā€” see below
RATE_LIMIT_*Token-bucket limits; sensible defaults for one replica
JAVA_OPTSDefault -XX:MaxRAMPercentage=75
ā Secrets

Every credential is read from a file, never from the environment, so docker inspect stays clean. Each *_FILE variable points at a mounted file (a Docker/Swarm secret):

OWNER_DB_PASSWORD_FILE Ā· APP_DB_PASSWORD_FILE Ā· JWT_SECRET_FILE Ā· INTERNAL_API_TOKEN_FILE Ā· VGW_CONTROL_TOKEN_FILE Ā· APIEXT_SECRET_KEY_FILE

The container refuses to start with a blank JWT secret, an HS256 key shorter than 32 bytes, or a blank internal token ā€” a blank token would disable service-to-service auth silently.

ā Replicas

Run exactly one unless you also set REDIS_ENABLED=true. This service holds the migration lock and the campaign dialer loop, and its rate limiter and idempotency store are in-process; a second replica without Redis can place a duplicate outbound call.

ā Run it

This image is one service of a stack ā€” it needs PostgreSQL 18 and the other four images. Deploy the whole platform with the published Swarm stack files:

git clone https://github.com/SengPhirum/PLXY_AICC.git && cd PLXY_AICC
deploy/swarm/secrets-init.sh callbot prod
TAG=0.1.0 deploy/swarm/deploy.sh callbot prod

Full walkthrough ā€” carrier trunk, 3CX, firewall rules, first sign-in: https://sengphirum.github.io/PLXY_AICC/setup-guideā 

ā Tags

latest tracks the newest release. Pin the version tag (0.1.0) in production, and use the same tag for all five images ā€” they ship as one set.

ā The other images

plxy-callbot-uiā  Ā· plxy-callbot-workerā  Ā· plxy-voice-gatewayā  Ā· plxy-voice-gateway-mediaā 

Tag summary

Content type

Image

Digest

sha256:c58491be4ā€¦

Size

181.3 MB

Last updated

about 1 month ago

docker pull phirumseng/plxy-callbot-api