components: securitySchemes: accountSid_authToken: scheme: basic type: http schemas: wireless.v1.account_usage_record: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the AccountUsageRecord resource. period: nullable: true description: The time period for which usage is reported. Contains `start` and `end` properties that describe the period using GMT date-time values specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. commands: nullable: true description: An object that describes the aggregated Commands usage for all SIMs during the specified period. See [Commands Usage Object](https://www.twilio.com/docs/iot/wireless/api/account-usagerecord-resource#commands-usage-object). data: nullable: true description: An object that describes the aggregated Data usage for all SIMs over the period. See [Data Usage Object](https://www.twilio.com/docs/iot/wireless/api/account-usagerecord-resource#data-usage-object). account_usage_record_enum_granularity: type: string enum: - hourly - daily - all wireless.v1.command: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^DC[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Command resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Command resource. sim_sid: type: string minLength: 34 maxLength: 34 pattern: ^DE[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Sim resource](https://www.twilio.com/docs/iot/wireless/api/sim-resource) that the Command was sent to or from. command: type: string nullable: true description: 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. x-twilio: pii: handling: standard deleteSla: 30 command_mode: $ref: '#/components/schemas/command_enum_command_mode' transport: $ref: '#/components/schemas/command_enum_transport' delivery_receipt_requested: type: boolean nullable: true description: Whether to request a delivery receipt. status: $ref: '#/components/schemas/command_enum_status' direction: $ref: '#/components/schemas/command_enum_direction' date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. url: type: string format: uri nullable: true description: The absolute URL of the resource. command_enum_direction: type: string enum: - from_sim - to_sim description: 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`. command_enum_status: type: string enum: - queued - sent - delivered - received - failed description: 'The status of the Command. Can be: `queued`, `sent`, `delivered`, `received`, or `failed`. See [Status Values](https://www.twilio.com/docs/iot/wireless/api/command-resource#status-values) for a description of each state.' command_enum_command_mode: type: string enum: - text - binary description: 'The mode used to send the SMS message. Can be: `text` or `binary`. The default SMS mode is `text`.' command_enum_transport: type: string enum: - sms - ip description: 'The type of transport used. Can be: `sms` or `ip`.' wireless.v1.sim.data_session: type: object properties: sid: type: string nullable: true description: The unique string that we created to identify the DataSession resource. sim_sid: type: string nullable: true description: The SID of the [Sim resource](https://www.twilio.com/docs/iot/wireless/api/sim-resource) that the Data Session is for. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the DataSession resource. radio_link: type: string nullable: true description: The generation of wireless technology that the device was using. operator_mcc: type: string nullable: true description: 'The ''mobile country code'' is the unique ID of the home country where the Data Session took place. See: [MCC/MNC lookup](http://mcc-mnc.com/).' operator_mnc: type: string nullable: true description: The 'mobile network code' is the unique ID specific to the mobile operator network where the Data Session took place. operator_country: type: string nullable: true description: The three letter country code representing where the device's Data Session took place. This is determined by looking up the `operator_mcc`. operator_name: type: string nullable: true description: The friendly name of the mobile operator network that the [SIM](https://www.twilio.com/docs/iot/wireless/api/sim-resource)-connected device is attached to. This is determined by looking up the `operator_mnc`. cell_id: type: string nullable: true description: The unique ID of the cellular tower that the device was attached to at the moment when the Data Session was last updated. cell_location_estimate: nullable: true description: 'An object that describes the estimated location in latitude and longitude where the device''s Data Session took place. The location is derived from the `cell_id` when the Data Session was last updated. See [Cell Location Estimate Object](https://www.twilio.com/docs/iot/wireless/api/datasession-resource#cell-location-estimate-object). ' packets_uploaded: type: integer default: 0 description: The number of packets uploaded by the device between the `start` time and when the Data Session was last updated. packets_downloaded: type: integer default: 0 description: The number of packets downloaded by the device between the `start` time and when the Data Session was last updated. last_updated: type: string format: date-time nullable: true description: The date that the resource was last updated, given as GMT in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. start: type: string format: date-time nullable: true description: The date that the Data Session started, given as GMT in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. end: type: string format: date-time nullable: true description: The date that the record ended, given as GMT in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. imei: type: string nullable: true description: 'The ''international mobile equipment identity'' is the unique ID of the device using the SIM to connect. An IMEI is a 15-digit string: 14 digits for the device identifier plus a check digit calculated using the Luhn formula.' wireless.v1.rate_plan: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^WP[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the RatePlan resource. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the RatePlan resource. friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. data_enabled: type: boolean nullable: true description: Whether SIMs can use GPRS/3G/4G/LTE data connectivity. data_metering: type: string nullable: true description: 'The model used to meter data usage. Can be: `payg` and `quota-1`, `quota-10`, and `quota-50`. Learn more about the available [data metering models](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource#payg-vs-quota-data-plans).' data_limit: type: integer default: 0 description: The total data usage (download and upload combined) in Megabytes that the Network allows during one month on the home network (T-Mobile USA). The metering period begins the day of activation and ends on the same day in the following month. Can be up to 2TB. messaging_enabled: type: boolean nullable: true description: Whether SIMs can make, send, and receive SMS using [Commands](https://www.twilio.com/docs/iot/wireless/api/command-resource). voice_enabled: type: boolean nullable: true description: Deprecated. Whether SIMs can make and receive voice calls. national_roaming_enabled: type: boolean nullable: true description: Whether SIMs can roam on networks other than the home network (T-Mobile USA) in the United States. See [national roaming](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource#national-roaming). national_roaming_data_limit: type: integer default: 0 description: The total data usage (download and upload combined) in Megabytes that the Network allows during one month on non-home networks in the United States. The metering period begins the day of activation and ends on the same day in the following month. Can be up to 2TB. international_roaming: type: array items: type: string nullable: true description: 'The list of services that SIMs capable of using GPRS/3G/4G/LTE data connectivity can use outside of the United States. Can contain: `data` and `messaging`.' international_roaming_data_limit: type: integer default: 0 description: The total data usage (download and upload combined) in Megabytes that the Network allows during one month when roaming outside the United States. Can be up to 2TB. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. url: type: string format: uri nullable: true description: The absolute URL of the resource. rate_plan_enum_data_limit_strategy: type: string enum: - block - throttle description: The way the home network (T-Mobile USA) will behave after a SIM's usage exceeds its `data_limit`. Can be either `block` or `throttle`. Default is `block`. wireless.v1.sim: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^DE[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Sim resource. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource. x-twilio: pii: handling: standard deleteSla: 30 account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) to which the Sim resource belongs. rate_plan_sid: type: string minLength: 34 maxLength: 34 pattern: ^WP[0-9a-fA-F]{32}$ nullable: true description: The SID of the [RatePlan resource](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource) to which the Sim resource is assigned. friendly_name: type: string nullable: true description: The string that you assigned to describe the Sim resource. x-twilio: pii: handling: standard deleteSla: 30 iccid: type: string nullable: true description: The [ICCID](https://en.wikipedia.org/wiki/SIM_card#ICCID) associated with the SIM. x-twilio: pii: handling: standard deleteSla: 30 e_id: type: string nullable: true description: Deprecated. status: $ref: '#/components/schemas/sim_enum_status' reset_status: $ref: '#/components/schemas/sim_enum_reset_status' commands_callback_url: type: string format: uri nullable: true description: The URL we call using the `commands_callback_method` when the SIM originates a machine-to-machine [Command](https://www.twilio.com/docs/iot/wireless/api/command-resource). Your server should respond with an HTTP status code in the 200 range; any response body will be ignored. commands_callback_method: type: string format: http-method enum: - GET - POST nullable: true description: 'The HTTP method we use to call `commands_callback_url`. Can be: `POST` or `GET`. Default is `POST`.' sms_fallback_method: type: string format: http-method enum: - GET - POST nullable: true description: Deprecated. sms_fallback_url: type: string format: uri nullable: true description: Deprecated. sms_method: type: string format: http-method enum: - GET - POST nullable: true description: Deprecated. sms_url: type: string format: uri nullable: true description: Deprecated. voice_fallback_method: type: string format: http-method enum: - GET - POST nullable: true description: 'Deprecated. The HTTP method we use to call `voice_fallback_url`. Can be: `GET` or `POST`. Default is `POST`.' voice_fallback_url: type: string format: uri nullable: true description: Deprecated. The URL we call using the `voice_fallback_method` when an error occurs while retrieving or executing the TwiML requested from `voice_url`. voice_method: type: string format: http-method enum: - GET - POST nullable: true description: 'Deprecated. The HTTP method we use to call `voice_url`. Can be: `GET` or `POST`. Default is `POST`.' voice_url: type: string format: uri nullable: true description: Deprecated. The URL we call using the `voice_method` when the SIM-connected device makes a voice call. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the Sim resource was last updated specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. url: type: string format: uri nullable: true description: The absolute URL of the resource. links: type: object format: uri-map nullable: true description: The URLs of related subresources. ip_address: type: string nullable: true description: Deprecated. sim_enum_status: type: string enum: - new - ready - active - suspended - deactivated - canceled - scheduled - updating description: 'The status of the Sim resource. Can be: `new`, `ready`, `active`, `deactivated`, `canceled`, `deleted`, `scheduled`, or `updating`. See [Status Values](https://www.twilio.com/docs/iot/wireless/api/sim-resource#status-values) for the description of each status.' sim_enum_reset_status: type: string enum: - resetting description: 'The connectivity reset status of the SIM. Can be: null or `resetting`. When a connectivity reset is initiated on a SIM, this property is `resetting`. After the reset completes, it is null.' wireless.v1.sim.usage_record: type: object properties: sim_sid: type: string nullable: true description: The SID of the [Sim resource](https://www.twilio.com/docs/iot/wireless/api/sim-resource) that this Usage Record is for. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageRecord resource. period: nullable: true description: The time period for which the usage is reported. Contains `start` and `end` datetime values given as GMT in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. commands: nullable: true description: An object that describes the SIM's usage of Commands during the specified period. See [Commands Usage Object](https://www.twilio.com/docs/iot/wireless/api/sim-usagerecord-resource#commands-usage-object). data: nullable: true description: An object that describes the SIM's data usage during the specified period. See [Data Usage Object](https://www.twilio.com/docs/iot/wireless/api/sim-usagerecord-resource#data-usage-object). usage_record_enum_granularity: type: string enum: - hourly - daily - all info: title: Twilio - Wireless description: This is the public Twilio REST API. termsOfService: https://www.twilio.com/legal/tos contact: name: Twilio Support url: https://support.twilio.com email: support@twilio.com license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html version: 1.0.0 openapi: 3.0.1 paths: /v1/UsageRecords: servers: - url: https://wireless.twilio.com description: Aggregated Usage information for all SIMs on an Account x-twilio: defaultOutputProperties: - period pathType: list get: description: '' summary: '' tags: - WirelessV1UsageRecord parameters: - name: End in: query description: Only include usage that has occurred on or before this date. Format is [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). schema: type: string format: date-time examples: fetch: value: '2015-07-30T20:00:00Z' - name: Start in: query description: Only include usage that has occurred on or after this date. Format is [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). schema: type: string format: date-time examples: fetch: value: '2015-07-30T20:00:00Z' - name: Granularity in: query description: 'How to summarize the usage by time. Can be: `daily`, `hourly`, or `all`. A value of `all` returns one Usage Record that describes the usage for the entire period.' schema: $ref: '#/components/schemas/account_usage_record_enum_granularity' - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: usage_records: type: array items: $ref: '#/components/schemas/wireless.v1.account_usage_record' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListAccountUsageRecordResponse examples: fetch: value: usage_records: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa commands: billing_units: USD billed: 0 total: 3 from_sim: 1 to_sim: 2 home: billing_units: USD billed: 0 total: 3 from_sim: 1 to_sim: 2 national_roaming: billing_units: USD billed: 0 total: 0 from_sim: 0 to_sim: 0 international_roaming: [] data: billing_units: USD billed: 0.35 total: 3494609 upload: 731560 download: 2763049 units: bytes home: billing_units: USD billed: 0.35 total: 3494609 upload: 731560 download: 2763049 units: bytes national_roaming: billing_units: USD billed: 0 total: 0 upload: 0 download: 0 units: bytes international_roaming: [] period: start: '2015-07-30T20:00:00Z' end: '2015-07-30T20:00:00Z' - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa commands: {} data: {} period: {} meta: first_page_url: https://wireless.twilio.com/v1/UsageRecords?Start=2015-07-30T20%3A00%3A00Z&End=2015-07-30T20%3A00%3A00Z&PageSize=50&Page=0 key: usage_records next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://wireless.twilio.com/v1/UsageRecords?Start=2015-07-30T20%3A00%3A00Z&End=2015-07-30T20%3A00%3A00Z&PageSize=50&Page=0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListAccountUsageRecord /v1/Commands/{Sid}: servers: - url: https://wireless.twilio.com description: Machine-to-machine commands sent to/from devices x-twilio: defaultOutputProperties: - sid - command_mode - transport - status - direction - date_created pathType: instance get: description: Fetch a Command instance from your account. summary: Fetch a Command instance from your account. tags: - WirelessV1Command parameters: - name: Sid in: path description: The SID of the Command resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^DC[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/wireless.v1.command' examples: fetchCommandSms: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa command: command command_mode: text date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' delivery_receipt_requested: true sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa direction: from_sim sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: queued transport: sms url: https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa fetchCommandIp: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa command: command command_mode: text date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' delivery_receipt_requested: false sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa direction: to_sim sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: queued transport: ip url: https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchCommand delete: description: Delete a Command instance from your account. summary: Delete a Command instance from your account. tags: - WirelessV1Command parameters: - name: Sid in: path description: The SID of the Command resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^DC[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteCommand /v1/Commands: servers: - url: https://wireless.twilio.com description: Machine-to-machine commands sent to/from devices x-twilio: defaultOutputProperties: - sid - command_mode - transport - status - direction - date_created pathType: list get: description: Retrieve a list of Commands from your account. summary: Retrieve a list of Commands from your account. tags: - WirelessV1Command parameters: - name: Sim in: query description: The `sid` or `unique_name` of the [Sim resources](https://www.twilio.com/docs/iot/wireless/api/sim-resource) to read. schema: type: string examples: readEmpty: value: sim readFull: value: sim readIp: value: sim - name: Status in: query description: 'The status of the resources to read. Can be: `queued`, `sent`, `delivered`, `received`, or `failed`.' schema: $ref: '#/components/schemas/command_enum_status' examples: readEmpty: value: queued readFull: value: queued readIp: value: queued - name: Direction in: query description: Only return Commands with this direction value. schema: $ref: '#/components/schemas/command_enum_direction' examples: readEmpty: value: from_sim readFull: value: from_sim readIp: value: to_sim - name: Transport in: query description: 'Only return Commands with this transport value. Can be: `sms` or `ip`.' schema: $ref: '#/components/schemas/command_enum_transport' examples: readIp: value: ip - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: commands: type: array items: $ref: '#/components/schemas/wireless.v1.command' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListCommandResponse examples: readEmpty: value: commands: [] meta: first_page_url: https://wireless.twilio.com/v1/Commands?Status=queued&Direction=from_sim&Sim=sim&PageSize=50&Page=0 key: commands next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://wireless.twilio.com/v1/Commands?Status=queued&Direction=from_sim&Sim=sim&PageSize=50&Page=0 readFull: value: commands: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa command: command command_mode: text date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' delivery_receipt_requested: true sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa direction: from_sim sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: queued transport: sms url: https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: first_page_url: https://wireless.twilio.com/v1/Commands?Status=queued&Direction=from_sim&Sim=sim&PageSize=50&Page=0 key: commands next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://wireless.twilio.com/v1/Commands?Status=queued&Direction=from_sim&Sim=sim&PageSize=50&Page=0 readIp: value: commands: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa command: command command_mode: binary date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' delivery_receipt_requested: true sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa direction: to_sim sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: queued transport: ip url: https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: first_page_url: https://wireless.twilio.com/v1/Commands?Status=queued&Direction=to_sim&Transport=ip&Sim=sim&PageSize=50&Page=0 key: commands next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://wireless.twilio.com/v1/Commands?Status=queued&Direction=to_sim&Transport=ip&Sim=sim&PageSize=50&Page=0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListCommand post: description: Send a Command to a Sim. summary: Send a Command to a Sim. tags: - WirelessV1Command responses: '201': content: application/json: schema: $ref: '#/components/schemas/wireless.v1.command' examples: createCommandSms: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa command: command command_mode: text date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' delivery_receipt_requested: true sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa direction: from_sim sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: queued transport: sms url: https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createCommandIp: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa command: command command_mode: binary date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' delivery_receipt_requested: true direction: to_sim sid: DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: queued transport: ip url: https://wireless.twilio.com/v1/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateCommand requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateCommandRequest 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: - GET - POST 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: $ref: '#/components/schemas/command_enum_command_mode' 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`. required: - Command examples: createCommandSms: value: CallbackMethod: callback_method CallbackUrl: http://www.example.com Command: command CommandMode: text Sim: sim IncludeSid: include_sid createCommandIp: value: CallbackMethod: callback_method CallbackUrl: http://www.example.com Command: command CommandMode: binary DeliveryReceiptRequested: true Sim: sim IncludeSid: include_sid /v1/Sims/{SimSid}/DataSessions: servers: - url: https://wireless.twilio.com description: Data session information for SIMs x-twilio: defaultOutputProperties: - sid - packets_uploaded - packets_downloaded - start - end parent: /Sims/{Sid} pathType: list get: description: '' summary: '' tags: - WirelessV1DataSession parameters: - name: SimSid in: path description: The SID of the [Sim resource](https://www.twilio.com/docs/iot/wireless/api/sim-resource) with the Data Sessions to read. schema: type: string required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: data_sessions: type: array items: $ref: '#/components/schemas/wireless.v1.sim.data_session' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListDataSessionResponse examples: fetch: value: data_sessions: - sid: WNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa radio_link: LTE operator_mcc: '' operator_mnc: '' operator_country: '' operator_name: '' cell_id: '' cell_location_estimate: {} packets_uploaded: 0 packets_downloaded: 0 last_updated: '2015-07-30T20:00:00Z' start: '2015-07-30T20:00:00Z' end: null imei: null - sid: WNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa radio_link: 3G operator_mcc: '' operator_mnc: '' operator_country: '' operator_name: '' cell_id: '' cell_location_estimate: {} packets_uploaded: 0 packets_downloaded: 0 last_updated: '2015-07-30T20:00:00Z' start: '2015-07-30T20:00:00Z' end: '2015-07-30T20:00:00Z' imei: 014931000129700 meta: first_page_url: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions?PageSize=50&Page=0 key: data_sessions next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions?PageSize=50&Page=0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListDataSession /v1/RatePlans: servers: - url: https://wireless.twilio.com description: Capabilities and restrictions for SIMs x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - date_created pathType: list get: description: '' summary: '' tags: - WirelessV1RatePlan parameters: - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: rate_plans: type: array items: $ref: '#/components/schemas/wireless.v1.rate_plan' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListRatePlanResponse examples: readEmpty: value: meta: first_page_url: https://wireless.twilio.com/v1/RatePlans?PageSize=50&Page=0 key: rate_plans next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://wireless.twilio.com/v1/RatePlans?PageSize=50&Page=0 rate_plans: [] readFull: value: meta: first_page_url: https://wireless.twilio.com/v1/RatePlans?PageSize=50&Page=0 key: rate_plans next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://wireless.twilio.com/v1/RatePlans?PageSize=50&Page=0 rate_plans: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique_name data_enabled: true data_limit: 1000 data_metering: payg date_created: '2019-07-30T20:00:00Z' date_updated: '2019-07-30T20:00:00Z' friendly_name: friendly_name messaging_enabled: true voice_enabled: true national_roaming_enabled: true national_roaming_data_limit: 1000 international_roaming: - data - messaging - voice international_roaming_data_limit: 1000 sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa usage_notification_method: POST usage_notification_url: https://callback.com data_limit_strategy: block url: https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListRatePlan post: description: '' summary: '' tags: - WirelessV1RatePlan responses: '201': content: application/json: schema: $ref: '#/components/schemas/wireless.v1.rate_plan' examples: create: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique_name data_enabled: true data_limit: 1000 data_limit_strategy: block data_metering: payg date_created: '2019-07-30T20:00:00Z' date_updated: '2019-07-30T20:00:00Z' friendly_name: friendly_name messaging_enabled: true voice_enabled: true national_roaming_enabled: true national_roaming_data_limit: 1000 international_roaming: - data - messaging - voice international_roaming_data_limit: 1000 sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa usage_notification_method: POST usage_notification_url: https://callback.com url: https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateRatePlan requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateRatePlanRequest properties: UniqueName: type: string description: An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource. FriendlyName: type: string description: A descriptive string that you create to describe the resource. It does not have to be unique. DataEnabled: type: boolean description: Whether SIMs can use GPRS/3G/4G/LTE data connectivity. DataLimit: type: integer description: The total data usage (download and upload combined) in Megabytes that the Network allows during one month on the home network (T-Mobile USA). The metering period begins the day of activation and ends on the same day in the following month. Can be up to 2TB and the default value is `1000`. DataMetering: type: string description: 'The model used to meter data usage. Can be: `payg` and `quota-1`, `quota-10`, and `quota-50`. Learn more about the available [data metering models](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource#payg-vs-quota-data-plans).' MessagingEnabled: type: boolean description: Whether SIMs can make, send, and receive SMS using [Commands](https://www.twilio.com/docs/iot/wireless/api/command-resource). VoiceEnabled: type: boolean description: Deprecated. NationalRoamingEnabled: type: boolean description: Whether SIMs can roam on networks other than the home network (T-Mobile USA) in the United States. See [national roaming](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource#national-roaming). InternationalRoaming: type: array items: type: string description: 'The list of services that SIMs capable of using GPRS/3G/4G/LTE data connectivity can use outside of the United States. Can contain: `data` and `messaging`.' NationalRoamingDataLimit: type: integer description: The total data usage (download and upload combined) in Megabytes that the Network allows during one month on non-home networks in the United States. The metering period begins the day of activation and ends on the same day in the following month. Can be up to 2TB. See [national roaming](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource#national-roaming) for more info. InternationalRoamingDataLimit: type: integer description: The total data usage (download and upload combined) in Megabytes that the Network allows during one month when roaming outside the United States. Can be up to 2TB. DataLimitStrategy: $ref: '#/components/schemas/rate_plan_enum_data_limit_strategy' examples: create: value: UniqueName: unique_name DataEnabled: true DataLimit: 1000 DataMetering: payg MessagingEnabled: true VoiceEnabled: true FriendlyName: friendly_name NationalRoamingEnabled: true InternationalRoaming: - data - voice - messaging NationalRoamingDataLimit: 1000 InternationalRoamingDataLimit: 1000 Status: status /v1/RatePlans/{Sid}: servers: - url: https://wireless.twilio.com description: Capabilities and restrictions for SIMs x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - date_created pathType: instance get: description: '' summary: '' tags: - WirelessV1RatePlan parameters: - name: Sid in: path description: The SID of the RatePlan resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/wireless.v1.rate_plan' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique_name data_enabled: true data_limit: 1000 data_metering: payg date_created: '2019-07-30T20:00:00Z' date_updated: '2019-07-30T20:00:00Z' friendly_name: friendly_name messaging_enabled: true voice_enabled: true national_roaming_enabled: true national_roaming_data_limit: 1000 international_roaming: - data - messaging - voice international_roaming_data_limit: 1000 sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa usage_notification_method: POST usage_notification_url: https://callback.com data_limit_strategy: block url: https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchRatePlan post: description: '' summary: '' tags: - WirelessV1RatePlan parameters: - name: Sid in: path description: The SID of the RatePlan resource to update. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/wireless.v1.rate_plan' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique_name data_enabled: true data_limit: 1000 data_metering: payg date_created: '2019-07-30T20:00:00Z' date_updated: '2019-07-30T20:00:00Z' friendly_name: friendly_name messaging_enabled: true voice_enabled: true national_roaming_enabled: true national_roaming_data_limit: 1000 international_roaming: - data - messaging - voice international_roaming_data_limit: 1000 sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa usage_notification_method: POST usage_notification_url: https://callback.com data_limit_strategy: block url: https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateRatePlan requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateRatePlanRequest properties: UniqueName: type: string description: An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource. FriendlyName: type: string description: A descriptive string that you create to describe the resource. It does not have to be unique. examples: update: value: UniqueName: unique_name FriendlyName: friendly_name UsageNotificationMethod: POST UsageNotificationUrl: https://callback.com delete: description: '' summary: '' tags: - WirelessV1RatePlan parameters: - name: Sid in: path description: The SID of the RatePlan resource to delete. schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteRatePlan /v1/Sims/{Sid}: servers: - url: https://wireless.twilio.com description: A resource representing a Programmable Wireless SIM x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - status dependentProperties: usage_records: mapping: sim_sid: sid resource_url: /v1/Sims/{sim_sid}/UsageRecords data_sessions: mapping: sim_sid: sid resource_url: /v1/Sims/{sim_sid}/DataSessions pathType: instance get: description: Fetch a Sim resource on your Account. summary: Fetch a Sim resource on your Account. tags: - WirelessV1Sim parameters: - name: Sid in: path description: The SID or the `unique_name` of the Sim resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/wireless.v1.sim' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique_name commands_callback_method: POST commands_callback_url: http://www.example.com date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' friendly_name: friendly_name sms_fallback_method: POST sms_fallback_url: http://www.example.com sms_method: POST sms_url: http://www.example.com voice_fallback_method: POST voice_fallback_url: http://www.example.com voice_method: POST voice_url: http://www.example.com links: data_sessions: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions rate_plan: https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa usage_records: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords rate_plan_sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa iccid: iccid e_id: e_id status: new reset_status: null url: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ip_address: 192.168.1.1 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchSim post: description: Updates the given properties of a Sim resource on your Account. summary: Updates the given properties of a Sim resource on your Account. tags: - WirelessV1Sim parameters: - name: Sid in: path description: The SID or the `unique_name` of the Sim resource to update. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/wireless.v1.sim' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique_name commands_callback_method: POST commands_callback_url: http://www.example.com date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' friendly_name: friendly_name links: data_sessions: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions rate_plan: https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa usage_records: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords rate_plan_sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa iccid: iccid e_id: e_id status: new reset_status: null sms_fallback_method: POST sms_fallback_url: http://www.example.com sms_method: POST sms_url: http://www.example.com voice_fallback_method: POST voice_fallback_url: http://www.example.com voice_method: POST voice_url: http://www.example.com url: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ip_address: 192.168.1.30 updateMoveToSubaccount: value: account_sid: ACbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb unique_name: unique_name commands_callback_method: POST commands_callback_url: http://www.example.com date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' friendly_name: friendly_name links: data_sessions: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions rate_plan: https://wireless.twilio.com/v1/RatePlans/WPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb usage_records: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords rate_plan_sid: WPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa iccid: iccid e_id: e_id status: new reset_status: null sms_fallback_method: POST sms_fallback_url: http://www.example.com sms_method: POST sms_url: http://www.example.com voice_fallback_method: POST voice_fallback_url: http://www.example.com voice_method: POST voice_url: http://www.example.com url: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ip_address: 192.168.1.30 updateResetConnectivity: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique_name commands_callback_method: GET commands_callback_url: http://www.example.com date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' friendly_name: friendly_name links: data_sessions: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions rate_plan: https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa usage_records: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords rate_plan_sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa iccid: iccid e_id: e_id status: active reset_status: resetting sms_fallback_method: POST sms_fallback_url: http://www.example.com sms_method: POST sms_url: http://www.example.com voice_fallback_method: POST voice_fallback_url: http://www.example.com voice_method: POST voice_url: http://www.example.com url: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ip_address: 192.168.1.30 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateSim requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateSimRequest properties: UniqueName: type: string description: An application-defined string that uniquely identifies the resource. It can be used in place of the `sid` in the URL path to address the resource. CallbackMethod: type: string format: http-method enum: - GET - POST description: 'The HTTP method we should use to call `callback_url`. Can be: `POST` or `GET`. The default is `POST`.' CallbackUrl: type: string format: uri description: The URL we should call using the `callback_url` when the SIM has finished updating. When the SIM transitions from `new` to `ready` or from any status to `deactivated`, we call this URL when the status changes to an intermediate status (`ready` or `deactivated`) and again when the status changes to its final status (`active` or `canceled`). FriendlyName: type: string description: A descriptive string that you create to describe the Sim resource. It does not need to be unique. RatePlan: type: string description: The SID or unique name of the [RatePlan resource](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource) to which the Sim resource should be assigned. Status: $ref: '#/components/schemas/sim_enum_status' CommandsCallbackMethod: type: string format: http-method enum: - GET - POST description: 'The HTTP method we should use to call `commands_callback_url`. Can be: `POST` or `GET`. The default is `POST`.' CommandsCallbackUrl: type: string format: uri description: The URL we should call using the `commands_callback_method` when the SIM sends a [Command](https://www.twilio.com/docs/iot/wireless/api/command-resource). Your server should respond with an HTTP status code in the 200 range; any response body is ignored. SmsFallbackMethod: type: string format: http-method enum: - GET - POST description: 'The HTTP method we should use to call `sms_fallback_url`. Can be: `GET` or `POST`. Default is `POST`.' SmsFallbackUrl: type: string format: uri description: The URL we should call using the `sms_fallback_method` when an error occurs while retrieving or executing the TwiML requested from `sms_url`. SmsMethod: type: string format: http-method enum: - GET - POST description: 'The HTTP method we should use to call `sms_url`. Can be: `GET` or `POST`. Default is `POST`.' SmsUrl: type: string format: uri description: The URL we should call using the `sms_method` when the SIM-connected device sends an SMS message that is not a [Command](https://www.twilio.com/docs/iot/wireless/api/command-resource). VoiceFallbackMethod: type: string format: http-method enum: - GET - POST description: Deprecated. VoiceFallbackUrl: type: string format: uri description: Deprecated. VoiceMethod: type: string format: http-method enum: - GET - POST description: Deprecated. VoiceUrl: type: string format: uri description: Deprecated. ResetStatus: $ref: '#/components/schemas/sim_enum_reset_status' AccountSid: type: string description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) to which the Sim resource should belong. The Account SID can only be that of the requesting Account or that of a [Subaccount](https://www.twilio.com/docs/iam/api/subaccounts) of the requesting Account. Only valid when the Sim resource's status is `new`. For more information, see the [Move SIMs between Subaccounts documentation](https://www.twilio.com/docs/iot/wireless/api/sim-resource#move-sims-between-subaccounts). examples: update: value: UniqueName: unique_name CallbackMethod: callback_method CallbackUrl: http://www.example.com CommandsCallbackMethod: POST CommandsCallbackUrl: http://www.example.com VoiceMethod: POST VoiceUrl: http://www.example.com VoiceFallbackMethod: POST VoiceFallbackUrl: http://www.example.com SmsMethod: POST SmsUrl: http://www.example.com SmsFallbackMethod: POST SmsFallbackUrl: http://www.example.com FriendlyName: friendly_name RatePlan: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Status: new updateMoveToSubaccount: value: AccountSid: ACbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb UniqueName: unique_name RatePlan: WPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb Status: new updateResetConnectivity: value: ResetStatus: resetting delete: description: Delete a Sim resource on your Account. summary: Delete a Sim resource on your Account. tags: - WirelessV1Sim parameters: - name: Sid in: path description: The SID or the `unique_name` of the Sim resource to delete. schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteSim /v1/Sims: servers: - url: https://wireless.twilio.com description: A resource representing a Programmable Wireless SIM x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - status dependentProperties: usage_records: mapping: sim_sid: sid resource_url: /v1/Sims/{sim_sid}/UsageRecords data_sessions: mapping: sim_sid: sid resource_url: /v1/Sims/{sim_sid}/DataSessions pathType: list get: description: Retrieve a list of Sim resources on your Account. summary: Retrieve a list of Sim resources on your Account. tags: - WirelessV1Sim parameters: - name: Status in: query description: Only return Sim resources with this status. schema: $ref: '#/components/schemas/sim_enum_status' examples: readEmpty: value: new readFull: value: new - name: Iccid in: query description: Only return Sim resources with this ICCID. This will return a list with a maximum size of 1. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 examples: readEmpty: value: iccid readFull: value: iccid - name: RatePlan in: query description: The SID or unique name of a [RatePlan resource](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource). Only return Sim resources assigned to this RatePlan resource. schema: type: string examples: readEmpty: value: rate_plan readFull: value: rate_plan - name: EId in: query description: Deprecated. schema: type: string - name: SimRegistrationCode in: query description: Only return Sim resources with this registration code. This will return a list with a maximum size of 1. schema: type: string - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: sims: type: array items: $ref: '#/components/schemas/wireless.v1.sim' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListSimResponse examples: readEmpty: value: sims: [] meta: first_page_url: https://wireless.twilio.com/v1/Sims?Status=new&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0 key: sims next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://wireless.twilio.com/v1/Sims?Status=new&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0 readFull: value: sims: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique_name commands_callback_method: POST commands_callback_url: http://www.example.com date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' friendly_name: friendly_name links: data_sessions: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DataSessions rate_plan: https://wireless.twilio.com/v1/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa usage_records: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords rate_plan_sid: WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa iccid: iccid e_id: e_id status: new reset_status: resetting sms_fallback_method: POST sms_fallback_url: http://www.example.com sms_method: POST sms_url: http://www.example.com voice_fallback_method: POST voice_fallback_url: http://www.example.com voice_method: POST voice_url: http://www.example.com url: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ip_address: 192.168.1.30 meta: first_page_url: https://wireless.twilio.com/v1/Sims?Status=new&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0 key: sims next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://wireless.twilio.com/v1/Sims?Status=new&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListSim /v1/Sims/{SimSid}/UsageRecords: servers: - url: https://wireless.twilio.com description: Usage information for SIMs x-twilio: defaultOutputProperties: - period parent: /Sims/{Sid} pathType: list get: description: '' summary: '' tags: - WirelessV1UsageRecord parameters: - name: SimSid in: path description: The SID of the [Sim resource](https://www.twilio.com/docs/iot/wireless/api/sim-resource) to read the usage from. schema: type: string required: true - name: End in: query description: Only include usage that occurred on or before this date, specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). The default is the current time. schema: type: string format: date-time examples: fetch: value: '2015-07-30T20:00:00Z' - name: Start in: query description: Only include usage that has occurred on or after this date, specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). The default is one month before the `end` parameter value. schema: type: string format: date-time examples: fetch: value: '2015-07-30T20:00:00Z' - name: Granularity in: query description: 'How to summarize the usage by time. Can be: `daily`, `hourly`, or `all`. The default is `all`. A value of `all` returns one Usage Record that describes the usage for the entire period.' schema: $ref: '#/components/schemas/usage_record_enum_granularity' - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: usage_records: type: array items: $ref: '#/components/schemas/wireless.v1.sim.usage_record' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListUsageRecordResponse examples: fetch: value: usage_records: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa commands: billing_units: USD billed: 0 total: 3 from_sim: 1 to_sim: 2 home: billing_units: USD billed: 0 total: 3 from_sim: 1 to_sim: 2 national_roaming: billing_units: USD billed: 0 total: 0 from_sim: 0 to_sim: 0 international_roaming: [] data: billing_units: USD billed: 0.35 total: 3494609 upload: 731560 download: 2763049 units: bytes home: billing_units: USD billed: 0.35 total: 3494609 upload: 731560 download: 2763049 units: bytes national_roaming: billing_units: USD billed: 0 total: 0 upload: 0 download: 0 units: bytes international_roaming: [] sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa period: start: '2015-07-30T20:00:00Z' end: '2015-07-30T20:00:00Z' - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa commands: {} data: {} sim_sid: DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa period: {} meta: first_page_url: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords?Start=2015-07-30T20%3A00%3A00Z&End=2015-07-30T20%3A00%3A00Z&PageSize=50&Page=0 key: usage_records next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://wireless.twilio.com/v1/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UsageRecords?Start=2015-07-30T20%3A00%3A00Z&End=2015-07-30T20%3A00%3A00Z&PageSize=50&Page=0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListUsageRecord servers: - url: https://wireless.twilio.com tags: - name: WirelessV1Command - name: WirelessV1DataSession - name: WirelessV1Index - name: WirelessV1RatePlan - name: WirelessV1Sim - name: WirelessV1UsageRecord - name: WirelessV1Version security: - accountSid_authToken: []