Skip to main content
Version: v2

FoundRecording

A found conference recording with matches

recording objectrequired

Conference recording information

recordingIdstringrequired

Recording ID

Example: AIQffAsGi8
conferenceIdstringrequired

Conference ID

Example: BIQffAsGi8
chatIdstring

ID of the conference chat

Example: w:AIQffAsGi8
titlestring

Recording title

Example: Weekly meeting
createdAtstring<date-time>required

Date and time the recording was created

Example: 2024-02-26T18:58:36.154+03:00
searchOccurrences object[]required

Array of found matches in the recording

  • Array [
  • phrasestringrequired

    Original text

    Example: transcription text
    occurrencestringrequired

    Match text with highlighting

    Example: ==transcription== text
    fromStartstring

    Offset from the start of the recording in ISO 8601 Duration format

    Example: PT1M30S
    membershipIdstring

    MembershipId of the speaker

    Example: AIQffAsGi8
    guestIdstring

    Conference guest ID

    Example: AIQffAsGi8
    typeOccurrenceType (string)required

    Type of content in which the match was found

    Possible values: [TRANSCRIPTION, SUMMARY, TITLE]

    Example: TRANSCRIPTION
  • ]
  • FoundRecording
    {
    "recording": {
    "recordingId": "AIQffAsGi8",
    "conferenceId": "BIQffAsGi8",
    "chatId": "w:AIQffAsGi8",
    "title": "Weekly meeting",
    "createdAt": "2024-02-26T18:58:36.154+03:00"
    },
    "searchOccurrences": [
    {
    "phrase": "transcription text",
    "occurrence": "==transcription== text",
    "fromStart": "PT1M30S",
    "membershipId": "AIQffAsGi8",
    "guestId": "AIQffAsGi8",
    "type": "TRANSCRIPTION"
    }
    ]
    }