TEteaflask
authed

Search conversations

Find the organization's assistant conversations in which a visitor wrote the given words, most recently active first, each with an excerpt of the newest matching message. Use list_conversations to browse by time, agent or outcome instead; read a conversation in full with get_conversation_transcript. Very common words alone match nothing. A full page means more matches may exist.

get/api/v1/conversations/search

Request

  • Base URL
    https://api.teaflask.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.teaflask.com/api/v1/conversations/search
  • Auth
    none declared

Query parameters

querystring required

Words the visitor typed; other forms of a word match too. Put a phrase in "double quotes", and put - before a word to exclude it.

sincestring date-time nullable

Only conversations last active at or after this time (ISO 8601; a date or a time without a zone is read as UTC).

untilstring date-time nullable

Only conversations last active before this time (ISO 8601; a date or a time without a zone is read as UTC).

agent_definition_idstring uuid nullable

Only conversations whose agent_definition_id is this id.

status'queued' | 'working' | 'awaiting_input' | 'succeeded' | 'failed' | 'parked' | 'superseded' | 'stopped'

Only conversations whose latest exchange has this status: succeeded; failed (an error stopped it); stopped (a person stopped it); superseded (a newer message replaced it while it waited); queued or working (still underway); awaiting_input or parked (waiting for an approval, or for the visitor's app to run a step).

before_updated_atstring date-time nullable

The updated_at of the last row of the previous page; pass with before_id to fetch the next page.

before_idstring uuid nullable

The id of the last row of the previous page; pass with before_updated_at to fetch the next page.

limitinteger

The most conversations to return.

Response

Successful Response

idstring uuid required

The conversation's id.

titlestring required

A short title: the first line of the first message, or its first file's name when it had no text.

owner_end_user_idstring nullable required

The organization's own id for the identified visitor; null for an anonymous visitor.

channel'web' | 'slack' required

Where a conversation happened.

owner_display_namestring nullable required

Who the conversation belongs to where it happened: the person's Slack name for a direct message, or #channel for a Slack channel; null for website visitors.

agent_definition_idstring uuid nullable required

The agent that answered the latest exchange that recorded one; null when none did or the organization's default assistant answered.

agent_namestring nullable required

That agent's name; null when the agent is unknown.

last_turn_status'queued' | 'working' | 'awaiting_input' | 'succeeded' | 'failed' | 'parked' | 'superseded' | 'stopped' required
turn_countinteger required

How many exchanges the whole conversation holds.

total_charged_microusdinteger required

What the conversation cost, in millionths of a US dollar, including work done outside any single exchange.

created_atstring date-time required

When the conversation started.

updated_atstring date-time required

When the conversation was last active.

snippetstring required

An excerpt of the newest visitor message that matched the query.

Changes

No recorded changes to this operation across all 1 revision of this API.