Trigger a Voicemail Transcription

Trigger transcription of a voicemail for the current user in NovoOne Client.

Request URL

POST {base_url}/uc-creport/api/v1/my-voicemails/{id}/transcription

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Path parameters
Parameter Required Type Description
id Yes String The ID of the voicemail to transcribe.
Note: You can obtain the ID using the Search Voicemails interface.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<Transcription_Result> The transcription result.
Transcription_Result
Parameter Type Description
transcriptionStatus String

The status of the voicemail transcription.

  • none: The voicemail has not been transcribed.
  • processing: The transcription is in progress.
  • done: The transcription is complete.
  • failed: The transcription failed.
transcriptionText String The transcribed text of the voicemail.

Example

Request example

POST /uc-creport/api/v1/my-voicemails/346238892361568256/transcription HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiIxMDAwQGNvbG9ydGVzdDIiLCJncmFudF90eXBlIjoicGFzc3dvcmQiLCJ1c2VyX25hbWUiOiIxMDAwQGNvbG9ydGVzdDIiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiY2xpZW50X2V4dCI6eyJkZXNjcmlwdGlvbiI6IueuoeeQhuWQjuWPsFdlYuW6lOeUqCIsInBsYXRmb3JtIjoid2ViIn0sImV4cCI6MTc5MjA4NzA5NywiaWF0IjoxNzkyMDY1NDk3LCJqdGkiOiI3ZDQyMWM2MS0yMjU1LTQzMWUtOWM3MC03NGNkNGE4Nzk1MDMiLCJjbGllbnRfaWQiOiJub3ZvLWFkbWluLXdlYiIsInNpZCI6ImExNGE3N2YwLTRhODgtNDFjMi1hZmZjLTAzMTUyZDE3ZGY0MiIsInVzZXJfZXh0Ijp7InJvbGVJZHMiOlsxMDJdLCJwdWlkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJ0ZW5hbnRJZCI6MjA3OTUwNDIwNTMwOTE5NDI0MSwicGFyZW50VWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5NiwidGVuYW50Q29kZSI6ImNvbG9ydGVzdDIiLCJ0eXBlIjoiVF9VU0VSIiwidXNlcklkIjoyMDc5NzQ2OTE1Mzg4MDc2MDMzLCJlbWFpbCI6Imxlb0BzYW1wbGUuY29tIiwidXNlcm5hbWUiOiIxMDAwQGNvbG9ydGVzdDIiLCJ1Y0lkIjozMDc2OTEzNjQ0ODkwODMyODk2fX0.1J20i63M_KtVNmhoH027H9bYjtwpVTvvj5vQ1-7u3MGxlJDi04GzR2uY4qy6BkaeyBB5HTI92l494JOTiJ0QSOrUu6Vax1LHQMIjSmCWWu5cf0UeOYZu76nqIFp5OXPhFMM3gp87AdF4e4q2y9YSRJvokXTwKLxYrQB3GIEbwDTy_blMhhIhu1dDAty4OceJgEcilycj3pfpLICxq5sPFniShFnGfP5umIPccv_JIN3jVfWJO8EI18XkEkUIvrl3Q2BXJ7pGfUXoAzt2xoTeVbKrCfQTQohdnAW3U6UGfq54DSQ7-SBckKaz5D9uQSEdYDPi5clWC6gDgnpSWV8m9A
x-tenant-code: jint
Content-Type: application/json

Response example

HTTP/1.1 200 OK
{
  "requestId": "07722404afe831924ecde4ea3279b6d4",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "transcriptionStatus": "done",
    "transcriptionText": ""
  }
}