Twilio.Flex.V1.Interaction.InteractionChannelService (twilio_elixir v0.1.1)

Copy Markdown View Source

Service for InteractionChannel API operations.

Operations: list, fetch, update

Summary

Functions

Fetch a Channel for an Interaction.

List all Channels for an Interaction.

Stream: List all Channels for an Interaction. (lazy auto-pagination).

Update an existing Interaction Channel.

Functions

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

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

Fetch a Channel for an Interaction.

Operation: FetchInteractionChannel | Tags: FlexV1InteractionChannel

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

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

List all Channels for an Interaction.

Operation: ListInteractionChannel | Tags: FlexV1InteractionChannel

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

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

Stream: List all Channels for an Interaction. (lazy auto-pagination).

update(client, interaction_sid, sid, params \\ %{}, opts \\ [])

@spec update(Twilio.Client.t(), String.t(), String.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Flex.V1.Interaction.InteractionChannel.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Update an existing Interaction Channel.

Operation: UpdateInteractionChannel | Tags: FlexV1InteractionChannel

Required Parameters

ParameterTypeDescription
StatusstringValues: closed, inactive

Optional Parameters

ParameterTypeDescription

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

| Routing | string | It changes the state of associated tasks. Routing status is required, When the channel status is set to inactive. Allowed Value for routing status is closed. Otherwise Optional, if not specified, all tasks will be set to wrapping. |