Twilio.Flex.V1.InteractionService (twilio_elixir v0.1.1)

Copy Markdown View Source

Service for Interaction API operations.

Operations: create, fetch, update

Summary

Functions

Create a new Interaction.

Operation: FetchInteraction | Tags: FlexV1Interaction

Functions

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

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

Create a new Interaction.

Operation: CreateInteraction | Tags: FlexV1Interaction

Required Parameters

ParameterTypeDescription
ChannelstringThe Interaction's channel.

Optional Parameters

ParameterTypeDescription
InteractionContextSidstringThe Interaction context sid is used for adding a context lookup sid
RoutingstringThe Interaction's routing logic.
WebhookTtidstringThe unique identifier for Interaction level webhook

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

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

Operation: FetchInteraction | Tags: FlexV1Interaction

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

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

Updates an interaction.

Operation: UpdateInteraction | Tags: FlexV1Interaction

Optional Parameters

ParameterTypeDescription
WebhookTtidstringThe unique identifier for Interaction level webhook