Query Call Logs by Number

Queries the call history with the specified numbers.

Request URL

POST {base_url}/uc-creport/api/v1/call-logs/by-number/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
numbers Yes Array<String> The list of the other party's numbers to query. You must specify at least 1 and up to 50 numbers in this parameter.
pageNumber Yes Integer The page number to retrieve.
pageSize Yes Integer The number of records to retrieve per page.
sortBy No String

The field to sort by.

Valid value:

  • timestamp: The time 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.
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_By_Number_Item> The list of call logs on the current page.
Call_Log_By_Number_Item
Parameter Type Description
id String The ID of the call log.
uid String The unique ID of the call.
timestamp String The start 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
totalDuration Integer The talk duration of the call (talk time plus hold time), in seconds.
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.
callerNumber String The caller number.
calleeNumber String The callee number.
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

Example

Request example

POST /uc-creport/api/v1/call-logs/by-number/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
{
  "numbers": [
    "5500"
  ],
  "pageNumber": 1,
  "pageSize": 20
}

Response example

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