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

Service for Participant API operations.

Operations: list, create, fetch

Summary

Functions

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

Create a Participant.

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

Retrieve a Participant.

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

Retrieve a list of Participants in a Conversation.

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

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

Functions

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

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

Create a Participant.

Operation: CreateParticipantInConversation | Tags: ConversationsV2Participant

Required Parameters

Parameter	Type	Description
`addresses`	array

Optional Parameters

Parameter	Type	Description
`name`	string
`profileId`	string
`type`	string	Values: `HUMAN_AGENT`, `CUSTOMER`, `AI_AGENT`, `AGENT`, `UNKNOWN`

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

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

Retrieve a Participant.

Operation: FetchParticipant | Tags: ConversationsV2Participant

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 Participants in a Conversation.

Operation: ListParticipantByConversation | Tags: ConversationsV2Participant

Query Parameters

Parameter	Type	Description
`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 Participants in a Conversation. (lazy auto-pagination).