curl --request POST \
--url https://api.tryhamsa.com/v1/voice-agents/conversations/list \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"returnedFields": [
"time",
"status",
"channelType",
"agentName",
"callNumbers"
],
"status": [
"COMPLETED"
],
"period": "THIS_WEEK",
"timeZone": "Asia/Riyadh",
"take": 10,
"skip": 1,
"sortField": "time",
"sortOrder": "desc"
}
'{
"success": true,
"message": "success",
"data": {
"total": 128,
"filtered": 10,
"conversations": [
{
"id": "849e77c6-5cb3-479a-a985-7fab630e2c78",
"duration": 74,
"time": "2026-11-02T10:06:08.109Z",
"cost": 5,
"status": "COMPLETED",
"channelType": "Telephone",
"agentId": "48f7656f-098b-4c43-b165-7cfd2cc8ac30",
"agentName": "Support Agent",
"callParams": {
"userNumber": "+966500000001",
"machineNumber": "+966500000002"
},
"release": {
"versionId": "5e7a9c1b-3d2f-4a6e-8b0c-1f2e3d4c5b6a",
"versionNumber": 3,
"draftRevisionId": null,
"environmentId": "a2c4e6f8-1b3d-4f5a-8c7e-9d0b1a2c3e4f",
"environmentName": "prod",
"environmentRevisionId": "0c2e4a6b-8d1f-4e3a-9b5c-7d9e1f3a5b7c",
"chosenBySplit": false
},
"performanceMetrics": {
"asrProcessingTime": 320,
"llmResponseTime": 910,
"ttsGenerationTime": 410,
"totalProcessingTime": 1640
},
"turns": 14,
"isTakenOver": false,
"toolFailed": false,
"analytics": {
"status": "COMPLETED",
"isResolved": true,
"isHandedOff": false,
"sentiment": "neutral",
"totalProcessingTimeMs": 1840,
"errors": {
"any": false,
"asr": false,
"llm": false,
"tts": false
},
"kbGapType": null,
"outOfScopeRequests": [
"refund status"
]
}
}
]
}
}{
"code": 8404,
"message": "Policy not found!",
"messageKey": "PolicyNotFound",
"params": {
"reason": "NO_DRAFT"
}
}{
"code": 8404,
"message": "Policy not found!",
"messageKey": "PolicyNotFound",
"params": {
"reason": "NO_DRAFT"
}
}{
"code": 8404,
"message": "Policy not found!",
"messageKey": "PolicyNotFound",
"params": {
"reason": "NO_DRAFT"
}
}{
"code": 8404,
"message": "Policy not found!",
"messageKey": "PolicyNotFound",
"params": {
"reason": "NO_DRAFT"
}
}List Calls
Returns your project’s calls, newest first by default, filtered and one page at a time. Choose the fields to return in returnedFields. period only filters when you also send timeZone (or a CUSTOM range with startPeriod): without them, calls from all time are listed.
curl --request POST \
--url https://api.tryhamsa.com/v1/voice-agents/conversations/list \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"returnedFields": [
"time",
"status",
"channelType",
"agentName",
"callNumbers"
],
"status": [
"COMPLETED"
],
"period": "THIS_WEEK",
"timeZone": "Asia/Riyadh",
"take": 10,
"skip": 1,
"sortField": "time",
"sortOrder": "desc"
}
'{
"success": true,
"message": "success",
"data": {
"total": 128,
"filtered": 10,
"conversations": [
{
"id": "849e77c6-5cb3-479a-a985-7fab630e2c78",
"duration": 74,
"time": "2026-11-02T10:06:08.109Z",
"cost": 5,
"status": "COMPLETED",
"channelType": "Telephone",
"agentId": "48f7656f-098b-4c43-b165-7cfd2cc8ac30",
"agentName": "Support Agent",
"callParams": {
"userNumber": "+966500000001",
"machineNumber": "+966500000002"
},
"release": {
"versionId": "5e7a9c1b-3d2f-4a6e-8b0c-1f2e3d4c5b6a",
"versionNumber": 3,
"draftRevisionId": null,
"environmentId": "a2c4e6f8-1b3d-4f5a-8c7e-9d0b1a2c3e4f",
"environmentName": "prod",
"environmentRevisionId": "0c2e4a6b-8d1f-4e3a-9b5c-7d9e1f3a5b7c",
"chosenBySplit": false
},
"performanceMetrics": {
"asrProcessingTime": 320,
"llmResponseTime": 910,
"ttsGenerationTime": 410,
"totalProcessingTime": 1640
},
"turns": 14,
"isTakenOver": false,
"toolFailed": false,
"analytics": {
"status": "COMPLETED",
"isResolved": true,
"isHandedOff": false,
"sentiment": "neutral",
"totalProcessingTimeMs": 1840,
"errors": {
"any": false,
"asr": false,
"llm": false,
"tts": false
},
"kbGapType": null,
"outOfScopeRequests": [
"refund status"
]
}
}
]
}
}{
"code": 8404,
"message": "Policy not found!",
"messageKey": "PolicyNotFound",
"params": {
"reason": "NO_DRAFT"
}
}{
"code": 8404,
"message": "Policy not found!",
"messageKey": "PolicyNotFound",
"params": {
"reason": "NO_DRAFT"
}
}{
"code": 8404,
"message": "Policy not found!",
"messageKey": "PolicyNotFound",
"params": {
"reason": "NO_DRAFT"
}
}{
"code": 8404,
"message": "Policy not found!",
"messageKey": "PolicyNotFound",
"params": {
"reason": "NO_DRAFT"
}
}Authorizations
Body
Fields to fill for each call. callNumbers returns callParams. performanceMetrics, turns, isTakenOver, toolFailed and analytics need extra reads: ask only for what you show.
1time, cost, status, channelType, agentName, agentId, callNumbers, release, performanceMetrics, turns, isTakenOver, toolFailed, analytics [
"time",
"status",
"channelType",
"agentName"
]
Only calls with these statuses. Ignored when returnActiveCalls is true. An IN_PROGRESS call is listed only if it started in the last hour, the same window as returnActiveCalls; other statuses in the filter are not limited.
1PENDING, IN_PROGRESS, COMPLETED, NO_ANSWER, FAILED, FORWARDED, TERMINATED ["COMPLETED"]
Time range: LAST_HOUR, TODAY (default), YESTERDAY, THIS_WEEK (weeks start on Sunday), THIS_MONTH, or CUSTOM (send startPeriod and endPeriod). Day, week and month boundaries are computed in timeZone. Applied only with timeZone (or startPeriod for CUSTOM).
LAST_HOUR, TODAY, YESTERDAY, THIS_WEEK, THIS_MONTH, CUSTOM "THIS_WEEK"
Was this page helpful?