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

Service for WebChannel API operations.

Operations: list, create, fetch, update, delete

Summary

Functions

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

Operation: CreateWebChannel | Tags: FlexV1WebChannel

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

Operation: DeleteWebChannel | Tags: FlexV1WebChannel

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

Operation: FetchWebChannel | Tags: FlexV1WebChannel

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

Operation: ListWebChannel | Tags: FlexV1WebChannel

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

Stream: (lazy auto-pagination).

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

Operation: UpdateWebChannel | Tags: FlexV1WebChannel

Functions

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

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

Operation: CreateWebChannel | Tags: FlexV1WebChannel

Required Parameters

Parameter	Type	Description
`ChatFriendlyName`	string	The chat channel's friendly name.
`CustomerFriendlyName`	string	The chat participant's friendly name.
`FlexFlowSid`	string	The SID of the Flex Flow.
`Identity`	string	The chat identity.

Optional Parameters

Parameter	Type	Description
`ChatUniqueName`	string	The chat channel's unique name.
`PreEngagementData`	string	The pre-engagement data.

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

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

Operation: DeleteWebChannel | Tags: FlexV1WebChannel

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

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

Operation: FetchWebChannel | Tags: FlexV1WebChannel

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

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

Operation: ListWebChannel | Tags: FlexV1WebChannel

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

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

Stream: (lazy auto-pagination).

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

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

Operation: UpdateWebChannel | Tags: FlexV1WebChannel

Optional Parameters

Parameter	Type	Description
`ChatStatus`	string	Values: `inactive`
`PostEngagementData`	string	The post-engagement data.