Query Call Logs

Queries call logs with pagination and returns the list of call logs that match the search conditions.

Request URL

POST {base_url}/uc-creport/api/v1/call-logs/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.
tabType No String

The scope of call logs to query.

Valid value:

  • personal: Call logs on the Personal tab.
  • queue: Call logs on the Queue tab.
  • all: All call logs.

If not specified, all is used.
processResultStatus No Integer

The process status to filter by. This parameter is valid only when tabType is queue.

Valid value:

  • 0: Do not filter by process status.
  • 1: Pending.
  • 2: Processing.
  • 3: Processed.

If not specified, 0 is used.
status No String

The call status to filter by.

Valid value:

  • all: All calls.
  • incoming: Incoming calls.
  • missed: Missed calls.
  • outgoing: Outgoing calls.
timeFrom No String The start of the time range to query, in Unix timestamp format (microseconds).
timeTo No String The end of the time range to query, in Unix timestamp format (microseconds).
keyword No String The keyword used to search for call logs by name or number.
hasRecording No Boolean

Whether to return only call logs that have recordings.

Valid value:

  • true: Return only call logs that have recordings.
  • false: Return all call logs.
answeredBy No String The extension numbers of the agents who answered the calls, separated by commas. This parameter is valid only when tabType is queue.
sortBy No String

The field to sort by.

Valid value:

  • timestamp: The time of the call.
  • total_duration: The talk duration of the call.

If not specified, timestamp is used.
sortOrder No String

The sort order.

Valid value:

  • desc: Sort in descending order.
  • asc: Sort in ascending order.

If not specified, desc is used.
sorts No Array<Sort_Condition> The sort conditions. This parameter takes precedence over sortBy and sortOrder.
Sort_Condition
Parameter Required Type Description
property No String

The name of the field to sort by.

Valid value:

  • timestamp: The time of the call.
  • total_duration: The talk duration of the call.
direction No String The sort order.

Valid value:

  • asc: Sort in ascending order.
  • desc: Sort in descending order.

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 call logs.
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.
items Array<Call_Log_Item> The list of call logs on the current page.
Call_Log_Item
Parameter Type Description
id String The ID of the call log.
uid String The unique ID of the call.
timestamp String The display time of the call, in Unix timestamp format (microseconds).
callType String

The call type from the system perspective:

  • inbound: An inbound call.
  • outbound: An outbound call.
  • internal: An internal call.
callStatus String

The call status:

  • answered
  • no_answer
  • busy
  • failed
  • abandoned
category String

The call category from the extension user's perspective:

  • incoming: The user received the call.
  • missed: The user missed the call.
  • outgoing: The user made the call.
number String The number of the other party.
name String The display name of the other party.
numberType String

The type of the other party's number:

  • extension: An extension.
  • extension_mobile: An extension user with a bound mobile number.
  • external: An external number.
  • personal_contact: A personal contact.
  • company_contact: A company contact.
companyName String The company name of the other party. This parameter is returned only for contacts.
avatar String The avatar URL of the other party. This parameter is returned only for extensions.
presence String The presence status of the other party. This parameter is returned only for extensions.
totalDuration Integer The talk duration of the call (talk time plus hold time), in seconds.
hasRecording Boolean

Whether the call has a recording.

  • true: The call has a recording.
  • false: The call has no recording.
recordingDuration Integer The duration of the recording, in seconds. The value is 0 when there is no recording.
recordingStartTime String The start time of the recording, in Unix timestamp format (microseconds). The value is 0 when there is no recording.
sourceFeature String

The feature that the call came from:

  • queue: A queue.
  • ring_group: A ring group.

An empty string indicates that the call did not come from a queue or ring group.
sourceNumber String The number of the source feature.
sourceName String The display name of the source feature.
answeredByNumber String The extension number of the agent who answered the call. This parameter is returned only on the Queue tab.
answeredByName String The name of the agent who answered the call. This parameter is returned only on the Queue tab.
processStatus Integer

The process status of the call log:

  • 0: Not applicable.
  • 1: Pending.
  • 2: Processing.
  • 3: Processed.
processBy String The number or name of the user who processed the call log.
processByName String The name of the user who processed the call log.
processAt String The time when the call log was processed, in Unix timestamp format (microseconds).
hasAiTranscription Boolean

Whether the call has an AI transcription.

  • true: The call has an AI transcription.
  • false: The call has no AI transcription.
recordingTranscriptionStatus String

The status of the recording transcription task:

  • NOT_SUBMITTED
  • PENDING
  • PROCESSING
  • COMPLETED
  • FAILED
deleteScope String

The delete scope of the call log:

  • personal: The call log is hidden only for the current user after deletion.
  • global: The call log is hidden globally after deletion.
phoneLabel String

The label of the other party's number. This parameter is returned only for contacts.

  • extension
  • mobile_phone
  • business_phone
  • home_phone
  • business_fax
  • home_fax
  • mobile2_phone
  • business2_phone
  • home2_phone
  • other_phone
online Boolean

Whether the other party is online.

  • true: The other party is online or has a registered phone.
  • false: The other party is offline.

This parameter is returned only for extensions.
extensionNumber String The extension number that the mobile number is bound to. This parameter is returned only when numberType is extension_mobile.

Example

Request example

POST /uc-creport/api/v1/call-logs/search-page HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJ5dXhmQHllYXN0YXIuY29tIiwiYXBwX2tleSI6Imd1akF1cGx2Z3hzaUZwNTFxQjFCc0VoQThJYm90cnppIiwiZ3JhbnRfdHlwZSI6Im9wZW5hcGkiLCJjbGllbnRfZXh0Ijp7ImRlc2NyaXB0aW9uIjoi56ys5LiJ5pa55ZCI5L2c5LyZ5Ly05bqU55SoIiwicGFydG5lciI6IuekuuS-i-WQiOS9nOS8meS8tCJ9LCJjbGllbnRfdHlwZSI6Im9wZW5hcGkiLCJleHAiOjE3OTMzNDgzMDgsImlhdCI6MTc5MzMyNjcwOCwianRpIjoiYzNiMzY2ZjUtYzFlZi00MTg3LWFhOWUtOTdmZTVlYjIxNjc4IiwiY2xpZW50X2lkIjoibm92by1vcGVuLXBsYXRmb3JtIiwidXNlcl9leHQiOnsicm9sZUlkcyI6WzNdLCJzdHlwZSI6IkFETUlOIiwidGVuYW50Q29kZSI6bnVsbCwidHlwZSI6IlBfQUNDT1VOVCIsInVzZXJJZCI6MzQyMzMzNTk1NTk1Mjk2MzU4NCwiZW1haWwiOiJ5dXhmQHllYXN0YXIuY29tIiwidXNlcm5hbWUiOiJ5dXhmQHllYXN0YXIuY29tIiwidWNJZCI6MzQyMzMzNTk1NTkzNjE4NjM2OH19.PXOLRPDJMFsIV47z01YdXjmgBlNwFntnpy3G-MxKsXLW3r5yaJUyIvuTfp1BjR5564Avhw6XfSwPmV2nt2myH-OkZq4rLrfm_3VpFX0iZwkOUK2CXQ1UJIrDfP0GS2301JKAzHE65FlEFVAnWWe1m_KqTwSLJ4X24IXIl84DdnOFA5dhlgMUFe1Fa8ku2Tsy5zfZedB6xhgnLaJsS7tKyTRESXuFSYqA2oz_iieDSzqqiW1b6Kwvj6tcX5mbDmovnmqKh-ui8k-mgtfO5yHAoC1V0-Br1VVXMCtGI3NfxWNP7VBahyIzQ-o1X6ZySOkXafw_NKsl0gWqEevMf7uuGg
x-tenant-code: yxf819.com
Content-Type: application/json
{
  "tabType": "all",
  "status": "missed",
  "pageNumber": 1,
  "pageSize": 20
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "298f694eb8feb7af65d1fed9ed607b0e",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "pageSize": 20,
    "pageNumber": 1,
    "count": 0,
    "items": []
  }
}