Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-26104203277.0 KB

Call Voice Agent using Twilio custom phone number.

post/v1/voice-agents/phone-number/call

Request body

OR

Example request

{
  "phoneNumber": "+1234567890",
  "agentDetails": {
    "webhookUrl": "https://example.com/webhook",
    "webhookAuth": {
      "authKey": "Token",
      "authSecret": "Secret"
    },
    "outcomeResponseShape": {
      "type": "object",
      "properties": {
        "test": {
          "type": "number",
          "description": "Hello world from Hamsa AI!"
        }
      },
      "required": [
        "test"
      ]
    },
    "llmConfig": {
      "provider": "OpenAI",
      "modelName": "GPT-4.1",
      "baseUrl": "https://api.custom-llm.com/v1",
      "apiKey": "sk-...",
      "temperature": 0.2
    }
  },
  "voiceAgentId": "d949f13f-40d2-4e48-ac86-b66633070603"
}

Response

Successful response

successboolean
messagestring

Example response

{
  "data": {
    "voiceAgentId": "d949f13f-40d2-4e48-ac86-b66633070603",
    "jobId": "d949f13f-40d2-4e48-ac86-b66633070603"
  }
}