Twilio · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Twilio Sims API
10 actions
10 updates
phrasing
extends
openapi/twilio-sims-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Twilio's API. It is a proposal applied on top of the contract, not a document Twilio publishes.
What the actions change
x-apievangelist-phrasing
Targets 10
$.info
$.paths['/v1/Sims/{SimSid}/BillingPeriods'].get
$.paths['/v1/Sims'].get
$.paths['/v1/Sims'].post
$.paths['/v1/Sims/{Sid}'].get
$.paths['/v1/Sims/{Sid}'].post
$.paths['/v1/Sims/{Sid}'].delete
$.paths['/v1/Sims/{SimSid}/IpAddresses'].get
$.paths['/v1/Sims/{SimSid}/DataSessions'].get
$.paths['/v1/Sims/{SimSid}/UsageRecords'].get
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Twilio Sims API
version: 1.0.0
extends: openapi/twilio-sims-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 9
- target: $.paths['/v1/Sims/{SimSid}/BillingPeriods'].get
update:
x-apievangelist-phrasing:
intent: List a Super SIM's billing periods
effect: read
questions:
- How do I see the billing periods a Super SIM has been charged for?
- When did the current billing period start for one of my IoT SIMs?
instructions:
- text: List the billing periods for Super SIM {sim}.
slots:
sim: path.SimSid
- text: Show billing history for SIM {sim}, {page_size} periods per page.
slots:
sim: path.SimSid
page_size: query.PageSize
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/Sims'].get
update:
x-apievangelist-phrasing:
intent: List my Super SIMs
effect: read
questions:
- Which of my Super SIMs are active right now?
- Can I find a SIM on my account by its ICCID?
- What SIMs are assigned to a particular fleet?
instructions:
- text: List my Super SIMs with status {status}.
slots:
status: query.Status
- text: Find the SIM with ICCID {iccid}.
slots:
iccid: query.Iccid
- text: Show every SIM in fleet {fleet}.
slots:
fleet: query.Fleet
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/Sims'].post
update:
x-apievangelist-phrasing:
intent: Register a Super SIM to my account
effect: write
questions:
- How do I claim a new Super SIM card I just received?
- What do I need besides the ICCID to register a SIM to my account?
instructions:
- text: Register Super SIM {iccid} with registration code {code}.
slots:
iccid: requestBody.Iccid
code: requestBody.RegistrationCode
- text: Claim the SIM card with ICCID {iccid} using its 10-digit code {code}.
slots:
iccid: requestBody.Iccid
code: requestBody.RegistrationCode
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/Sims/{Sid}'].get
update:
x-apievangelist-phrasing:
intent: Look up a Super SIM
effect: read
questions:
- How do I check the status and fleet of one Super SIM?
- Can I see the details of a single SIM by its SID?
instructions:
- text: Show Super SIM {sim}.
slots:
sim: path.Sid
- text: Tell me which fleet SIM {sim} belongs to and whether it's active.
slots:
sim: path.Sid
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/Sims/{Sid}'].post
update:
x-apievangelist-phrasing:
intent: Activate, move or rename a Super SIM
effect: write
questions:
- Can I activate or deactivate a Super SIM remotely?
- How do I move a SIM into a different fleet?
- Is it possible to transfer a SIM to one of my subaccounts?
instructions:
- text: Set Super SIM {sim} to status {status}.
slots:
sim: path.Sid
status: requestBody.Status
- text: Move SIM {sim} into fleet {fleet}.
slots:
sim: path.Sid
fleet: requestBody.Fleet
- text: Transfer SIM {sim} to account {account} and call {callback_url} when it's done.
slots:
sim: path.Sid
account: requestBody.AccountSid
callback_url: requestBody.CallbackUrl
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/Sims/{Sid}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a SIM from my account
effect: destructive
questions:
- How do I remove a SIM resource from my account entirely?
- Can I delete a SIM using its unique name instead of its SID?
instructions:
- text: Delete SIM {sim} from my account.
slots:
sim: path.Sid
- text: Remove the SIM resource named {sim}.
slots:
sim: path.Sid
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/Sims/{SimSid}/IpAddresses'].get
update:
x-apievangelist-phrasing:
intent: List a Super SIM's IP addresses
effect: read
questions:
- What IP address has my Super SIM been assigned?
- Can I look up the IPs a connected device's SIM is using?
instructions:
- text: List the IP addresses for Super SIM {sim}.
slots:
sim: path.SimSid
- text: Show which IPs device SIM {sim} currently holds.
slots:
sim: path.SimSid
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/Sims/{SimSid}/DataSessions'].get
update:
x-apievangelist-phrasing:
intent: List a SIM's data sessions
effect: read
questions:
- When did my wireless SIM last open a data connection?
- Can I see the data session history of one SIM?
instructions:
- text: List data sessions for SIM {sim}.
slots:
sim: path.SimSid
- text: Show the connection sessions of SIM {sim}, {page_size} per page.
slots:
sim: path.SimSid
page_size: query.PageSize
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/Sims/{SimSid}/UsageRecords'].get
update:
x-apievangelist-phrasing:
intent: Get a SIM's usage records
effect: read
questions:
- How much data and how many commands did a SIM use last month?
- Can I break down a SIM's usage by day or by hour?
instructions:
- text: Show usage for SIM {sim} from {start} to {end}.
slots:
sim: path.SimSid
start: query.Start
end: query.End
- text: Summarize SIM {sim} usage at {granularity} granularity.
slots:
sim: path.SimSid
granularity: query.Granularity
method: generated
generated: '2026-09-26'