Twilio.Conversations.V2.Conversation.CommunicationService (twilio_elixir v0.1.3)

Service for Communication API operations.

Operations: list, create, fetch

Summary

Functions

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

Create a Communication.

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

Retrieve a Communication.

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

Retrieve a list of Communications in a Conversation.

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

Stream: Retrieve a list of Communications in a Conversation. (lazy auto-pagination).

Functions

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

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

Create a Communication.

Operation: CreateCommunicationInConversation | Tags: ConversationsV2Communication

Required Parameters

Parameter	Type	Description
`author`	object
`content`	string	The content of the Communication.
`recipients`	array

Optional Parameters

Parameter	Type	Description
`channelId`	string

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

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

Retrieve a Communication.

Operation: FetchCommunication | Tags: ConversationsV2Communication

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

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

Retrieve a list of Communications in a Conversation.

Operation: ListCommunicationByConversation | Tags: ConversationsV2Communication

Query Parameters

Parameter	Type	Description
`channelId`	string	Resource identifier to filter communications
`pageSize`	integer	Maximum number of items to return
`pageToken`	string	Page token for pagination

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

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

Stream: Retrieve a list of Communications in a Conversation. (lazy auto-pagination).