Skip to main content
GET
/
api
/
open
/
v4
/
liveAvatar
/
session
/
list
Get Session List
curl --request GET \
  --url https://openapi.akool.com/api/open/v4/liveAvatar/session/list \
  --header 'x-api-key: <api-key>'
{
  "code": 1000,
  "msg": "OK",
  "data": {
    "count": 123,
    "result": [
      {
        "_id": "<string>",
        "uid": 123,
        "type": 123,
        "status": 1,
        "stream_type": "<string>",
        "credentials": {
          "agora_uid": 123,
          "agora_app_id": "<string>",
          "agora_channel": "<string>",
          "agora_token": "<string>",
          "livekit_url": "<string>",
          "livekit_token": "<string>",
          "livekit_room_name": "<string>",
          "livekit_server_identity": "<string>",
          "livekit_client_identity": "<string>",
          "trtc_sdk_app_id": 123,
          "trtc_sdk_room_id": "<string>",
          "trtc_sdk_user_id": "<string>",
          "trtc_sdk_user_sig": "<string>"
        }
      }
    ]
  }
}

Authorizations

x-api-key
string
header
required

Your API Key used for request authorization. If both Authorization and x-api-key have values, Authorization will be used first and x-api-key will be discarded.

Query Parameters

page
integer
default:1

Current page number, default is 1

Required range: x >= 1
size
integer
default:100

Number of items per page, default is 100

Required range: x >= 1
status
enum<integer>

Session status filter (1:queueing, 2:processing, 3:completed, 4:failed)

Available options:
1,
2,
3,
4

Response

200 - application/json

List of sessions

code
integer
required

Interface returns business status code (1000: success)

Example:

1000

msg
string
required

Interface returns status information

Example:

"OK"

data
object