Twilio.Messaging.V2.Channel.SenderService (twilio_elixir v0.1.1)

Copy Markdown View Source

The Senders resource represents a messaging channel sender (WhatsApp, RCS).

Operations: list, create, fetch, update, delete

Summary

Functions

(WhatsApp only) Delete a Sender.

Retrieve a Sender.

Retrieve a list of Senders for an account.

Stream: Retrieve a list of Senders for an account. (lazy auto-pagination).

Functions

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

@spec create(Twilio.Client.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Messaging.V2.Channel.Sender.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Create a Sender.

Operation: CreateChannelsSender | Tags: MessagingV2ChannelsSender

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

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

(WhatsApp only) Delete a Sender.

Operation: DeleteChannelsSender | Tags: MessagingV2ChannelsSender

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

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

Retrieve a Sender.

Operation: FetchChannelsSender | Tags: MessagingV2ChannelsSender

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

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

Retrieve a list of Senders for an account.

Operation: ListChannelsSender | Tags: MessagingV2ChannelsSender

Query Parameters

ParameterTypeDescription
Channelstring

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

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

Stream: Retrieve a list of Senders for an account. (lazy auto-pagination).

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

@spec update(Twilio.Client.t(), String.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Messaging.V2.Channel.Sender.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

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

(WhatsApp only) Update a Sender. You can update a sender's information, including profile, webhook, and configuration. To verify a phone number, set configuration.verification_code to the One-time Password (OTP) that you received.

Operation: UpdateChannelsSender | Tags: MessagingV2ChannelsSender