GET
/
v1
/
voice-agents
curl --request GET \
  --url https://api.tryhamsa.com/v1/voice-agents \
  --header 'Authorization: <api-key>'
{
  "success": false,
  "message": "success",
  "data": {
    "total": 123,
    "filtered": 123,
    "voiceAgents": [
      {
        "id": "<string>",
        "agentName": "<string>",
        "greetingMessage": "<string>",
        "description": "<string>",
        "preamble": "<string>",
        "lang": "<string>",
        "pokeMessages": [
          "<string>"
        ],
        "realTime": true,
        "silenceThreshold": 123,
        "interrupt": true,
        "outcome": "<string>",
        "projectId": "<string>",
        "apiKeyId": "<string>",
        "voiceRecordId": "<string>",
        "voiceRecord": {},
        "tools": {
          "id": "<string>",
          "calendarName": "<string>",
          "accessToken": "<string>",
          "refreshToken": "<string>",
          "freeSlots": {
            "Monday": [
              [
                {
                  "from": "<string>",
                  "to": "<string>"
                }
              ]
            ],
            "Tuesday": [
              [
                {
                  "from": "<string>",
                  "to": "<string>"
                }
              ]
            ],
            "Wednesday": [
              [
                {
                  "from": "<string>",
                  "to": "<string>"
                }
              ]
            ],
            "Thursday": [
              [
                {
                  "from": "<string>",
                  "to": "<string>"
                }
              ]
            ],
            "Friday": [
              [
                {
                  "from": "<string>",
                  "to": "<string>"
                }
              ]
            ],
            "Saturday": [
              [
                {
                  "from": "<string>",
                  "to": "<string>"
                }
              ]
            ],
            "Sunday": [
              [
                {
                  "from": "<string>",
                  "to": "<string>"
                }
              ]
            ]
          },
          "meetingDuration": 123,
          "timezone": "<string>",
          "voiceAgentToolsId": "<string>",
          "calendarId": "<string>",
          "eventTitle": "<string>"
        },
        "params": {},
        "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 <api-key>'

Query Parameters

​
skip
integer
default:1
​
take
integer
default:10

Response

200
application/json
Successful response
​
success
boolean
default:false
​
message
string
default:success
​
data
object