Naršyti dokumentaciją
Dokumentacija

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škasParametraiKaip sužinoti, ar yra daugiau
GET /decisions, GET /action-itemslimit (nuo 1 iki 100, numatytoji 25), offset (iki 1 000)hasMore
GET /searchlimit (nuo 1 iki 100, numatytoji 20), offset (iki 118)hasMore
GET /groupslimit (nuo 1 iki 100), offset, abu neprivalomihasMore, tik kai nurodote limit arba offset
GET /meetingspage (nuo 1), limit (nuo 1 iki 100, numatytoji 20)hasMore ir totalCount
GET /meetings/{id}/transcriptstartSeconds (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ūsenacodeReikšmė
400(validation)Netinkamas parametras ar turinys. errors išvardija kiekvieną lauką.
401invalid_api_keyRaktas neteisingas, atšauktas ar nebegalioja. Žr. Autentifikacija.
401unauthorizedNėra Authorization antraštės arba bearer žetonas nėra API raktas.
403api_keys_disabledJūsų organizacijoje API raktai išjungti.
403api_key_not_allowedŠis galinis taškas API raktų nepriima.
403api_key_requiredŠis galinis taškas priima tik API raktą (/hooks galiniai taškai).
403email_not_verified, org_suspendedJūsų paskyra ar organizacija šiuo metu negali naudoti API.
403unauthorizedSusitikimą atidaryti galite, bet šio veiksmo atlikti negalite, pvz., eksportuoti susitikimo, kuris su jumis bendrintas tik peržiūrai.
404not_found, access_deniedĮrašo nėra arba rakto savininkas negali jo atidaryti. Abu atvejai atrodo vienodai tyčia.
404no_transcriptSusitikimas neturi transkripcijos: jos dalys arba srt eksportas.
409subscription_stoppedŠi automatizacija sustabdyta VoiceCap ir iš čia jos vėl įjungti negalima.
422unknown_eventĮvykio tokiu pavadinimu nėra.
422invalid_target_urlWebhook adresas nėra viešas https adresas. Pranešime nurodyta, kas negerai.
422callback_verification_failedJūsų galinis taškas neatsakė į bandomąją užklausą.
422subscription_limitPasiektas webhook prenumeratų limitas. Pašalinkite nebereikalingą prenumeratą.
429rate_limitedPer 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.

Susiję puslapiai