DocumentationAPI Reference
DocumentationAPI Reference
Book a meeting
Linkedin
Github
  1. Call Control
  • Agents
    • List all agents
      GET
    • Create a new agent
      POST
    • Get an agent
      GET
    • Update an agent
      PATCH
    • Delete an agent
      DELETE
  • Tool Templates
    • List all tool templates
      GET
    • Create a new tool template
      POST
    • Get a tool template
      GET
    • Update a tool template
      PATCH
    • Delete a tool template
      DELETE
  • Numbers
    • List all phone numbers
      GET
    • Register a phone number
      POST
    • Get a phone number
      GET
    • Update a phone number
      PATCH
    • Delete a phone number
      DELETE
  • Calls
    • List calls
      GET
    • Get call by ID
      GET
    • Initiate outbound call
      POST
  • Call Control
    • Send control command to active call
      POST
  • Usage
    • Get usage logs
      GET
  • SIP Trunks
    • List SIP trunks
      GET
    • Create a SIP trunk
      POST
    • Get a SIP trunk
      GET
    • Delete a SIP trunk
      DELETE
  • 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
  1. Call Control

Send control command to active call

POST
https://api.hmsovereign.com/api/v1/calls/{id}/control
Call Control
Last modified:2026-01-30 13:43:45
Maintainer:Jesper Rietbergen
Send real-time commands to an active call. The call must be in "in-progress" status.
⚠️ IMPORTANT: xAI Realtime Model Limitations
Call control has significant limitations when using xAI Realtime (grok-realtime-v1) due to its speech-to-speech architecture:
❌ inject-context: Limited effectiveness - context may not influence responses reliably
❌ say: Does not work reliably - commands often timeout or fail to trigger speech
✅ end-call: Works reliably
⚠️ transfer: Partial support - announcement may not work, but transfer executes
Why the limitations?
xAI Realtime is an end-to-end audio model that processes speech directly without intermediate text. It expects continuous audio input and cannot reliably respond to text-based control commands mid-conversation.
Recommendation:
If you need full call control support (inject-context, say, transfer with announcements), use the traditional pipeline:
Provider: openai with gpt-4o or gpt-4o-mini
STT: Deepgram (nova-3-general)
TTS: ElevenLabs or OpenAI TTS
Result: All control commands work reliably
Command Types:
inject-context: Silently add information to the agent's context (traditional models only)
say: Make the agent speak specific text (traditional models only)
end-call: End the call with an optional final message (works with all models)
transfer: Transfer the call to another destination (partial xAI Realtime support)
Use Cases:
SMS verification: Inject received codes into the conversation
CRM integration: Add customer context mid-call
Human escalation: Transfer to a live agent
Emergency end: Gracefully terminate problematic calls

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
Command executed successfully
Body

🟠400
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.hmsovereign.com/api/v1/calls//control' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "inject-context",
    "content": "The customer has been verified as John Smith, account #12345",
    "trigger_response": true
}'
Response Response Example
200 - Example 1
{
    "success": true,
    "message": "Command sent successfully"
}
Modified at 2026-01-30 13:43:45
Previous
Initiate outbound call
Next
Get usage logs
Built with