1. System
VoiceDock
  • System
    • Health check
      GET
  • Organization
    • Get organization information
      GET
    • Create organization
      POST
    • Get organization information (deprecated)
      GET
  • Assistants
    • List all assistants
      GET
    • Create a new assistant
      POST
    • Get an assistant
      GET
    • Update an assistant
      PATCH
    • Delete an assistant
      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
  • Tool Templates
    • List all tool templates
    • Create a new tool template
    • Get a tool template
    • Update a tool template
    • Delete a tool template
  • Analysis Templates
    • List analysis templates
    • Create analysis template
    • Get analysis template
    • Update analysis template
    • Delete analysis template
  • 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
  • Chats
    • Append a chat message
    • List chat messages
    • Delete a chat message
    • Get conversation context for a contact
  • Webhooks
    • Dynamic assistant configuration webhook
    • Tool/Function Call
    • Call Status Update
    • End of Call Report
  • Schemas
    • OrganizationChild
    • Organization
    • Error
    • OrganizationCreate
    • OrganizationCreated
    • AnalysisPlan
    • STTConfig
    • ToolDefinition
    • LLMConfig
    • TTSConfig
    • Agent
    • AgentCreate
    • SuccessResponse
    • AgentUpdate
    • PhoneNumber
    • PhoneNumberCreate
    • PhoneNumberUpdate
    • Call
    • Pagination
    • AssistantConfigOverride
    • OutboundCallRequest
    • OutboundCallResponse
    • InjectContextCommand
    • SayCommand
    • EndCallCommand
    • TransferCommand
    • CallControlCommand
    • CallControlResponse
    • UsageLog
    • UsageSummary
    • SipTrunk
    • SipTrunkCreate
    • Voice
    • ToolTemplate
    • ToolTemplateCreate
    • ToolTemplateUpdate
    • AnalysisTemplate
    • AnalysisTemplateListResponse
    • CreateAnalysisTemplate
    • UpdateAnalysisTemplate
    • Campaign
    • CampaignCreate
    • CampaignUpdate
    • CampaignLead
    • CampaignLeadCreate
    • ChatMessage
    • ChatMessageCreate
    • ChatContext
    • CallObject
    • Customer
    • AssistantRequestPayload
    • AssistantRequestResponse
    • AssistantWebhookObject
    • ToolCall
    • ToolCallsPayload
    • ToolCallsResponse
    • StatusUpdatePayload
    • EndOfCallReportPayload
Book a meeting
Linkedin
Github
📄 Documentation🔌 API Reference
🤖 MCP📦 SDK🟢 Status
📄 Documentation🔌 API Reference
🤖 MCP📦 SDK🟢 Status
  1. System

Health check

GET
https://api.hmsovereign.com/api/v1/api/v1/health
System
Last modified:2026-05-04 13:09:49
Maintainer:Not configured
Returns the current health status of the API and its dependencies. No authentication required.

Request

None

Responses

🟢200OK
application/json
All systems operational
Body

🔴503Service Unavailable
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.hmsovereign.com/api/v1/api/v1/health'
Response Response Example
{
    "status": "ok",
    "timestamp": "2026-03-27T12:00:00.000Z",
    "version": "1.0.0",
    "checks": {
        "database": {
            "status": "ok",
            "latency_ms": 12
        }
    }
}
Modified at 2026-05-04 13:09:49
Next
Get organization information
Built with