Skip to main content
POST
/
v1
/
voice-agents
/
call
Initiate a call with a voice agent
curl --request POST \
  --url https://api.tryhamsa.com/v1/voice-agents/call \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "toNumber": "<string>",
  "fromNumber": "+18449292835",
  "voiceAgentId": "<string>",
  "params": {},
  "agentDetails": {},
  "webhookUrl": "https://example.com/webhook",
  "webhookAuth": {
    "authKey": "Token",
    "authSecret": "Secret"
  }
}
'
{
  "success": false,
  "message": "success",
  "data": {
    "id": "<string>",
    "title": "<string>",
    "model": "<string>",
    "type": "<string>",
    "processingType": "<string>",
    "webhookUrl": "<string>",
    "totalCost": 123,
    "usageTime": "<string>",
    "fromLng": "<string>",
    "toLng": "<string>",
    "mediaUrl": "<string>",
    "jobResponse": {},
    "fromScript": "<string>",
    "toScript": "<string>",
    "status": "<string>",
    "relevantJobId": "<string>",
    "agentDetails": {
      "id": "<string>",
      "agentName": "<string>",
      "greetingMessage": "<string>",
      "description": "<string>",
      "preamble": "<string>",
      "lang": "<string>",
      "pokeMessages": [
        "<string>"
      ],
      "realTime": true,
      "silenceThreshold": 123,
      "interrupt": true,
      "outcome": "<string>",
      "outcomeResponseShape": {
        "type": "object",
        "properties": {
          "test": {
            "type": "number",
            "description": "Hello world from Hamsa AI!"
          }
        },
        "required": [
          "test"
        ]
      },
      "projectId": "<string>",
      "apiKeyId": "<string>",
      "voiceRecordId": "<string>",
      "voiceRecord": {},
      "webhookUrl": "https://example.com/webhook",
      "webhookAuth": {
        "authKey": "Token",
        "authSecret": "Secret"
      },
      "params": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    },
    "apiKeyId": "<string>",
    "billingId": "<string>",
    "systemModelKey": "<string>",
    "voiceAgentId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token '

Body

application/json
​
toNumber
string
required

The number that you want to call

​
fromNumber
enum<string>
required
Available options:
+18449292835,
+18558961879
​
voiceAgentId
string | null
required
​
params
object
required

Params set in the voice agent's greeting message or preamble. Send when using voiceAgentId only.

​
agentDetails
object

Send agentDetails instead of voiceAgentId and params.

​
webhookUrl
string<uri> | null
Example:

"https://example.com/webhook"

​
webhookAuth
object

Authorization header to be sent in this format: Authorization: [authKey] [authSecret]

Response

Successful call initiation

​
success
boolean
default:false
​
message
string
default:success
​
data
object