Puslapiavimas ir klaidos
Kaip sąrašų galiniai taškai grąžina rezultatus puslapiais ir kokius klaidų kodus grąžina API.
Sąrašų galiniai taškai grąžina po vieną puslapį ir nurodo, ar yra daugiau. Visos klaidos turi tą
patį apvalkalą su code, pagal kurį jūsų kodas gali nuspręsti, ką daryti.
Puslapiavimas
| Galinis taškas | Parametrai | Kaip sužinoti, ar yra daugiau |
|---|---|---|
GET /decisions, GET /action-items | limit (nuo 1 iki 100, numatytoji 25), offset (iki 1 000) | hasMore |
GET /search | limit (nuo 1 iki 100, numatytoji 20), offset (iki 118) | hasMore |
GET /groups | limit (nuo 1 iki 100), offset, abu neprivalomi | hasMore, tik kai nurodote limit arba offset |
GET /meetings | page (nuo 1), limit (nuo 1 iki 100, numatytoji 20) | hasMore ir totalCount |
GET /meetings/{id}/transcript | startSeconds (numatytoji 0) | nextStartSeconds, pabaigoje null |
Kitam puslapiui pridėkite limit prie offset (arba 1 prie page) ir kvieskite vėl, kol hasMore
bus false. Transkripcijai perduokite nextStartSeconds kaip startSeconds, kol jis taps null.
GET /decisions ir GET /action-items nepuslapiuoja toliau nei offset 1 000. Senesniems įrašams
siaurinkite užklausą su since arba meetingId. GET /action-items taip pat atsako
truncated: true, kai sustojo neperskaitęs visų susitikimų; likusioms užduotims siaurinkite taip pat.
Klaidos
Kiekviena klaida atrodo taip:
{ "success": false, "error": { "type": "error", "code": "not_found", "message": "Meeting not found" } }
Parametras ar turinys, nepraėjęs patikrinimo, grąžina 400, kurio type yra validation, o
pranešimai pateikiami pagal laukus:
{ "success": false, "error": { "type": "validation", "errors": { "limit": ["…"] } } }
| Būsena | code | Reikšmė |
|---|---|---|
| 400 | (validation) | Netinkamas parametras ar turinys. errors išvardija kiekvieną lauką. |
| 401 | invalid_api_key | Raktas neteisingas, atšauktas ar nebegalioja. Žr. Autentifikacija. |
| 401 | unauthorized | Nėra Authorization antraštės arba bearer žetonas nėra API raktas. |
| 403 | api_keys_disabled | Jūsų organizacijoje API raktai išjungti. |
| 403 | api_key_not_allowed | Šis galinis taškas API raktų nepriima. |
| 403 | api_key_required | Šis galinis taškas priima tik API raktą (/hooks galiniai taškai). |
| 403 | email_not_verified, org_suspended | Jūsų paskyra ar organizacija šiuo metu negali naudoti API. |
| 403 | unauthorized | Susitikimą atidaryti galite, bet šio veiksmo atlikti negalite, pvz., eksportuoti susitikimo, kuris su jumis bendrintas tik peržiūrai. |
| 404 | not_found, access_denied | Įrašo nėra arba rakto savininkas negali jo atidaryti. Abu atvejai atrodo vienodai tyčia. |
| 404 | no_transcript | Susitikimas neturi transkripcijos: jos dalys arba srt eksportas. |
| 409 | subscription_stopped | Ši automatizacija sustabdyta VoiceCap ir iš čia jos vėl įjungti negalima. |
| 422 | unknown_event | Įvykio tokiu pavadinimu nėra. |
| 422 | invalid_target_url | Webhook adresas nėra viešas https adresas. Pranešime nurodyta, kas negerai. |
| 422 | callback_verification_failed | Jūsų galinis taškas neatsakė į bandomąją užklausą. |
| 422 | subscription_limit | Pasiektas webhook prenumeratų limitas. Pašalinkite nebereikalingą prenumeratą. |
| 429 | rate_limited | Per daug užklausų. Žr. Užklausų limitai. |
422, kurio type yra validation, reiškia, kad netinkamas webhook filtras. Jo errors raktai
prasideda filters., pvz., filters.groupId.