CreateCommandRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/twilio/main/json-schema/twilio-create-command-request-schema.json",
  "title": "CreateCommandRequest",
  "x-generated": "2026-10-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/twilio-commands-api-openapi.yml#/components/schemas/CreateCommandRequest",
  "type": "object",
  "required": [
    "Command"
  ],
  "properties": {
    "Command": {
      "type": "string",
      "description": "The message body of the Command. Can be plain text in text mode or a Base64 encoded byte string in binary mode."
    },
    "Sim": {
      "type": "string",
      "description": "The `sid` or `unique_name` of the [SIM](https://www.twilio.com/docs/iot/wireless/api/sim-resource) to send the Command to."
    },
    "CallbackMethod": {
      "type": "string",
      "format": "http-method",
      "enum": [
        "HEAD",
        "GET",
        "POST",
        "PATCH",
        "PUT",
        "DELETE"
      ],
      "description": "The HTTP method we use to call `callback_url`. Can be: `POST` or `GET`, and the default is `POST`."
    },
    "CallbackUrl": {
      "type": "string",
      "format": "uri",
      "description": "The URL we call using the `callback_url` when the Command has finished sending, whether the command was delivered or it failed."
    },
    "CommandMode": {
      "type": "string",
      "$ref": "#/$defs/command_enum_command_mode",
      "description": "The mode to use when sending the SMS message. Can be: `text` or `binary`. The default SMS mode is `text`."
    },
    "IncludeSid": {
      "type": "string",
      "description": "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."
    },
    "DeliveryReceiptRequested": {
      "type": "boolean",
      "description": "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`."
    }
  },
  "$defs": {
    "command_enum_command_mode": {
      "type": "string",
      "enum": [
        "text",
        "binary"
      ]
    }
  }
}