Retrieve a list of Commands from your account.

GET /v1/Commands

Machine-to-machine commands sent to/from devices

Retrieve a list of Commands from your account.

Query parameters

  • Sim string

    The sid or unique_name of the Sim resources to read.

  • Status string

    The status of the resources to read. Can be: queued, sent, delivered, received, or failed.

    Values are queued, sent, delivered, received, or failed.

  • Direction string

    Only return Commands with this direction value.

    Values are from_sim or to_sim.

  • Transport string

    Only return Commands with this transport value. Can be: sms or ip.

    Values are sms or ip.

  • PageSize integer(int64)

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

  • Page integer

    The page index. This value is simply for client state.

    Minimum value is 0.

  • PageToken string

    The page token. This is provided by the API.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • commands array[object]
      Hide commands attributes Show commands attributes object
      • sid string | null

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

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^DC[0-9a-fA-F]{32}$.

      • account_sid string | null

        The SID of the Account that created the Command resource.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

      • sim_sid string | null

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

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^DE[0-9a-fA-F]{32}$.

      • command string | null

        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 string

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

        Values are text or binary.

      • transport string

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

        Values are sms or ip.

      • delivery_receipt_requested boolean | null

        Whether to request a delivery receipt.

      • status string

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

        Values are queued, sent, delivered, received, or failed.

      • direction string

        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.

        Values are from_sim or to_sim.

      • date_created string(date-time) | null

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

      • date_updated string(date-time) | null

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

      • url string(uri) | null

        The absolute URL of the resource.

    • meta object
      Hide meta attributes Show meta attributes object
      • first_page_url string(uri)
      • key string
      • next_page_url string(uri) | null
      • page integer
      • page_size integer
      • previous_page_url string(uri) | null
      • url string(uri)
GET /v1/Commands
curl \
 --request GET 'https://wireless.twilio.com/v1/Commands' \
 --user "username:password"
Response examples (200)
{
  "meta": {
    "key": "commands",
    "url": "https://wireless.twilio.com/v1/Commands?Status=queued&Direction=from_sim&Sim=sim&PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://wireless.twilio.com/v1/Commands?Status=queued&Direction=from_sim&Sim=sim&PageSize=50&Page=0",
    "previous_page_url": null
  },
  "commands": []
}
{
  "meta": {
    "key": "commands",
    "url": "https://wireless.twilio.com/v1/Commands?Status=queued&Direction=from_sim&Sim=sim&PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://wireless.twilio.com/v1/Commands?Status=queued&Direction=from_sim&Sim=sim&PageSize=50&Page=0",
    "previous_page_url": null
  },
  "commands": [
    {
      "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "url": "https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "status": "queued",
      "command": "command",
      "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "direction": "from_sim",
      "transport": "sms",
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "command_mode": "text",
      "date_created": "2015-07-30T20:00:00Z",
      "date_updated": "2015-07-30T20:00:00Z",
      "delivery_receipt_requested": true
    }
  ]
}
{
  "meta": {
    "key": "commands",
    "url": "https://wireless.twilio.com/v1/Commands?Status=queued&Direction=to_sim&Transport=ip&Sim=sim&PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://wireless.twilio.com/v1/Commands?Status=queued&Direction=to_sim&Transport=ip&Sim=sim&PageSize=50&Page=0",
    "previous_page_url": null
  },
  "commands": [
    {
      "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "url": "https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "status": "queued",
      "command": "command",
      "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "direction": "to_sim",
      "transport": "ip",
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "command_mode": "binary",
      "date_created": "2015-07-30T20:00:00Z",
      "date_updated": "2015-07-30T20:00:00Z",
      "delivery_receipt_requested": true
    }
  ]
}