Twilio.Messaging.V1.Service.ShortCodeService (twilio_elixir v0.1.1)

Copy Markdown View Source

A Messaging Service resource to add, fetch or remove short code numbers from a Messaging Service.

Operations: list, create, fetch, delete

Summary

Functions

Operation: CreateShortCode | Tags: MessagingV1ShortCode

Operation: DeleteShortCode | Tags: MessagingV1ShortCode

Operation: FetchShortCode | Tags: MessagingV1ShortCode

Operation: ListShortCode | Tags: MessagingV1ShortCode

Functions

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

@spec create(Twilio.Client.t(), String.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Messaging.V1.Service.ShortCode.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Operation: CreateShortCode | Tags: MessagingV1ShortCode

Required Parameters

ParameterTypeDescription
ShortCodeSidstringThe SID of the ShortCode resource being added to the Service.

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

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

Operation: DeleteShortCode | Tags: MessagingV1ShortCode

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

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

Operation: FetchShortCode | Tags: MessagingV1ShortCode

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

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

Operation: ListShortCode | Tags: MessagingV1ShortCode

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

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

Stream: (lazy auto-pagination).