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>",
"greetingMessageType": "STATIC",
"description": "<string>",
"preamble": "<string>",
"lang": "<string>",
"pokeMessages": [
"<string>"
],
"realTime": true,
"silenceThreshold": 123,
"interrupt": true,
"type": "<string>",
"outcome": "<string>",
"outcomeResponseShape": {
"type": "object",
"properties": {
"test": {
"type": "number",
"description": "Hello world from Hamsa AI!"
}
},
"required": [
"test"
]
},
"projectId": "<string>",
"apiKeyId": "<string>",
"voiceId": "<string>",
"voiceRecordId": "<string>",
"voiceRecord": {},
"collectionId": "<string>",
"isTemplate": true,
"icon": "<string>",
"webhookUrl": "https://example.com/webhook",
"webhookAuth": {
"authKey": "Token",
"authSecret": "Secret"
},
"params": {},
"alignment": {
"greetingMessage": "<string>",
"preamble": "<string>"
},
"tools": {
"genderDetection": true,
"smartCallEnd": true
},
"webToolsIds": [
"<string>"
],
"voiceDictionaryIds": [
"<string>"
],
"knowledgeBaseItemsIds": [
"<string>"
],
"webToolsOverrides": {},
"userInactivityTimeout": 123,
"maxCallDuration": 123,
"responseDelay": 123,
"backgroundNoise": true,
"waitForUserToSpeakFirst": 123,
"thinkingVoice": true,
"speakerIdentification": true,
"llmConfig": {
"provider": "OpenAI",
"modelName": "GPT-4.1",
"baseUrl": "https://api.custom-llm.com/v1",
"apiKey": "sk-...",
"temperature": 0.2
},
"noiseCancellation": "<string>",
"cancelNoisePer": "<string>",
"agenticRag": true,
"languageDialectSwitcher": true,
"minInterruptionDuration": 123,
"vadActivationThreshold": 123,
"enableAutoGainControl": true,
"sendDenoisedToStt": true,
"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"
}
}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>",
"greetingMessageType": "STATIC",
"description": "<string>",
"preamble": "<string>",
"lang": "<string>",
"pokeMessages": [
"<string>"
],
"realTime": true,
"silenceThreshold": 123,
"interrupt": true,
"type": "<string>",
"outcome": "<string>",
"outcomeResponseShape": {
"type": "object",
"properties": {
"test": {
"type": "number",
"description": "Hello world from Hamsa AI!"
}
},
"required": [
"test"
]
},
"projectId": "<string>",
"apiKeyId": "<string>",
"voiceId": "<string>",
"voiceRecordId": "<string>",
"voiceRecord": {},
"collectionId": "<string>",
"isTemplate": true,
"icon": "<string>",
"webhookUrl": "https://example.com/webhook",
"webhookAuth": {
"authKey": "Token",
"authSecret": "Secret"
},
"params": {},
"alignment": {
"greetingMessage": "<string>",
"preamble": "<string>"
},
"tools": {
"genderDetection": true,
"smartCallEnd": true
},
"webToolsIds": [
"<string>"
],
"voiceDictionaryIds": [
"<string>"
],
"knowledgeBaseItemsIds": [
"<string>"
],
"webToolsOverrides": {},
"userInactivityTimeout": 123,
"maxCallDuration": 123,
"responseDelay": 123,
"backgroundNoise": true,
"waitForUserToSpeakFirst": 123,
"thinkingVoice": true,
"speakerIdentification": true,
"llmConfig": {
"provider": "OpenAI",
"modelName": "GPT-4.1",
"baseUrl": "https://api.custom-llm.com/v1",
"apiKey": "sk-...",
"temperature": 0.2
},
"noiseCancellation": "<string>",
"cancelNoisePer": "<string>",
"agenticRag": true,
"languageDialectSwitcher": true,
"minInterruptionDuration": 123,
"vadActivationThreshold": 123,
"enableAutoGainControl": true,
"sendDenoisedToStt": true,
"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"
}
}Documentation Index
Fetch the complete documentation index at: https://docs.tryhamsa.com/llms.txt
Use this file to discover all available pages before exploring further.
Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token '
The number that you want to call
+18449292835, +18558961879 Params set in the voice agent's greeting message or preamble. Send when using voiceAgentId only.
Send agentDetails instead of voiceAgentId and params.
Show child attributes
"https://example.com/webhook"
Authorization header to be sent in this format: Authorization: [authKey] [authSecret]
Show child attributes
Was this page helpful?