Twilio.Supersim.V1.IpCommandService (twilio_elixir v0.1.1)

Machine-to-machine IP Commands sent to/from Super SIMs

Operations: list, create, fetch

Summary

Functions

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

Send an IP Command to a Super SIM.

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

Fetch IP Command instance from your account.

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

Retrieve a list of IP Commands from your account.

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

Stream: Retrieve a list of IP Commands from your account. (lazy auto-pagination).

Functions

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

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

Send an IP Command to a Super SIM.

Operation: CreateIpCommand | Tags: SupersimV1IpCommand

Required Parameters

Parameter	Type	Description
`DevicePort`	integer	The device port to which the IP Command will be sent.

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

| Payload | string | The data that will be sent to the device. The payload cannot exceed 1300 bytes. If the PayloadType is set to text, the payload is encoded in UTF-8. If PayloadType is set to binary, the payload is encoded in Base64. |

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

| Sim | string | The sid or unique_name of the Super SIM to send the IP Command to. |

Optional Parameters

Parameter	Type	Description

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

| CallbackMethod | string (http-method) | The HTTP method we should use to call callback_url. Can be GET or POST, and the default is POST. Values: GET, POST |

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

`CallbackUrl`	string (uri)	The URL we should call using the `callback_method` after we have sent the IP Command.
`PayloadType`	string	Values: `text`, `binary`

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

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

Fetch IP Command instance from your account.

Operation: FetchIpCommand | Tags: SupersimV1IpCommand

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 IP Commands from your account.

Operation: ListIpCommand | Tags: SupersimV1IpCommand

Query Parameters

Parameter	Type	Description
`Sim`	string	The SID or unique name of the Sim resource that IP Command was sent to or from.
`SimIccid`	string	The ICCID of the Sim resource that IP Command was sent to or from.

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

| Status | string | The status of the IP Command. Can be: queued, sent, received or failed. See the IP Command Status Values for a description of each. |

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

| Direction | string | The direction of the IP Command. Can be to_sim or from_sim. The value of to_sim is synonymous with the term mobile terminated, and from_sim is synonymous with the term mobile originated. |

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

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

Stream: Retrieve a list of IP Commands from your account. (lazy auto-pagination).