import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: 'My API Key',
});
const response = await client.simCards.actions.removePublicIP('6a09cdc3-8948-47f0-aa62-74ac943d6c58');
console.log(response.data);{
"data": {
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": "sim_card_action",
"sim_card_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"action_type": "enable",
"status": {
"value": "completed",
"reason": "The data limit was exceeded."
},
"settings": {},
"created_at": "2018-02-02T22:25:27.521Z",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}This API removes an existing public IP from a SIM card.
The API will trigger an asynchronous operation called a SIM Card Action. The status of the SIM Card Action can be followed through the List SIM Card Action API.
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: 'My API Key',
});
const response = await client.simCards.actions.removePublicIP('6a09cdc3-8948-47f0-aa62-74ac943d6c58');
console.log(response.data);{
"data": {
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": "sim_card_action",
"sim_card_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"action_type": "enable",
"status": {
"value": "completed",
"reason": "The data limit was exceeded."
},
"settings": {},
"created_at": "2018-02-02T22:25:27.521Z",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Identifies the SIM.
"6a09cdc3-8948-47f0-aa62-74ac943d6c58"
Successful Response
This object represents a SIM card action. It allows tracking the current status of an operation that impacts the SIM card.
Show child attributes
Identifies the resource.
"6a09cdc3-8948-47f0-aa62-74ac943d6c58"
"sim_card_action"
The related SIM card identifier.
"6a09cdc3-8948-47f0-aa62-74ac943d6c58"
The operation type. It can be one of the following: <br/>
<ul> <li><code>enable</code> - move the SIM card to the <code>enabled</code> status</li> <li><code>enable_standby_sim_card</code> - move a SIM card previously on the <code>standby</code> status to the <code>enabled</code> status after it consumes data.</li> <li><code>disable</code> - move the SIM card to the <code>disabled</code> status</li> <li><code>set_standby</code> - move the SIM card to the <code>standby</code> status</li> </ul>enable, enable_standby_sim_card, disable, set_standby "enable"
Show child attributes
The current status of the SIM card action.
in-progress, completed, failed, interrupted "completed"
It describes why the SIM card action is in the current status. This will be <code>null</code> for self-explanatory statuses, such as <code>in-progress</code> and <code>completed</code> but will include further information on statuses like <code>interrupted</code> and <code>failed</code>.
"The data limit was exceeded."
A JSON object representation of the action params.
{}ISO 8601 formatted date-time indicating when the resource was created.
"2018-02-02T22:25:27.521Z"
ISO 8601 formatted date-time indicating when the resource was updated.
"2018-02-02T22:25:27.521Z"
Was this page helpful?