DocumentationAPI Reference
DocumentationAPI Reference
Book a meeting
Linkedin
Github
    • Agents
      • List all agents
      • Create a new agent
      • Get an agent
      • Update an agent
      • Delete an agent
    • Tool Templates
      • List all tool templates
      • Create a new tool template
      • Get a tool template
      • Update a tool template
      • Delete a tool template
    • Numbers
      • List all phone numbers
      • Register a phone number
      • Get a phone number
      • Update a phone number
      • Delete a phone number
    • Calls
      • List calls
      • Get call by ID
      • Initiate outbound call
    • Call Control
      • Send control command to active call
    • Usage
      • Get usage logs
    • SIP Trunks
      • List SIP trunks
      • Create a SIP trunk
      • Get a SIP trunk
      • Delete a SIP trunk
    • Voices
      • List available voices
    • BYOK
      • Get BYOK configurations
      • Add BYOK configuration
      • Delete BYOK configuration
      • Get BYOK provider configurations
    • Domains
      • Get your domain
      • Add a domain
      • Delete your domain
      • List available Resend domains
      • Select and sync a Resend domain
      • Verify domain DNS records
      • Refresh domain status
    • Webhooks
      • Dynamic assistant configuration webhook
      • Tool/Function Call
      • Call Status Update
      • End of Call Report
    • Analysis Templates
      • List analysis templates
      • Create analysis template
      • Get analysis template
      • Update analysis template
      • Delete analysis template
    • Organization
      • Get organization information
      • Create organization
      • Get organization information (deprecated)
    • Campaigns
      • List all campaigns
      • Create a campaign
      • Get a campaign
      • Update a campaign
      • Delete a campaign
      • List campaign leads
      • Add a lead
      • Remove a lead
    • Schemas
      • Error
      • Pagination
      • UUID
      • Timestamp
      • SuccessResponse
      • STTConfig
      • LLMConfig
      • TTSConfig
      • XAIRealtimeConfig
      • Agent
      • AgentCreate
      • AgentUpdate
      • PhoneNumber
      • PhoneNumberCreate
      • PhoneNumberUpdate
      • Call
      • CallControlCommand
      • InjectContextCommand
      • SayCommand
      • EndCallCommand
      • TransferCommand
      • CallControlResponse
      • OutboundCallRequest
      • Account
      • UsageLog
      • OutboundCallResponse
      • UsageSummary
      • Organization
      • SipTrunk
      • SipTrunkCreate
      • OrganizationChild
      • Voice
      • OrganizationCreate
      • OrganizationCreated
      • AssistantRequestPayload
      • CallObject
      • Customer
      • AssistantRequestResponse
      • XAIRealtimeVoice
      • AssistantConfigOverride
      • AnalysisPlan
      • AssistantWebhookObject
      • ToolCallsPayload
      • ToolCall
      • ToolCallsResponse
      • StatusUpdatePayload
      • EndOfCallReportPayload
      • ToolDefinition
      • EndCallTool
      • TransferCallTool
      • WebhookHeaders
      • XAIRealtimeWebhookNotes
      • ToolFunctionConfig
      • ToolTransferConfig
      • ToolTemplate
      • ToolTemplateCreate
      • ToolTemplateUpdate
      • AnalysisTemplate
      • CreateAnalysisTemplate
      • UpdateAnalysisTemplate
      • AnalysisTemplateListResponse
      • CampaignLead
      • Campaign
      • CampaignCreate
      • CampaignUpdate
      • CampaignLeadCreate
    DocumentationAPI Reference
    DocumentationAPI Reference
    Book a meeting
    Linkedin
    Github

    StatusUpdatePayload

    Payload sent when call status changes

    {
        "message": {
            "type": "status-update",
            "timestamp": "2019-08-24T14:15:22.123Z",
            "call": {
                "id": "5c4d030f-43e3-4e65-899e-8148521e660f",
                "type": "inbound_phone_call",
                "status": "ringing",
                "pipeline": "standard"
            },
            "phone_number": {
                "number": "+31850835037",
                "name": "HMS Sovereign Demo"
            },
            "customer": {
                "number": "+31612345678"
            },
            "assistant": {
                "llm_config": {
                    "provider": "openai",
                    "model": "gpt-5",
                    "voice": "ara",
                    "temperature": 0.7,
                    "messages": [
                        {
                            "role": "system",
                            "content": "string"
                        }
                    ],
                    "tools": [
                        {}
                    ]
                },
                "stt_config": {
                    "provider": "deepgram",
                    "model": "nova-3-general",
                    "language": "multi",
                    "keyterms": [
                        "yes",
                        "no",
                        "okay",
                        "Acme"
                    ]
                },
                "tts_config": {
                    "provider": "openai",
                    "voice_id": "alloy",
                    "model": "eleven_flash_v2_5",
                    "language": "nl",
                    "stability": 0.5,
                    "similarity_boost": 0.75,
                    "use_speaker_boost": true,
                    "speed": 1,
                    "style": 0
                },
                "first_message": "Hello, how can I help you?",
                "max_duration_seconds": 300,
                "analysis_plan": {
                    "structured_data_plan": {
                        "enabled": true,
                        "schema": {
                            "type": "object",
                            "properties": {
                                "intent": {
                                    "type": "string"
                                },
                                "sentiment": {
                                    "type": "string",
                                    "enum": [
                                        "positive",
                                        "neutral",
                                        "negative"
                                    ]
                                },
                                "appointment_booked": {
                                    "type": "boolean"
                                }
                            }
                        },
                        "messages": [
                            {
                                "role": "system",
                                "content": "Analyze the following call transcript according to this schema: {{schema}}"
                            }
                        ]
                    },
                    "min_messages_threshold": 2
                },
                "autonomous_silence_handling": false,
                "voicemail_detection": false,
                "voicemail_message": "string",
                "business_name": "Acme Corp",
                "metadata": {
                    "crm_id": "12345",
                    "campaign_id": "summer-2025",
                    "customer_tier": "premium"
                }
            },
            "error": "STT connection failed"
        }
    }
    Built with