Conversatiegebruikers ophalen

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"
}

Haal afzonderlijke gebruikers uit gesprekken op met paginering.

Query parameters

agent_idstringOptional

Agent-ID (agent_…) of externe ID van de spraakengine (seng_), die naar dezelfde onderliggende resource verwijzen.

branch_idstringOptional

Filter gesprekken op branch-ID.

call_start_before_unixintegerOptional

Unix-timestamp (in seconden) om gesprekken tot deze startdatum te filteren.

call_start_after_unixintegerOptional

Unix-timestamp (in seconden) om gesprekken vanaf deze startdatum te filteren.

searchstringOptional

Zoeken/filteren op gebruikers-ID (exacte overeenkomst).

page_sizeintegerOptional1-100Defaults to 30

Het maximale aantal gebruikers dat moet worden geretourneerd. Standaard is 30.

sort_byenumOptional

Het veld waarop de resultaten worden gesorteerd. De standaardwaarde is last_contact_unix_secs.

Allowed values:

sort_directionenumOptional

De richting waarin je de resultaten sorteert

Allowed values:

cursorstringOptional

Gebruikt om de volgende pagina op te halen. De cursor wordt teruggegeven in de response.

Response

Geslaagde response

userslist of objects

has_moreboolean

next_cursorstringOptional

Errors

422

Users List Request Unprocessable Entity Error

Headers

Query parameters

Response

Errors