Twilio.Conversations.V2.ConversationService (twilio_elixir v0.1.3)

Service for Conversation API operations.

Operations: list, create, fetch, delete

Summary

Functions

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

Create a new conversation

Asynchronously delete a conversation and all associated data. Returns 202 Accepted with an Operation-Id for status tracking via GET /v2/ControlPlane/Operations/{operationId}.

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

Retrieve a Conversation.

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

Retrieve a list of Conversations.

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

Stream: Retrieve a list of Conversations. (lazy auto-pagination).

Functions

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

@spec create(Twilio.Client.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Conversations.V2.Conversation.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Create a new conversation

Operation: CreateConversationWithConfig | Tags: ConversationsV2Conversation

Required Parameters

Parameter	Type	Description
`configurationId`	string	The ID of an existing configuration.

Optional Parameters

Parameter	Type	Description
`configuration`	object	Conversation configuration settings.
`name`	string	The name of the conversation.
`participants`	array	Optional list of Participants to create with the Conversation.

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

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

Asynchronously delete a conversation and all associated data. Returns 202 Accepted with an Operation-Id for status tracking via GET /v2/ControlPlane/Operations/{operationId}.

Operation: DeleteConversationAsync | Tags: ConversationsV2Conversation

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

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

Retrieve a Conversation.

Operation: FetchConversation | Tags: ConversationsV2Conversation

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.

Operation: ListConversationByAccount | Tags: ConversationsV2Conversation

Query Parameters

Parameter	Type	Description
`status`	array	Filters for specific statuses
`channelId`	string	The resource identifier (such as callSid or messageSid) to filter conversations.
`pageSize`	integer	Maximum number of items to return in a single response
`pageToken`	string	A URL-safe, base64-encoded token representing the page of results to return

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

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

Stream: Retrieve a list of Conversations. (lazy auto-pagination).