API Endpoints

Complete reference for all available CX Tools API endpoints.

Calendar API

Get Status

GET /api/calendar/status

Response:
{
    "is_open": true,
    "next_open": "2024-01-22T09:00:00Z",
    "next_close": "2024-01-22T17:00:00Z"
}

Get Holidays

GET /api/calendar/holidays

Response:
{
    "holidays": [
        {
            "id": 1,
            "name": "New Year's Day",
            "date": "2024-01-01",
            "recurring": true
        }
    ]
}

GRXML API

Validate Grammar

POST /api/grxml/validate
Content-Type: application/json

{
    "content": "..."
}

Response:
{
    "valid": true,
    "errors": []
}

Test Grammar

POST /api/grxml/test
Content-Type: application/json

{
    "content": "...",
    "input": "test phrase"
}

Response:
{
    "matches": true,
    "result": "test phrase"
}

Studio API

Script Backup

POST /api/studio/backup
Content-Type: application/json

{
    "script_id": "123",
    "content": "script content..."
}

Response:
{
    "backup_id": "456",
    "timestamp": "2024-01-22T10:00:00Z"
}

Hours of Operation

GET /api/studio/hoo/status/{schedule_id}

Response:
{
    "is_open": true,
    "schedule": {
        "id": "789",
        "name": "Main Schedule",
        "timezone": "America/New_York"
    }
}

Next Steps

Ready to start using our API? Get your API key and review our authentication guide.