Pular para o conteúdo principal

Gravações

GET​

  • /organizations/:organizationId/records
  • /organizations/:organizationId/records/:recordId

Retorna as gravações da organização de id passado na url de acordo com os parâmetros da requisição.

Authorization​

  • Authorization: Bearer <session_token>

Parâmetros​

  • callDestA (Opcional): Número de destino (Leg A).
  • callDestB (Opcional): Número de destino (Leg B).
  • callId (Opcional): ID da chamada.
  • callOrigA (Opcional): Número de origem (Leg A).
  • callOrigB (Opcional): Número de origem (Leg B).
  • customId (Opcional): ID customizado.
  • fromTime (Opcional): Data limite inferior (Formato ISO ou UNIX milissegundos).
  • labels (Opcional): Labels da chamada.
  • napDest (Opcional): Nap de destino.
  • napOrig (Opcional): Nap de origem.
  • optFields (Opcional): Campos adicionais para retornar (transcriptions)
  • order (Opcional): Tipo de ordenação (asc, desc).
  • orderBy (Opcional): Ordenar por (callTimestamp, fileSize, recordDuration).
  • page (Opcional): Página (default = 0).
  • perPage (Opcional): Número de gravações por páginas (default = 25).
  • toTime (Opcional): Data limite superior (Formato ISO ou UNIX milissegundos).
  • transcription (Opcional): Transcrição da chamada.

Os parâmetros de filtragem são enviados na query string.

Caso id não seja passado na url, todas as gravações serão retornadas.

Resultado​

O resultado de uma requisição bem sucedida será um 200 Ok com o seguinte formato:

{
  /** Indica se essa é a última página com gravações */
  done: boolean;

  /** Número da página retornada */
  page: number;

  /** Lista de gravações dessa página */
  records: Array<{
    callDestA: string;
    callDestB: string;
    callId: string;
    callOrigA: string;
    callOrigB: string;
    callRetry: number;
    callTimestamp: Date;
    customId: string;
    device: string;
    fileSize: number;
    id: number;
    napDest: string;
    napOrig: string;
    recordDuration: number;
    storageStatus:
      | "STANDARD"
      | "INFREQUENT"
      | "ARCHIVE"
      | "RESTORING"
      | "RESTORED"
      | "DELETED";
  }>;
}

PATCH​

  • /organizations/:organizationId/records/:recordId

Atualiza os dados das gravações.

Authorization​

  • Authorization: Bearer <session_token>

Parâmetros​

  • labels (Opcional): Labels da chamada.
  • restore (Opcional): Restaurar uma chamada da camada ARCHIVE.

Os parâmetros do body da requisição tem o seguinte formato:

{
 "labels": Array<["label", "valor"]>
 "restore": boolean;
}

Resultado​

O resultado para uma requisição bem sucedida será um 204 No Content com body vazio.