Search Voicemails

Search the voicemails of the current user in NovoOne Client.

Request URL

POST {base_url}/uc-creport/api/v1/my-voicemails/search-page

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.
Body parameters
Parameter Required Type Description
pageNumber Yes Integer The page number to retrieve.
pageSize Yes Integer The number of records to retrieve per page.
readStatus No String

The read status of the voicemails to search for.

Valid value:

  • unread: Search only unread voicemails.
  • read: Search only read voicemails.
  • all: Search all voicemails.
keyword No String The keyword used for fuzzy matching against caller number and caller name, or for full-text matching against voicemail transcription text.

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<Search_Result> The search result of voicemails.
Search_Result
Parameter Type Description
pageSize Integer The number of records per page.
pageNumber Integer The current page number.
count String The total number of matching records.
limit Integer The maximum number of voicemails that can be stored in the current user's voicemail box.
unreadCount Integer The total number of unread voicemails for the current user.
results Array<Voicemail> The list of voicemails matching the search conditions.
transcriptionAllowed Boolean Whether the current user has permission to transcribe voicemails.
Voicemail
Parameter Type Description
id String The ID of the voicemail.
caller Object<Party_Info> The information about the caller who left the voicemail.
duration Integer The duration of the voicemail, in seconds.
readAt String The time when the voicemail was marked as read, in Unix timestamp format (microseconds).
Note: A value of 0 indicates that the voicemail is unread.
startTime String The time when the voicemail started, in Unix timestamp format (microseconds).
forwardedFrom Object<Party_Info> The information about the source from which the voicemail was forwarded.
Note: An empty value indicates that the voicemail is received directly.
downloadable Boolean Whether the voicemail file can be downloaded.
  • true: The voicemail file can be downloaded.
  • false: The voicemail file exceeds 600 MB and cannot be downloaded.
fileSize String The size of the voicemail file, in bytes.
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 transcription text of the voicemail.
Party_Info
Parameter Type Description
number String The caller number.
name String The caller name.
avatar String The URL of the caller avatar.
type String

The type of identity associated with the phone number.

  • extension: The number belongs to a user in the current tenant.
  • extension_mobile: The number is a mobile number configured for a user in the current tenant.
  • personal_contact: The number matches a personal contact.
  • company_contact: The number matches a company contact.
  • external: The number does not match any internal identity.
presence String The presence status.
Note: This parameter is returned with a value only when type is extension or extension_mobile.
online Boolean The online status.
Note: This parameter is returned with a value only when type is extension or extension_mobile.
  • true: The extension is registered.
  • false: The extension is unregistered.
companyName String The company name associated with the contact.
Note: This parameter is returned with a value only when type is company_contact.
extensionNumber String The extension number associated with the mobile number.
Note: This parameter is returned with a value only when type is extension_mobile.

Example

Request example

POST /uc-creport/api/v1/my-voicemails/search-page 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
{
  "pageNumber": 1,
  "pageSize": 10,
  "readStatus": "unread"
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "d4b01972c82909cdeb15fc430f89545c",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "pageSize": 10,
    "pageNumber": 1,
    "count": 3,
    "limit": 100,
    "unreadCount": 3,
    "results": [
      {
        "id": "345015162422976512",
        "caller": {
          "number": "1001",
          "name": "Terrell Smith",
          "avatar": "https://novo-one-tst-self-operated-business.s3.ap-east-1.amazonaws.com/public/platform/jint/user_avatar/1786586587824/2.png",
          "type": "extension",
          "presence": "AVAILABLE",
          "online": false,
          "companyName": "",
          "extensionNumber": ""
        },
        "duration": 8,
        "readAt": "0",
        "startTime": "1786325223338567",
        "forwardedFrom": null,
        "downloadable": true,
        "fileSize": "135286",
        "transcriptionStatus": "none",
        "transcriptionText": ""
      }
    ],
    "transcriptionAllowed": true
  }
}