대화 사용자 가져오기

GET

/v1/convai/users

GET

/v1/convai/users

curl -G https://api.elevenlabs.io/v1/convai/users \
     -d agent_id=agent_id \
     -d branch_id=branch_id \
     -d call_start_after_unix=1 \
     -d call_start_before_unix=1 \
     -d cursor=cursor \
     -d page_size=1 \
     -d search=search \
     -d sort_by=last_contact_unix_secs \
     -d sort_direction=asc

{
  "users": [
    {
      "user_id": "user_id",
      "last_contact_unix_secs": 1,
      "first_contact_unix_secs": 1,
      "conversation_count": 1,
      "last_contact_conversation_id": "last_contact_conversation_id",
      "sentiment": {
        "scored_conversation_count": 1,
        "positive_count": 1,
        "neutral_count": 1,
        "negative_count": 1,
        "recent_scored_conversation_count": 1,
        "recent_positive_count": 1,
        "recent_neutral_count": 1,
        "recent_negative_count": 1,
        "average_sentiment_score": null,
        "average_frustration_score": null,
        "recent_average_sentiment_score": null,
        "recent_average_frustration_score": null
      },
      "last_contact_agent_id": "last_contact_agent_id",
      "last_contact_agent_name": "last_contact_agent_name",
      "most_frustrated_conversations": [
        {
          "conversation_id": "conversation_id",
          "agent_id": "agent_id",
          "start_time_unix_secs": 1,
          "overall_label": "positive",
          "overall_sentiment_score": 1.1,
          "overall_frustration_score": 1.1
        }
      ]
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}

페이지네이션을 적용하여 대화의 고유 사용자를 가져옵니다.

쿼리 매개변수

agent_idstring선택 사항

동일한 기본 리소스로 확인되는 에이전트 ID(agent_…) 또는 음성 엔진 외부 ID(seng_)입니다.

branch_idstring선택 사항

브랜치 ID로 대화를 필터링합니다.

call_start_before_unixinteger선택 사항

이 시작일까지의 대화를 필터링하는 Unix 타임스탬프(초)입니다.

call_start_after_unixinteger선택 사항

이 시작일 이후의 대화를 필터링하는 Unix 타임스탬프(초)입니다.

searchstring선택 사항

사용자 ID로 검색/필터링합니다(정확히 일치).

page_sizeinteger선택 사항1-100기본값 30

반환할 최대 사용자 수입니다. 기본값은 30입니다.

sort_byenum선택 사항

결과를 정렬할 필드입니다. 기본값은 last_contact_unix_secs입니다.

허용된 값:

sort_directionenum선택 사항

결과 정렬 방향

허용된 값:

cursorstring선택 사항

다음 페이지를 가져오는 데 사용됩니다. 응답에서 커서가 반환됩니다.

응답

성공 응답

userslist of objects

has_moreboolean

next_cursorstring선택 사항

오류

422

Users List Request Unprocessable Entity Error

헤더

쿼리 매개변수

응답

오류