TWtwilio
WirelessV1Command

Send a Command to a Sim.

Send a Command to a Sim.

post/v1/Commands

Request

  • Base URL
    https://wireless.twilio.com
  • URL
    https://wireless.twilio.com/v1/Commands
  • Auth
    HTTP basic

Request body application/x-www-form-urlencoded

Commandstring required

The message body of the Command. Can be plain text in text mode or a Base64 encoded byte string in binary mode.

Simstring

The sid or unique_name of the SIM to send the Command to.

CallbackMethod'GET' | 'POST' http-method

The HTTP method we use to call callback_url. Can be: POST or GET, and the default is POST.

CallbackUrlstring uri

The URL we call using the callback_url when the Command has finished sending, whether the command was delivered or it failed.

CommandMode'text' | 'binary'

The mode used to send the SMS message. Can be: text or binary. The default SMS mode is text.

IncludeSidstring

Whether to include the SID of the command in the message body. Can be: none, start, or end, and the default behavior is none. When sending a Command to a SIM in text mode, we can automatically include the SID of the Command in the message body, which could be used to ensure that the device does not process the same Command more than once. A value of start will prepend the message with the Command SID, and end will append it to the end, separating the Command SID from the message body with a space. The length of the Command SID is included in the 160 character limit so the SMS body must be 128 characters or less before the Command SID is included.

DeliveryReceiptRequestedboolean

Whether to request delivery receipt from the recipient. For Commands that request delivery receipt, the Command state transitions to 'delivered' once the server has received a delivery receipt from the device. The default value is true.

Response

Created

sidstring nullable

The unique string that we created to identify the Command resource.

account_sidstring nullable

The SID of the Account that created the Command resource.

sim_sidstring nullable

The SID of the Sim resource that the Command was sent to or from.

commandstring nullable

The message being sent to or from the SIM. For text mode messages, this can be up to 160 characters. For binary mode messages, this is a series of up to 140 bytes of data encoded using base64.

command_mode'text' | 'binary'

The mode used to send the SMS message. Can be: text or binary. The default SMS mode is text.

transport'sms' | 'ip'

The type of transport used. Can be: sms or ip.

delivery_receipt_requestedboolean nullable

Whether to request a delivery receipt.

status'queued' | 'sent' | 'delivered' | 'received' | 'failed'

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

direction'from_sim' | 'to_sim'

The direction of the 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.

date_createdstring date-time nullable

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updatedstring date-time nullable

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

urlstring uri nullable

The absolute URL of the resource.

Changes

Changes to this operation have not been checked yet.