getRecordTransferResultDetail(params: Object)

Requires:
WearKit≥1.0.0@ray-js/ray≥1.7.14
Platforms:
iOSAndroid
import { wear } from '@ray-js/ray';

const { getRecordTransferResultDetail } = wear;

// Promise usage
try {
  const res = await getRecordTransferResultDetail({ ...params });
  console.log(res);
} catch (err) {
  console.log(err.errorMsg);
}

Description

Get recording transcription result detail.

Parameters

PropertyTypeRequiredDescriptionWearKit Since
recordIdstringNoRecording transcription IDv1.6.7
amplitudeMaxCountstringNoMaximum amplitude count-
complete() => voidNoCompletion callback (executed on both success and failure)-
success(params: Object) => voidNoCallback on successful API call-
fail(params: Object) => voidNoFailure callback-
success callback parameters
PropertyTypeDescriptionWearKit Since
recordTransferIdnumberRecording transcription ID (actually fileId)-
directoryIdnumberDirectory ID-
deviceUniqueIdstringUnique identifier of the recording file generated by the device-
namestringFile name-
recordTimenumberRecording time (timestamp, seconds)-
durationnumberRecording duration (milliseconds)-
recordTypenumberAudio type 0-Call 1-Meeting 2-Face-to-face translation (Basic) 3-Face-to-face translation (Pro)-
audioFormatnumberAudio format-
deviceIdstringDevice ID-
filePathstringRecording file path-
wavFilePathstringRecording WAV file path-
amplitudesstringAmplitude string, separated by commas-
statusnumberFile sync status: 0 not uploaded, 1 uploading, 2 uploaded, 3 upload failed-
visitnumberRead status: 0 unread, 1 read, 2 revised-unread, 3 revised-read-
removebooleanWhether removed (moved to trash)-
storageKeystringCloud storage key-
transfernumberTranscription status: 0 not transcribed, 1 transcribing, 2 transcribed, 3 transcription failed-
summarynumber* Summary status: 0 not summarized, 1 summarizing, 2 summary succeeded, 3 summary failed; if omitted, all statuses will be queriedv1.2.2
translateStatenumber* Translation status: 0 unknown, 1 not translated, 2 translating, 3 translation succeeded, 4 translation failedv1.4.0
sourcenumberAudio file source: 0 app, 1 device-
transferTypenumberTranscription mode: 0 file transcription, 1 real-time transcription-
needTranslatebooleanWhether translation is needed-
originalLanguagestringSource language-
targetLanguagestringTarget language-
recordIdstringReal-time transcription record ID-
agentIdstringReal-time transcription agent ID-
cloudTranscriptionbooleanWhether secondary transcription has been performedv1.2.2
transcriptionStatusnumber0: not transcribed, 1: partially transcribed, 2: fully transcribed (legacy data)v1.6.0
cloudSyncStatusnumberUI-only status 0 Show no sync status 5 Audio uploading 10 Audio upload succeeded 15 Audio downloading 20 Audio download succeeded -10 Audio upload failed -20 Audio download failedv1.6.10
isFromCloudbooleanWhether from cloud syncv1.6.10
noteFileConvertStatenumbernote file conversion status 2: conversion failed 1: converting 0: conversion succeeded/not requiredv1.9.1
linkSharednumberLink sharing status: 0 not shared, 1 sharedv1.9.1
transcriptEditednumberWhether the transcription has been edited: 0 = not edited, 1 = editedv3.3.0
summaryEditednumberWhether the summary has been edited: 0 = not edited, 1 = editedv3.3.0
offlineUploadProgressnumberOffline file upload progress, default 0, range 0–100v1.9.1
offlineUploadStatusnumberOffline file upload status: -1 not uploaded, 0 pending, 1 uploading, 2 succeeded, 3 failed, 4 canceledv1.9.1
tagsstring[]Tag list, e.g., ["Client visit","Class A client"]v2.1.0
summaryImageStatusnumberImage summary status: 0 not generated, 1 generating, 2 generated successfully, 3 generation failedv3.0.0
folderIdstringFolder IDv3.3.2
recycleExpireAtnumberRecycle Bin expiration time (Unix seconds); 0 means not in the Recycle Bin. When querying folderIds=['RECYCLE_BIN'], results are returned in descending order by this field. Days remaining = ceil((recycleExpireAt - current timestamp (seconds)) / 86400)v3.4.0
fail callback parameters
PropertyTypeDescription
errorMsgstringError message
errorCodestring | numberError code
Error extension

Return Value

None

Error Code

Error CodeError Message
10001Internal error
10012Record not found

Examples

Basic usage

import { wear } from '@ray-js/ray'

wear.getRecordTransferResultDetail({
  recordId: 'rec1',
  success: (result) => {
    console.log('getRecordTransferResultDetail success', result);
  },
  fail: error => {
    console.error(error);
  },
});