Call records

List call logs

GET/openapi/calllog

Request

Parameters

taskIdinteger

Query parameter · Format: 1,2 — separate multiple task IDs with commas, up to 10

startTimestring

Query parameter · Format: 2006-01-02 15:04:05; defaults to the start of today

endTimestring

Query parameter · Format: 2006-01-02 15:04:05; defaults to the end of today

directionstring

Query parameter · inbound for incoming calls, outbound for outgoing calls

phonestring

Query parameter · Caller or callee phone number

pageIndexinteger

Query parameter · Page number, defaults to 1

pageSizeinteger

Query parameter · Items per page, defaults to 10, max 100

assistantIdsarray

Query parameter · Assistant ID

descriptionstring

Query parameter · Filter by call type: phone = phone call, privateTest = debug call

Request body

No fields

Response

200 OK
itemsobject[]required
[].sessionIdstring
[].taskIdinteger
[].startAtstring
[].answerAtstring
[].endAtstring
[].calleestring
[].callerstring
[].directionstring
[].durationinteger
[].billsecinteger
[].recordFilestring
[].assistantobject[]required
[].idintegerrequired

Assistant ID

[].vidintegerrequired

Assistant version ID

totalintegerrequired
pageIndexintegerrequired
pageSizeintegerrequired

Sample code

curl -X GET 'https://openapi.voicefox.ai/openapi/calllog?taskId=0&startTime=string&endTime=string&direction=string&phone=string&pageIndex=0&pageSize=0&assistantIds=0&description=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN>' \
  -H 'Content-Type: application/json'

Response example

{
  "items": [
    {
      "sessionId": "string",
      "taskId": 0,
      "startAt": "string",
      "answerAt": "string",
      "endAt": "string",
      "callee": "string",
      "caller": "string",
      "direction": "string",
      "duration": 0,
      "billsec": 0,
      "recordFile": "string",
      "assistant": [
        {
          "id": 0,
          "vid": 0
        }
      ]
    }
  ],
  "total": 0,
  "pageIndex": 0,
  "pageSize": 0
}