Skip to main content
GET
/
v1
/
voice-agents
/
conversation
/
{conversationId}
Get Conversation by ID.
curl --request GET \
  --url https://api.tryhamsa.com/v1/voice-agents/conversation/{conversationId} \
  --header 'Authorization: <api-key>'
{
  "success": true,
  "message": "Success",
  "data": {
    "id": "849e77c6-5cb3-479a-a985-7fab630e2c78",
    "model": "gpt-4",
    "agentDetails": {},
    "jobResponse": {},
    "status": "COMPLETED",
    "type": "VOICE_AGENTS",
    "processingType": "real-time",
    "voiceAgentId": "d949f13f-40d2-4e48-ac86-b66633070603",
    "apiKeyId": "d949f13f-40d2-4e48-ac86-b66633070603",
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:35:00Z",
    "title": "Customer Support Call",
    "mediaUrl": "https://storage.example.com/recordings/123.mp3",
    "callParams": {
      "userNumber": "+1234567890"
    },
    "callDuration": 125,
    "channelType": "TELEPHONE",
    "callAnalysis": {},
    "voiceAgent": {
      "voiceAgentWebTools": [
        {
          "webTool": {}
        }
      ],
      "webTools": {},
      "voiceAgentKnowledgeBases": [
        {
          "knowledgeBaseItem": {}
        }
      ]
    },
    "logs": [
      {
        "id": "log_123",
        "timestamp": "2024-01-15T10:30:15Z",
        "payload": {},
        "createdAt": "2024-01-15T10:30:15Z",
        "updatedAt": "2024-01-15T10:30:15Z"
      }
    ],
    "performanceMetrics": {}
  }
}

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 '

Path Parameters

conversationId
string<uuid>
required

UUID of the conversation to retrieve.

Example:

"849e77c6-5cb3-479a-a985-7fab630e2c78"

Response

Successful response

success
boolean
Example:

true

message
string
Example:

"Success"

data
object