Pular para o conteúdo principal

Obter transcrição

Para obter uma transcrição via chamada de API é necessário ter os ids da organização e da gravação na qual se pretende obter a transcrição, conforme apresentado na documentação da transcrição. Hoje somente é possível autenticar-se via API usando o token de sessão do usuário, portanto caso deseje obter a transcrição de uma gravação é necessário seguir os seguintes passos para obter os ids necessários e o token da sessão do usuário:

Obtendo o token da sessão do usuário​

  • Autenticar a sessão do usuário pela rota de login
curl --request POST \
  --url 'https://cloud.rec.khomp.com/api/login' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "EMAIL",
    "password": "PASSWORD"
  }'

Obs: Substituir email e password por credenciais válidas.

  • Pegar o valor do token retornado no resultado da requisição de login
{
  "creationTime": "2023-11-16T15:33:53.938Z",
  "organizationId": 1,
  "token": "4eb4ffb7-20e4-4aa2-99c7-94729989edc2",
  "userId": 1,
  "username": "khomp"
}

Para permitir o acesso à API, o token obtido deve ser usado para autenticar as requisições do usuário. Isso é feito enviando o token no cabeçalho Authorization da requisição usando o schema Bearer:

curl --header 'Authorization: Bearer <session-token>' ...

# Por exemplo, usando o token visto acima
curl --header 'Authorization: Bearer 4eb4ffb7-20e4-4aa2-99c7-94729989edc2' ...

Obtendo o Id da organização​

curl --request GET \
  --url 'https://cloud.rec.khomp.com/api/organizations' \
  --header 'Authorization: Bearer <session-token>'

Também é possível enviar parâmetros para filtrar as organizações pelo nome

curl --request GET \
  --url 'https://cloud.rec.khomp.com/api/organizations?name=ORGANIZATION_NAME' \
  --header 'Authorization: Bearer <session-token>'

O resultado da requisição pode ser encontrado na documentação.

Obtendo o Id da gravação​

curl --request GET \
  --url 'https://cloud.rec.khomp.com/api/organizations/:organizationId/records' \
  --header 'Authorization: Bearer <session-token>'

Também é possível enviar alguns parâmetros para filtrar as gravações.

Exemplo usando callId:

curl --request GET \
  --url 'https://cloud.rec.khomp.com/api/organizations/:organizationId/records?callId=CALL_ID' \
  --header 'Authorization: Bearer <session-token>'

Obs: Necessário substituir :organizationId pelo id da organização na qual pretende-se obter as gravações, para encontrar o id da organização basta seguir o passo Obtendo o Id da organização

O resultado da requisição pode ser encontrado na documentação.

Obtendo a transcrição​

Usando os valores :organizationId (ID da organização) e :recordId (ID da gravação) obtidos nas etapas anteriores, basta fazer uma requisição para a rota de transcrição conforme a documentação e o exemplo a seguir:

curl --request GET \
  --url 'https://cloud.rec.khomp.com/api/organizations/:organizationId/records/:recordId/transcription' \
  --header 'Authorization: Bearer <session-token>' \
  --header 'Content-Type: application/json'

Obs: Necessário substituir :organizationId e :recordId.

O resultado da requisição vai seguir o formato descrito na documentação.