POST /v1/SmsCommands
Account sid auth token

Machine-to-machine SMS Commands sent to/from SIMs

Send SMS Command to a Sim.

application/x-www-form-urlencoded

Body

  • Sim string Required

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

  • Payload string Required

    The message body of the SMS Command.

  • 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 are GET or POST.

  • CallbackUrl string(uri)

    The URL we should call using the callback_method after we have sent the command.

Responses

  • 201 application/json

    Created

    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
    • sid string | null

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

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

    • account_sid string | null

      The SID of the Account that created the SMS 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 that this SMS Command was sent to or from.

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

    • payload string | null

      The message body of the SMS Command sent to or from the SIM. For text mode messages, this can be up to 160 characters.

    • status string

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

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

    • direction string

      The direction of the SMS 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 to_sim or from_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 SMS Command resource.
POST /v1/SmsCommands 
curl \
 --request POST 'https://supersim.twilio.com/v1/SmsCommands' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'Payload=checkin%3A+firmware+update&Sim=SimSidOrUniqueName'
Request examples 
{"Payload" => "checkin: firmware update", "Sim" => "SimSidOrUniqueName"}
{"Payload" => "Report location: (52.520008, 13.404954)", "Sim" => "SimSidOrUniqueName", "CallbackMethod" => "POST", "CallbackUrl" => "http://blahblah.com/go"}
Response examples (201) 
{
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "payload": "checkin: firmware update",
  "date_created": "2015-07-30T20:00:00Z",
  "date_updated": "2015-07-30T20:00:00Z",
  "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "sid": "HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "status": "queued",
  "direction": "to_sim",
  "url": "https://supersim.twilio.com/v1/SmsCommands/HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
{
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "payload": "Report location: (52.520008, 13.404954)",
  "date_created": "2015-07-30T20:00:00Z",
  "date_updated": "2015-07-30T20:00:00Z",
  "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "sid": "HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "status": "queued",
  "direction": "to_sim",
  "url": "https://supersim.twilio.com/v1/SmsCommands/HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}