Twilio.Intelligence.V3.ConversationService (twilio_elixir v0.1.3)

Copy Markdown View Source

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

Intelligence Conversations resource to retrieve conversations that have been processed by an Intelligence Configuration.

Operations: list, fetch

Summary

Functions

Fetch a Conversation.

Retrieve a list of Conversations processed by an Intelligence Configuration.

Stream: Retrieve a list of Conversations processed by an Intelligence Configuration. (lazy auto-pagination).

Functions

fetch(client, sid, opts \\ [])

@spec fetch(Twilio.Client.t(), String.t(), keyword()) ::
  {:ok, map()} | {:ok, map(), map()} | :ok | {:error, Twilio.Error.t()}

Fetch a Conversation.

Operation: FetchConversation | Tags: Conversations

list(client, params \\ %{}, opts \\ [])

@spec list(Twilio.Client.t(), map(), keyword()) ::
  {:ok, Twilio.Page.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Retrieve a list of Conversations processed by an Intelligence Configuration.

Operation: ListConversations | Tags: Conversations

Query Parameters

ParameterTypeDescription
pageSizeintegerThe maximum number of resources to return
pageTokenstringToken for pagination
createdAtBeforestring (date-time)Filter by Conversations created before this timestamp.
createdAtAfterstring (date-time)Filter by Conversations created after this timestamp.
statusstringFilter by Conversation status.

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| channelId | string | Filters Conversations by the underlying channel resource ID, such as a Call ID or Message ID. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

channelsarrayFilters Conversations that include one or more of the specified communication channels (OR match).
conversationConfigurationIdstringThe configuration id used to generate the Conversation.

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| intelligenceConfigurationIds | array | Filters Conversations activated by one or more of the specified Intelligence Configuration IDs (OR match). |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| operatorIds | array | Filters Conversations to those where at least one of the specified Language Operators was executed (OR match). |

stream(client, params \\ %{}, opts \\ [])

@spec stream(Twilio.Client.t(), map(), keyword()) :: Enumerable.t()

Stream: Retrieve a list of Conversations processed by an Intelligence Configuration. (lazy auto-pagination).