Call Recordings
Function-calling namespace: callRecordings
- Base URL:
https://api.aivida.in - Engine endpoint:
POST /api - Auth: Stack token middleware enabled in
optionalmode. - Send token in header:
x-stack-access-token: <access_token>(orAuthorization: Bearer <access_token>). - In
optionalmode: no token is allowed; invalid token is rejected with401.
create
Source: backend/endpoints/call-recordings/create
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
appointmentId | string | Yes | - |
organizationId | string | Yes | - |
channelName | string | Yes | - |
status | string | No | - |
createdBy | string | Yes | - |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "callRecordings",
"apiName": "create",
"data": {
"appointmentId": "appointment_123",
"organizationId": "org_123",
"channelName": "value",
"createdBy": "value"
}
}'Example Response
{ "status": "ok", "data": {} }delete
Source: backend/endpoints/call-recordings/delete
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
id | string | Yes | - |
organizationId | string | Yes | - |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "callRecordings",
"apiName": "delete",
"data": {
"id": "id_123",
"organizationId": "org_123"
}
}'Example Response
{ "status": "ok", "data": {} }getById
Source: backend/endpoints/call-recordings/get-by-id
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
id | string | Yes | - |
organizationId | string | Yes | - |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "callRecordings",
"apiName": "getById",
"data": {
"id": "id_123",
"organizationId": "org_123"
}
}'Example Response
{ "status": "ok", "data": {} }listByOrganization
Source: backend/endpoints/call-recordings/list-by-organization
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
organizationId | string | Yes | - |
page | integer | No | - |
pageSize | integer | No | - |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "callRecordings",
"apiName": "listByOrganization",
"data": {
"organizationId": "org_123"
}
}'Example Response
{ "status": "ok", "data": {} }startStreamRecording
Source: backend/endpoints/call-recordings/start-stream
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
appointmentId | string | Yes | - |
organizationId | string | Yes | - |
stackUserId | string | Yes | - |
callType | string | Yes | - |
callId | string | Yes | - |
callCid | string | No | - |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "callRecordings",
"apiName": "startStreamRecording",
"data": {
"appointmentId": "appointment_123",
"organizationId": "org_123",
"stackUserId": "stackuser_123",
"callType": "general",
"callId": "call_123"
}
}'Example Response
{ "status": "ok", "data": {} }stopStreamRecording
Source: backend/endpoints/call-recordings/stop-stream
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
appointmentId | string | Yes | - |
organizationId | string | Yes | - |
stackUserId | string | Yes | - |
callType | string | Yes | - |
callId | string | Yes | - |
callCid | string | No | - |
reason | string | No | - |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "callRecordings",
"apiName": "stopStreamRecording",
"data": {
"appointmentId": "appointment_123",
"organizationId": "org_123",
"stackUserId": "stackuser_123",
"callType": "general",
"callId": "call_123"
}
}'Example Response
{ "status": "ok", "data": {} }syncStreamRecordingArtifacts
Source: backend/endpoints/call-recordings/sync-stream
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
appointmentId | string | Yes | - |
organizationId | string | Yes | - |
stackUserId | string | Yes | - |
callType | string | Yes | - |
callId | string | Yes | - |
callCid | string | No | - |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "callRecordings",
"apiName": "syncStreamRecordingArtifacts",
"data": {
"appointmentId": "appointment_123",
"organizationId": "org_123",
"stackUserId": "stackuser_123",
"callType": "general",
"callId": "call_123"
}
}'Example Response
{ "status": "ok", "data": {} }update
Source: backend/endpoints/call-recordings/update
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
id | string | Yes | - |
organizationId | string | Yes | - |
status | string | No | nullable |
error | string | No | nullable |
stopReason | string | No | nullable |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "callRecordings",
"apiName": "update",
"data": {
"id": "id_123",
"organizationId": "org_123"
}
}'Example Response
{ "status": "ok", "data": {} }