API žinynas
Visi VoiceCap API galiniai taškai ir webhook įvykiai su parametrais ir laukais.
Kiekvienas galinis taškas priima jūsų API raktą kaip bearer žetoną ir yra po žemiau nurodytu baziniu adresu. Tas pats žinynas pateikiamas ir kaip OpenAPI 3.1 failas įrankiams, kurie jį skaito.
https://voicecap.ai/api/v1
Galiniai taškai
Gauti rakto savininką
GET /me
Žmogus, kurio vardu veikia raktas, ir jo organizacija. Tinka raktui patikrinti ir ryšiui pavadinti.
Atsakymas
data laukai:
| Laukas | Tipas | Privalomas |
|---|---|---|
user | objektas | taip |
user.id | string | taip |
user.email | string (email) | taip |
user.name | string arba null | taip |
user.image | string arba null | ne |
user.emailVerified | boolean | taip |
org | objektas arba null | taip |
org.id | string | taip |
org.name | string | taip |
org.slug | string | taip |
org.domain | string arba null | taip |
role | viena iš: owner, admin, member, viewer arba null | taip |
memberSince | string | ne |
Klaidos: Kiekviename galiniame taške 401, 403 ir 429.
Pavyzdys
curl -H "Authorization: Bearer $VOICECAP_API_KEY" \
"https://voicecap.ai/api/v1/me"
Gauti susitikimų sąrašą
GET /meetings
Susitikimai, kuriuos rakto savininkas gali atidaryti, pagal nutylėjimą naujausi pirmi. Puslapiuojama pagal puslapio numerį.
Parametrai
| Pavadinimas | Vieta | Tipas | Privalomas | Aprašymas |
|---|---|---|---|---|
page | query | integer | ne | Puslapio numeris nuo 1. Numatytoji reikšmė 1. |
limit | query | integer | ne | Kiek grąžinti, nuo 1 iki 100. Numatytoji reikšmė 20. |
sortBy | query | viena iš: date, title, duration, completedAt | ne | date (kada vyko susitikimas), title, duration arba completedAt (kada baigtas apdoroti). Numatytoji reikšmė date. |
sortOrder | query | viena iš: asc, desc | ne | asc arba desc. Numatytoji reikšmė desc. |
status | query | viena iš: all, completed, processing, failed | ne | all, completed, processing arba failed. Numatytoji reikšmė all. |
dateFrom | query | string | ne | Tik susitikimai nuo šios dienos imtinai, formatu YYYY-MM-DD. |
dateTo | query | string | ne | Tik susitikimai iki šios dienos imtinai, formatu YYYY-MM-DD. |
search | query | string | ne | Tik susitikimai, kurių pavadinime ar transkripcijoje minimas šis tekstas. |
completedAfter | query | string (date-time) | ne | Tik baigti susitikimai, apdoroti po šio momento. ISO 8601 su laiko zona. |
Atsakymas
data laukai:
| Laukas | Tipas | Privalomas |
|---|---|---|
meetings | masyvas: objektas | taip |
meetings[].id | string (uuid) | taip |
meetings[].title | string | taip |
meetings[].createdAt | string | taip |
meetings[].recordedAt | string arba null | ne |
meetings[].updatedAt | string | taip |
meetings[].audioDurationSeconds | number arba null | taip |
meetings[].status | viena iš: uploading, pending, recording, processing, summarizing, completed, failed | taip |
meetings[].sharedWithOrg | boolean | taip |
meetings[].linkEnabled | boolean | taip |
meetings[].sharedWithPeople | boolean | taip |
meetings[].sharedWithGroups | boolean | taip |
meetings[].errorMessage | "processing_failed" arba null | taip |
meetings[].summaryPreview | string arba null | taip |
meetings[].actionItemsCount | number | taip |
totalCount | number | taip |
hasMore | boolean | taip |
Klaidos: 400 ir kiekviename galiniame taške 401, 403 bei 429.
Pavyzdys
curl -H "Authorization: Bearer $VOICECAP_API_KEY" \
"https://voicecap.ai/api/v1/meetings?status=completed&sortBy=completedAt&limit=5"
Gauti susitikimą
GET /meetings/{id}
Vienas susitikimas su santrauka, užduotimis, pagrindinėmis temomis ir transkripcija. Jei rakto savininkas susitikimo atidaryti negali, atsakymas yra 404. Per ilga transkripcija (daug valandų trunkančio įrašo) grąžinama su omitted: true ir be teksto: perskaitykite ją su „Gauti transkripcijos dalį“.
Parametrai
| Pavadinimas | Vieta | Tipas | Privalomas | Aprašymas |
|---|---|---|---|---|
id | path | string | taip | Susitikimo id. |
Atsakymas
data laukai:
| Laukas | Tipas | Privalomas |
|---|---|---|
id | string (uuid) | taip |
title | string | taip |
createdAt | string | taip |
audioDurationSeconds | number arba null | taip |
status | viena iš: uploading, pending, recording, processing, summarizing, completed, failed | taip |
sharedWithOrg | boolean | taip |
linkEnabled | boolean | taip |
userId | string | taip |
language | string | taip |
errorMessage | "processing_failed" arba null | taip |
updatedAt | string | taip |
canEdit | boolean | taip |
canDelete | boolean | taip |
canDownload | boolean | taip |
canShare | boolean | taip |
transcript | objektas arba null | taip |
transcript.fullText | string arba null | taip |
transcript.segments | masyvas: objektas arba null | taip |
transcript.speakers | objektas arba null | taip |
transcript.omitted | boolean | taip |
summary | objektas arba null | taip |
summary.summary | string arba null | taip |
summary.actionItems | masyvas: objektas arba null | taip |
summary.keyTopics | masyvas: string arba masyvas: objektas arba null | taip |
participantEmailMode | viena iš: none, internal, all arba null | taip |
files | masyvas: objektas | taip |
files[].id | string (uuid) | taip |
files[].meetingId | string (uuid) | taip |
files[].fileName | string | taip |
files[].durationSeconds | number arba null | taip |
files[].language | string | taip |
files[].status | viena iš: uploading, pending, processing, completed, failed | taip |
files[].speakers | objektas arba null | taip |
files[].errorMessage | "processing_failed" arba null | taip |
files[].createdAt | string | taip |
files[].updatedAt | string | taip |
recordedAt | string arba null | ne |
calendarEventId | string (uuid) arba null | ne |
Klaidos: 404 ir kiekviename galiniame taške 401, 403 bei 429.
Pavyzdys
curl -H "Authorization: Bearer $VOICECAP_API_KEY" \
"https://voicecap.ai/api/v1/meetings/0f8c2a4e-7b1d-4c3e-9a5f-2d6b8e1c4a7f"
Gauti transkripcijos dalį
GET /meetings/{id}/transcript
Transkripcija dalimis iki 15 minučių, kad galėtumėte perskaityti bet kokio ilgio susitikimą. Pradėkite su startSeconds 0 ir perduokite nextStartSeconds kaip startSeconds, kol jis taps null: kiekvienas segmentas grąžinamas lygiai vieną kartą. Labai tankioje vietoje dalis gali baigtis anksčiau. Susitikimas be transkripcijos grąžina 404 no_transcript.
Parametrai
| Pavadinimas | Vieta | Tipas | Privalomas | Aprašymas |
|---|---|---|---|---|
id | path | string | taip | Susitikimo id. |
startSeconds | query | number | ne | Kur prasideda dalis, sekundėmis nuo įrašo pradžios. Numatytoji reikšmė 0. |
Atsakymas
data laukai:
| Laukas | Tipas | Privalomas |
|---|---|---|
meetingId | string (uuid) | taip |
durationSeconds | number arba null | taip |
startSeconds | number | taip |
endSeconds | number | taip |
segments | masyvas: objektas | taip |
segments[].speaker | string | taip |
segments[].text | string | taip |
segments[].start | number | taip |
segments[].end | number | taip |
speakers | objektas arba null | taip |
nextStartSeconds | number arba null | taip |
Klaidos: 400, 404 ir kiekviename galiniame taške 401, 403 bei 429.
Pavyzdys
curl -H "Authorization: Bearer $VOICECAP_API_KEY" \
"https://voicecap.ai/api/v1/meetings/0f8c2a4e-7b1d-4c3e-9a5f-2d6b8e1c4a7f/transcript?startSeconds=0"
Eksportuoti susitikimą
GET /meetings/{id}/export
Susitikimas kaip failas: PDF, Word, paprastas tekstas arba subtitrai. Sėkmingas atsakymas yra pats failas, ne JSON. Klaidos grąžinamos įprastu klaidos formatu; srt susitikimui be transkripcijos grąžina 404 no_transcript.
Parametrai
| Pavadinimas | Vieta | Tipas | Privalomas | Aprašymas |
|---|---|---|---|---|
id | path | string | taip | Susitikimo id. |
format | query | viena iš: pdf, docx, txt, srt | taip | pdf, docx, txt arba srt. |
sections | query | string | ne | Atskirta kableliais: summary, actionItems, keyTopics, transcript. Pagal nutylėjimą visos. srt visada yra tik transkripcija. |
Atsakymas
Sėkmingas atsakymas yra pats failas, vieno iš šių tipų:
application/pdfapplication/vnd.openxmlformats-officedocument.wordprocessingml.documentapplication/x-subrip; charset=utf-8text/plain; charset=utf-8
Klaidos: 400, 404 ir kiekviename galiniame taške 401, 403 bei 429.
Pavyzdys
curl -H "Authorization: Bearer $VOICECAP_API_KEY" \
"https://voicecap.ai/api/v1/meetings/0f8c2a4e-7b1d-4c3e-9a5f-2d6b8e1c4a7f/export?format=txt§ions=transcript"
Ieškoti susitikimuose
GET /search
Ieško to, kas buvo pasakyta susitikimuose, kuriuos rakto savininkas gali atidaryti. Tai ta pati paieška kaip programėlėje.
Parametrai
| Pavadinimas | Vieta | Tipas | Privalomas | Aprašymas |
|---|---|---|---|---|
q | query | string | taip | Ko ieškoti, iki 500 simbolių. |
limit | query | integer | ne | Kiek grąžinti, nuo 1 iki 100. Numatytoji reikšmė 20. |
offset | query | integer | ne | Kiek praleisti, iki 118. Numatytoji reikšmė 0. |
Atsakymas
data laukai:
| Laukas | Tipas | Privalomas |
|---|---|---|
results | masyvas: objektas | taip |
results[].meetingId | string (uuid) | taip |
results[].meetingTitle | string | taip |
results[].meetingDate | string | taip |
results[].durationSeconds | number arba null | taip |
results[].status | viena iš: uploading, pending, recording, processing, summarizing, completed, failed | taip |
results[].headline | string | taip |
results[].source | viena iš: transcript, summary, decision | ne |
results[].startSeconds | number arba null | ne |
results[].url | string | ne |
total | number | taip |
query | string | taip |
hasMore | boolean | ne |
Klaidos: 400 ir kiekviename galiniame taške 401, 403 bei 429.
Pavyzdys
curl -H "Authorization: Bearer $VOICECAP_API_KEY" \
"https://voicecap.ai/api/v1/search?q=pricing&limit=10"
Gauti sprendimų sąrašą
GET /decisions
Sprendimai iš susitikimų, kuriuos rakto savininkas gali atidaryti, naujausi pirmi.
Parametrai
| Pavadinimas | Vieta | Tipas | Privalomas | Aprašymas |
|---|---|---|---|---|
limit | query | integer | ne | Kiek grąžinti, nuo 1 iki 100. Numatytoji reikšmė 25. |
offset | query | integer | ne | Kiek praleisti, iki 1000. Numatytoji reikšmė 0. |
meetingId | query | string (uuid) | ne | Tik šio susitikimo sprendimai. |
since | query | string (date-time) | ne | Tik sprendimai, užfiksuoti po šio momento. ISO 8601 su laiko zona, pvz., 2026-10-01T09:00:00Z. |
q | query | string | ne | Tik sprendimai, kurių tekste ar kontekste yra šis tekstas, neatsižvelgiant į raidžių dydį. |
groupId | query | string (uuid) | ne | Tik sprendimai iš susitikimų, priskirtų šiai grupei. Rakto savininkas turi priklausyti grupei, nebent mato visus susitikimus; bet kuri kita grupė grąžina 404. |
Atsakymas
data laukai:
| Laukas | Tipas | Privalomas |
|---|---|---|
decisions | masyvas: objektas | taip |
decisions[].id | string (uuid) | taip |
decisions[].statement | string | taip |
decisions[].context | string arba null | taip |
decisions[].decidedBy | string arba null | taip |
decisions[].meetingId | string (uuid) | taip |
decisions[].meetingTitle | string | taip |
decisions[].meetingDate | string | taip |
decisions[].createdAt | string | taip |
decisions[].url | string | taip |
hasMore | boolean | taip |
Klaidos: 400, 404 ir kiekviename galiniame taške 401, 403 bei 429.
Pavyzdys
curl -H "Authorization: Bearer $VOICECAP_API_KEY" \
"https://voicecap.ai/api/v1/decisions?since=2026-10-01T00:00:00Z&limit=25"
Gauti užduočių sąrašą
GET /action-items
Užduotys iš susitikimų, kuriuos rakto savininkas gali atidaryti, pirmiausia iš vėliausiai apdoroto susitikimo. Senesnėms užduotims siaurinkite su since arba meetingId, užuot puslapiavę toli atgal. Iš vieno susitikimo perskaitoma ne daugiau kaip 200 užduočių; visą sąrašą grąžina „Gauti susitikimą“.
Parametrai
| Pavadinimas | Vieta | Tipas | Privalomas | Aprašymas |
|---|---|---|---|---|
limit | query | integer | ne | Kiek grąžinti, nuo 1 iki 100. Numatytoji reikšmė 25. |
offset | query | integer | ne | Kiek praleisti, iki 1000. Numatytoji reikšmė 0. |
meetingId | query | string (uuid) | ne | Tik šio susitikimo užduotys. |
since | query | string (date-time) | ne | Tik užduotys iš susitikimų, apdorotų po šio momento. ISO 8601 su laiko zona, pvz., 2026-10-01T09:00:00Z. |
assignedToMe | query | viena iš: true, false | ne | true, jei reikia tik rakto savininkui priskirtų užduočių. |
completed | query | viena iš: true, false | ne | true, jei reikia tik atliktų užduočių, false, jei tik neatliktų. |
Atsakymas
data laukai:
| Laukas | Tipas | Privalomas |
|---|---|---|
actionItems | masyvas: objektas | taip |
actionItems[].id | string arba null | taip |
actionItems[].text | string | taip |
actionItems[].assignee | string arba null | taip |
actionItems[].completed | boolean | taip |
actionItems[].timestamp | number arba null | taip |
actionItems[].meetingId | string (uuid) | taip |
actionItems[].meetingTitle | string | taip |
actionItems[].meetingDate | string | taip |
actionItems[].completedAt | string | taip |
actionItems[].url | string | taip |
hasMore | boolean | taip |
truncated | boolean | taip |
Klaidos: 400 ir kiekviename galiniame taške 401, 403 bei 429.
Pavyzdys
curl -H "Authorization: Bearer $VOICECAP_API_KEY" \
"https://voicecap.ai/api/v1/action-items?assignedToMe=true&completed=false"
Gauti grupių sąrašą
GET /groups
Grupės, kurias rakto savininkas mato. Be limit ir offset grąžinamos visos grupės, o hasMore nepateikiamas. Administratorius mato visas grupes, bet filtruoti pagal grupę gali tik jai priklausydamas, nebent mato visus susitikimus: isMember rodo, kurioms grupėms jis priklauso.
Parametrai
| Pavadinimas | Vieta | Tipas | Privalomas | Aprašymas |
|---|---|---|---|---|
limit | query | integer | ne | Kiek grąžinti, nuo 1 iki 100. Be jo grąžinami visi rezultatai. |
offset | query | integer | ne | Kiek praleisti. Numatytoji reikšmė 0. |
Atsakymas
data laukai:
| Laukas | Tipas | Privalomas |
|---|---|---|
groups | masyvas: objektas | taip |
groups[].id | string (uuid) | taip |
groups[].name | string | taip |
groups[].description | string | ne |
groups[].memberIds | masyvas: string | taip |
groups[].memberCount | integer | taip |
groups[].createdBy | string | ne |
groups[].canEdit | boolean | ne |
groups[].isMember | boolean | ne |
groups[].companyWide | boolean | ne |
groups[].updatedAt | string | ne |
hasMore | boolean | ne |
Klaidos: 400 ir kiekviename galiniame taške 401, 403 bei 429.
Pavyzdys
curl -H "Authorization: Bearer $VOICECAP_API_KEY" \
"https://voicecap.ai/api/v1/groups?limit=50"
Užsakyti webhook
POST /hooks
Siunčia įvykį į jūsų HTTPS adresą kiekvieną kartą, kai jis įvyksta. Prieš pradėdamas prenumeratą VoiceCap siunčia pasirašytą bandomąją užklausą su iššūkiu, kurį jūsų galinis taškas turi grąžinti: atsakykite tik {"challenge": "…"}, ne visa užklausa. Atsakyme yra pasirašymo paslaptis, rodoma tik čia. Tą patį įvykį, adresą ir filtrus su tuo pačiu raktu užsakius dar kartą, grąžinama esama prenumerata su nauja paslaptimi. Kol ji aktyvi, senoji paslaptis galioja dar 24 valandas; sustabdyta prenumerata patikrinama iš naujo ir iškart pereina prie naujos paslapties.
Šį galinį tašką galima kviesti tik su API raktu.
Užklausos turinys
| Laukas | Tipas | Privalomas |
|---|---|---|
event | string | taip |
targetUrl | string | taip |
filters | objektas | ne |
Atsakymas
data laukai:
| Laukas | Tipas | Privalomas |
|---|---|---|
id | string | taip |
event | string | taip |
filters | objektas | taip |
secret | string | taip |
created | boolean | taip |
Klaidos: 400, 409, 422 ir kiekviename galiniame taške 401, 403 bei 429.
Pavyzdys
curl -X POST -H "Authorization: Bearer $VOICECAP_API_KEY" \
-H "Content-Type: application/json" \
-d '{"event":"meeting.completed","targetUrl":"https://example.com/voicecap","filters":{"scope":"mine"}}' \
"https://voicecap.ai/api/v1/hooks"
Gauti webhook sąrašą
GET /hooks
Šiuo raktu sukurtos prenumeratos. Rodomas tik kiekvieno adreso serveris, niekada visas adresas.
Šį galinį tašką galima kviesti tik su API raktu.
Atsakymas
data laukai:
| Laukas | Tipas | Privalomas |
|---|---|---|
hooks | masyvas: objektas | taip |
hooks[].id | string | taip |
hooks[].event | string | taip |
hooks[].filters | objektas | taip |
hooks[].targetHost | string | taip |
hooks[].status | viena iš: active, suspended, expired, revoked | taip |
hooks[].statusReason | string arba null | taip |
hooks[].lastDeliveryAt | string arba null | taip |
hooks[].lastErrorCategory | string arba null | taip |
hooks[].createdAt | string | taip |
Klaidos: Kiekviename galiniame taške 401, 403 ir 429.
Pavyzdys
curl -H "Authorization: Bearer $VOICECAP_API_KEY" \
"https://voicecap.ai/api/v1/hooks"
Atsisakyti webhook
DELETE /hooks/{id}
Sustabdo šiuo raktu sukurtą prenumeratą. Visada atsako deleted: true, net jei id jau nebegalioja ar priklauso kitam, todėl kartoti saugu.
Šį galinį tašką galima kviesti tik su API raktu.
Parametrai
| Pavadinimas | Vieta | Tipas | Privalomas | Aprašymas |
|---|---|---|---|---|
id | path | string | taip | Prenumeratos id iš užsakymo atsakymo. |
Atsakymas
data laukai:
| Laukas | Tipas | Privalomas |
|---|---|---|
deleted | true | taip |
Klaidos: Kiekviename galiniame taške 401, 403 ir 429.
Pavyzdys
curl -X DELETE -H "Authorization: Bearer $VOICECAP_API_KEY" \
"https://voicecap.ai/api/v1/hooks/3d5e7f90-1a2b-4c3d-8e9f-0a1b2c3d4e5f"
Gauti naujausius įvykius
GET /hooks/sample
Įvykiai, lygiai tokie, kaip pristatymo lauke data, iki 10 per kvietimą. Be since ar cursor: naujausi, naujausi pirmi, prenumeratai išbandyti. Su bet kuriuo jų: seniausi pirmi nuo to momento, periodinei apklausai vietoj prenumeratos. Kitame kvietime nextCursor perduokite kaip cursor ir, kol hasMore yra true, kvieskite iš karto vėl, kad nepraleistumėte nė vieno įvykio.
Šį galinį tašką galima kviesti tik su API raktu.
Parametrai
| Pavadinimas | Vieta | Tipas | Privalomas | Aprašymas |
|---|---|---|---|---|
event | query | string | taip | Įvykio pavadinimas: meeting.completed, decision.recorded arba action_item.created. |
since | query | string (date-time) | ne | Tik įvykiai po šio momento. ISO 8601 su laiko zona, pvz., 2026-10-01T09:00:00Z. |
cursor | query | string | ne | nextCursor iš ankstesnio kvietimo. Apklausa tęsiama lygiai nuo jo. Turi pirmenybę prieš since. |
limit | query | integer | ne | Kiek grąžinti, nuo 1 iki 10. Numatytoji reikšmė 10. |
filters | query | objektas | ne | Tie patys filtrai kaip prenumeratai, po vieną užklausos parametrą, pvz., scope=mine arba assignedToMe=true. |
Atsakymas
data laukai:
| Laukas | Tipas | Privalomas |
|---|---|---|
items | masyvas: objektas | taip |
items[].id | string | taip |
nextCursor | string arba null | taip |
hasMore | boolean | taip |
Klaidos: 400, 422 ir kiekviename galiniame taške 401, 403 bei 429.
Pavyzdys
curl -H "Authorization: Bearer $VOICECAP_API_KEY" \
"https://voicecap.ai/api/v1/hooks/sample?event=meeting.completed&limit=3"
Webhook įvykiai
Kiekvienas pristatymas yra POST užklausa su turiniu { eventId, name, timestamp, data, cursor }. Užsakykite nurodę įvykio pavadinimą ir bet kuriuos jo filtrus.
Susitikimas baigtas
meeting.completed
Susitikimas baigtas apdoroti: jo santrauka, užduotys ir sprendimai paruošti. Siunčiama vieną kartą kiekvienam susitikimui.
Filtrai
| Pavadinimas | Tipas | Aprašymas |
|---|---|---|
scope | viena iš: mine, all_visible | mine: jūsų įrašyti susitikimai. all_visible: visi susitikimai, kuriuos galite atidaryti. Nenurodžius, savininkui ar visus susitikimus matančiam administratoriui taikoma mine, nebent nurodytas groupId; kitais atvejais all_visible. |
classification | viena iš: internal, external, any | internal: visi dalyviai iš jūsų organizacijos. external: dalyvavo kas nors iš išorės. any: visi susitikimai, įskaitant tuos, kurių dalyviai nežinomi; internal ir external jų niekada neatitinka. Numatytoji reikšmė any. |
groupId | string (uuid) | Tik susitikimai, priskirti šiai grupei. Turite priklausyti grupei, nebent matote visus susitikimus; kita grupė atmetama. |
participantEmail | string (email) | Tik susitikimai, kuriuose dalyvavo šis žmogus ar jis atpažintas kaip kalbėtojas. |
participantDomain | string | Tik susitikimai, kuriuose dalyvavo kas nors iš būtent šio el. pašto domeno, pvz., acme.com. |
data laukai:
| Laukas | Tipas | Privalomas |
|---|---|---|
meetingId | string (uuid) | taip |
title | string | taip |
recordedAt | string | taip |
completedAt | string | taip |
durationSeconds | integer arba null | taip |
language | string arba null | taip |
classification | viena iš: internal, external, unknown | taip |
participants | masyvas: objektas | taip |
participants[].name | string | taip |
participants[].email | string arba null | taip |
groups | masyvas: objektas | taip |
groups[].id | string | taip |
groups[].name | string | taip |
url | string (uri) | taip |
summaryExcerpt | string | taip |
counts | objektas | taip |
counts.actionItems | integer | taip |
counts.decisions | integer | taip |
id | string (uuid) | taip |
summary | string | taip |
keyTopics | masyvas: string | taip |
actionItems | masyvas: objektas | taip |
actionItems[].id | string | ne |
actionItems[].text | string | taip |
actionItems[].assignee | string arba null | taip |
actionItems[].completed | boolean | taip |
decisions | masyvas: objektas | taip |
decisions[].id | string (uuid) | taip |
decisions[].statement | string | taip |
decisions[].decidedBy | string arba null | taip |
Sprendimas užfiksuotas
decision.recorded
Po vieną įvykį kiekvienam sprendimui susitikime, kuris ką tik baigtas apdoroti. Siunčiama vieną kartą.
Filtrai
| Pavadinimas | Tipas | Aprašymas |
|---|---|---|
scope | viena iš: mine, all_visible | mine: jūsų įrašyti susitikimai. all_visible: visi susitikimai, kuriuos galite atidaryti. Nenurodžius, savininkui ar visus susitikimus matančiam administratoriui taikoma mine, nebent nurodytas groupId; kitais atvejais all_visible. |
classification | viena iš: internal, external, any | internal: visi dalyviai iš jūsų organizacijos. external: dalyvavo kas nors iš išorės. any: visi susitikimai, įskaitant tuos, kurių dalyviai nežinomi; internal ir external jų niekada neatitinka. Numatytoji reikšmė any. |
groupId | string (uuid) | Tik susitikimai, priskirti šiai grupei. Turite priklausyti grupei, nebent matote visus susitikimus; kita grupė atmetama. |
participantEmail | string (email) | Tik susitikimai, kuriuose dalyvavo šis žmogus ar jis atpažintas kaip kalbėtojas. |
participantDomain | string | Tik susitikimai, kuriuose dalyvavo kas nors iš būtent šio el. pašto domeno, pvz., acme.com. |
data laukai:
| Laukas | Tipas | Privalomas |
|---|---|---|
id | string (uuid) | taip |
statement | string | taip |
context | string arba null | taip |
decidedBy | string arba null | taip |
url | string (uri) | taip |
meeting | objektas | taip |
meeting.id | string (uuid) | taip |
meeting.title | string | taip |
meeting.recordedAt | string | taip |
meeting.completedAt | string | taip |
meeting.url | string (uri) | taip |
Užduotis sukurta
action_item.created
Po vieną įvykį kiekvienai užduočiai ką tik apdoroto susitikimo santraukoje. Siunčiama vieną kartą. Vėliau ranka pridėtos užduotys nesiunčiamos.
Filtrai
| Pavadinimas | Tipas | Aprašymas |
|---|---|---|
scope | viena iš: mine, all_visible | mine: jūsų įrašyti susitikimai. all_visible: visi susitikimai, kuriuos galite atidaryti. Nenurodžius, savininkui ar visus susitikimus matančiam administratoriui taikoma mine, nebent nurodytas groupId; kitais atvejais all_visible. |
classification | viena iš: internal, external, any | internal: visi dalyviai iš jūsų organizacijos. external: dalyvavo kas nors iš išorės. any: visi susitikimai, įskaitant tuos, kurių dalyviai nežinomi; internal ir external jų niekada neatitinka. Numatytoji reikšmė any. |
groupId | string (uuid) | Tik susitikimai, priskirti šiai grupei. Turite priklausyti grupei, nebent matote visus susitikimus; kita grupė atmetama. |
participantEmail | string (email) | Tik susitikimai, kuriuose dalyvavo šis žmogus ar jis atpažintas kaip kalbėtojas. |
participantDomain | string | Tik susitikimai, kuriuose dalyvavo kas nors iš būtent šio el. pašto domeno, pvz., acme.com. |
assignedToMe | boolean | Tik action_item.created: true, jei reikia tik jums priskirtų užduočių. |
data laukai:
| Laukas | Tipas | Privalomas |
|---|---|---|
id | string (uuid) | taip |
text | string | taip |
assignee | string arba null | taip |
completed | boolean | taip |
timestamp | number arba null | taip |
url | string (uri) | taip |
meeting | objektas | taip |
meeting.id | string (uuid) | taip |
meeting.title | string | taip |
meeting.recordedAt | string | taip |
meeting.completedAt | string | taip |
meeting.url | string (uri) | taip |