Skip to main content

​
Endpoint

GET https://video.apifycloud.io/api/calls/{callId}

​
Path parameters

  • callId (UUID, required)

​
Response

{
  "ok": true,
  "data": {
    "callId": "uuid",
    "status": "created",
    "presetId": "string",
    "title": "string",
    "description": "string",
    "metadata": {},
    "hostName": "string",
    "guestName": "string",
    "provider": {
      "name": "realtimekit",
      "meetingId": "string"
    },
    "genesys": {
      "conversationId": "string",
      "gcHostOrigin": "string",
      "gcTargetEnv": "string",
      "gcLangTag": "string",
      "gcUsePopupAuth": true
    },
    "participants": [
      {
        "id": "uuid",
        "providerParticipantId": "string",
        "role": "host",
        "name": "Agent",
        "joinedAt": "2024-01-01T00:00:00.000Z",
        "leftAt": null,
        "billedMinutes": 5.2
      }
    ],
    "usage": {
      "participantMinutes": 10.4
    },
    "recordings": [
      {
        "id": "uuid",
        "providerArchiveId": "string",
        "url": "https://...",
        "status": "available",
        "createdAt": "2024-01-01T00:00:00.000Z",
        "updatedAt": "2024-01-01T00:00:00.000Z"
      }
    ]
  }
}

​
Call fields

FieldTypeDescription
callIdstringUnique call identifier.
statusstringCall status: created, active, ended.
presetIdstringPreset used for the call.
titlestring | nullCall title, if set at creation.
descriptionstring | nullCall description, if set at creation.
metadataobject | nullFree-form metadata, if set at creation.
hostNamestring | nullCustom host display name, if set at creation.
guestNamestring | nullCustom guest display name, if set at creation.
providerobject | nullMeeting provider details.
genesysobjectGenesys Cloud context fields.

​
Participant fields

FieldTypeDescription
idstringParticipant record ID.
rolestringhost or participant.
namestringDisplay name used in the meeting.
joinedAtstringISO 8601 join timestamp.
leftAtstring | nullISO 8601 leave timestamp, or null if still connected.
billedMinutesnumberMinutes billed for this participant.

​
Recording fields

FieldTypeDescription
idstringRecording record ID.
urlstring | nullDownload URL (may expire).
statusstringprocessing, available, failed.

​
Errors

  • 404 call not found
  • 500 internal server error

​
Example

curl "https://video.apifycloud.io/api/calls/{callId}"