Twilio.IpMessaging.V2.Service.Channel.WebhookService (twilio_elixir v0.1.1)

Copy Markdown View Source

Service for Webhook API operations.

Operations: list, create, fetch, update, delete

Summary

Functions

Operation: CreateChannelWebhook | Tags: IpMessagingV2Webhook

Operation: DeleteChannelWebhook | Tags: IpMessagingV2Webhook

Operation: FetchChannelWebhook | Tags: IpMessagingV2Webhook

Operation: ListChannelWebhook | Tags: IpMessagingV2Webhook

Operation: UpdateChannelWebhook | Tags: IpMessagingV2Webhook

Functions

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

@spec create(Twilio.Client.t(), String.t(), String.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.IpMessaging.V2.Service.Channel.Webhook.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Operation: CreateChannelWebhook | Tags: IpMessagingV2Webhook

Required Parameters

ParameterTypeDescription
TypestringValues: webhook, trigger, studio

Optional Parameters

ParameterTypeDescription
Configuration.Filtersarray
Configuration.FlowSidstring
Configuration.MethodstringValues: GET, POST
Configuration.RetryCountinteger
Configuration.Triggersarray
Configuration.Urlstring

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

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

Operation: DeleteChannelWebhook | Tags: IpMessagingV2Webhook

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

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

Operation: FetchChannelWebhook | Tags: IpMessagingV2Webhook

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

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

Operation: ListChannelWebhook | Tags: IpMessagingV2Webhook

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

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

Stream: (lazy auto-pagination).

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

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

Operation: UpdateChannelWebhook | Tags: IpMessagingV2Webhook

Optional Parameters

ParameterTypeDescription
Configuration.Filtersarray
Configuration.FlowSidstring
Configuration.MethodstringValues: GET, POST
Configuration.RetryCountinteger
Configuration.Triggersarray
Configuration.Urlstring