Hoppa till innehåll

Autentisering

Varje förfrågan till API:et för Record Meeting kräver en API-nyckel. Du skapar nycklar i appen under Inställningar ➤ API-nycklar.

Fliken API-nycklar i Inställningar med knappen Skapa nyckel

https://api.recordmeeting.com/v1

Sökvägarna för slutpunkter i den här referensen skrivs med prefixet /v1, till exempel GET /v1/recordings. Lägg till dem efter https://api.recordmeeting.com.

Skicka din API-nyckel i headern Authorization. Nycklar börjar med sk_rm_.

Authorization: Bearer sk_rm_your_key

Information om hur du skapar en nyckel finns i Användarhandbok ➤ API-nycklar. En nyckel har samma åtkomst som ditt konto: dina egna inspelningar och de organisationsinspelningar som du har behörighet att se.

Terminal window
curl "https://api.recordmeeting.com/v1/recordings" \
-H "Authorization: Bearer sk_rm_your_key"

Lyckade svar är JSON med resultatet under data. Slutpunkter som returnerar listor och paginerar resultaten lägger till ett pagination-objekt. Vissa svar innehåller även "success": true.

PATCH- och DELETE-förfrågningar svarar med 204 No Content och en tom svarskropp när de lyckas.

Alla fel har det här formatet:

{
"error": {
"code": "ERROR_CODE",
"message": "Human readable description"
}
}

En förfrågan utan giltig Authorization-header får 401.

KodHTTP-statusBetydelse
INVALID_API_KEY401Nyckeln finns inte eller har återkallats
API_KEY_EXPIRED401Nyckeln har gått ut
USER_NOT_FOUND401Kontot som nyckeln tillhör finns inte längre
AUTH_ERROR401Autentiseringen misslyckades
KodHTTP-statusBetydelse
VALIDATION_ERROR400Ogiltiga eller saknade förfrågningsparametrar
RECORDING_NOT_READY400Inspelningen kan inte delas ännu
ORGANIZATION_SUBSCRIPTION_EXPIRED402Organisationen som äger inspelningen har inte längre en aktiv Enterprise-prenumeration
FORBIDDEN403Du är inte medlem i organisationen, eller får inte se det du bad om
RECORDING_LOCKED403Inspelningen är låst. Uppgradera för att öppna den
SUBSCRIPTION_REQUIRED403Åtgärden kräver en betald plan
TRANSCRIPT_NOT_AVAILABLE403Transkription är inaktiverad för organisationen eller medlemmen
SHARING_DISABLED403Delning är inaktiverad för organisationen eller medlemmen
RECORDING_NOT_FOUND404Inspelningen finns inte eller så har du inte åtkomst till den
INTERNAL_ERROR500Fel på serversidan