4da794ed0c
All checks were successful
Create Release / build (push) Successful in 4s
All FCM push notifications are handled by WordPress backend (TWP_FCM), so Twilio Push Credentials are unnecessary. Also replaces placeholder google-services.json with real Firebase project config (twp-softphone). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
103 lines
4.5 KiB
Markdown
103 lines
4.5 KiB
Markdown
# Twilio WordPress Plugin - Quick Reference
|
|
|
|
## Environment
|
|
- **Production**: `/home/shadowdao/public_html/wp-content/plugins/twilio-wp-plugin/`
|
|
- **Dev**: `/home/jknapp/code/twilio-wp-plugin/`
|
|
- **URL**: `https://phone.cloud-hosting.io/`
|
|
- **Deployment**: rsync to Docker (remote server only, not local)
|
|
- **SDK**: Twilio PHP SDK v8.7.0
|
|
- **PHP**: 8.0+ required
|
|
- **Optional**: AWS SDK (`aws/aws-sdk-php`) for SNS SMS provider
|
|
- **External SDK**: `wp-content/twilio-sdk/` (survives plugin updates)
|
|
|
|
## Commands
|
|
- **Install SDK (recommended)**: `./install-twilio-sdk-external.sh` (installs to `wp-content/twilio-sdk/`)
|
|
- **Install SDK (internal)**: `./install-twilio-sdk.sh` (installs to `vendor/`, lost on plugin update)
|
|
- **Test SDK**: `php test-sdk.php`
|
|
- **Composer install SDK**: `composer install-sdk`
|
|
- **Deploy**: rsync to Docker (remote server, see production path above)
|
|
- **CI/CD**: Gitea workflows in `.gitea/workflows/` — `release.yml`, `update-version.yml`
|
|
|
|
## Directory Structure
|
|
- `twilio-wp-plugin.php` — Main plugin file, constants, SDK loading
|
|
- `includes/` — All backend classes (28 class files)
|
|
- `admin/` — Admin UI class (`TWP_Admin`), mobile app settings page
|
|
- `assets/js/` — Browser phone JS, service worker
|
|
- `assets/images/`, `assets/sounds/` — Static assets
|
|
- `.gitea/workflows/` — CI/CD (release, version update)
|
|
|
|
## Phone Variable Names
|
|
**Use**: `incoming_number`, `agent_number`, `customer_number`, `workflow_number`, `queue_number`, `default_number`
|
|
**Don't use**: `from_number`, `to_number`, `phone_number`, `$agent_phone`
|
|
**Test numbers**: Twilio `+19516215107`, Agent `+19095737372`
|
|
|
|
## Key Classes
|
|
- **TWP_Twilio_API**: Use `new TWP_Twilio_API()` not singleton
|
|
- **TWP_Admin**: Has `find_customer_call_leg()` - CRITICAL for call control
|
|
- **TWP_TTS_Helper**: ElevenLabs/Alice fallback, 30-day cache
|
|
- **TWP_User_Queue_Manager**: Auto-creates queues/extensions (100-9999)
|
|
- **TWP_Webhooks**: 35 endpoints at `twilio-webhook/v1`
|
|
- **TWP_Activator**: Creates 16 DB tables, run `ensure_tables_exist()` if missing
|
|
- **TWP_Core**: Main plugin orchestrator, hooks all classes together
|
|
- **TWP_SMS_Manager**: SMS abstraction with provider interface
|
|
- **TWP_SMS_Provider_Twilio** / **TWP_SMS_Provider_SNS**: SMS providers (Twilio default, AWS SNS optional)
|
|
- **TWP_Mobile_API**: REST API for mobile app
|
|
- **TWP_Mobile_Auth** / **TWP_Mobile_SSE** / **TWP_FCM**: Mobile auth, server-sent events, push notifications
|
|
- **TWP_Call_Queue**: Queue operations and management
|
|
- **TWP_Callback_Manager**: Callback request handling
|
|
- **TWP_Workflow**: Workflow step execution engine
|
|
- **TWP_Auto_Updater**: Plugin auto-update from Gitea releases
|
|
|
|
## Database
|
|
16 tables with `twp_` prefix. Key notes:
|
|
- `twp_call_queues`: User queues (general/personal/hold)
|
|
- `twp_agent_status`: Has `auto_busy_at` for 1-min auto-revert
|
|
- `twp_queued_calls`: Uses `enqueued_at` not `joined_at`
|
|
|
|
## Critical Functions
|
|
|
|
### Call Control (MUST use call leg detection)
|
|
```php
|
|
// ALWAYS do this for hold/transfer/requeue:
|
|
$customer_call_sid = $this->find_customer_call_leg($call_sid, $twilio);
|
|
$api->update_call($customer_call_sid, ['twiml' => $twiml_xml]);
|
|
```
|
|
|
|
### Common Fixes
|
|
- Recording: Use `Twilio.CURRENT` for SDK v8
|
|
- Queue: Pass `waitUrl` as option in `enqueue()`
|
|
- TwiML: Use SDK classes, not raw XML
|
|
|
|
## Development Notes
|
|
- **API**: E.164 format (+1XXXXXXXXXX)
|
|
- **Database**: Use `$wpdb`, prepared statements
|
|
- **AJAX**: Verify nonce, return JSON
|
|
- **Naming**: TWP_ for classes, twp_ for tables/options
|
|
- **Debugging**: Look for "TWP Call Leg Detection" in logs
|
|
|
|
## Features
|
|
- Agents accept calls via SMS "1"
|
|
- User-specific queues with extensions
|
|
- Browser phone at `admin.php?page=twilio-wp-browser-phone`
|
|
- ElevenLabs TTS with Alice fallback
|
|
- 77 AJAX actions, 35 REST endpoints
|
|
- Browser phone moved to admin-only (v2.3.0)
|
|
- Firefox, Chrome, Safari, Edge support
|
|
- 1-min agent status auto-revert
|
|
|
|
## SDK Loading
|
|
- **External SDK (Recommended)**: `wp-content/twilio-sdk/` — survives plugin updates
|
|
- **Internal SDK**: `vendor/` — deleted on plugin update, needs reinstall
|
|
- Loading priority: External first (`TWP_EXTERNAL_SDK_DIR`), then internal fallback
|
|
- Post-update hook (`upgrader_process_complete`) warns if SDK missing
|
|
|
|
## Browser Phone Configuration
|
|
- **Edge Location**: `twp_twilio_edge` option, default `roaming`
|
|
- Options: roaming, ashburn, umatilla, dublin, frankfurt, singapore, sydney, tokyo, sao-paulo
|
|
- Wrong edge causes immediate call failures (e.g., US calls with Sydney edge)
|
|
|
|
## Changelog
|
|
See `README.md` for detailed version history. Current version: v2.8.9.
|
|
|
|
---
|
|
*Updated: Mar 2026* |