SIM Cards

Request setting a SIM card to standby

Changed on

The SIM card will be able to connect to the network once the process to set it to standby has been completed, thus making it possible to consume data.<br/> To set a SIM card to standby, it must be associated with SIM card group.<br/> The API will trigger an asynchronous operation called a SIM Card Action. Transitioning to the standby state may take a period of time. The status of the SIM Card Action can be followed through the List SIM Card Action API.

post/sim_cards/{id}/actions/set_standby

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/sim_cards/{id}/actions/set_standby
  • Auth: HTTP bearer

Path parameters

idstring uuid required
Example:6a09cdc3-8948-47f0-aa62-74ac943d6c58

Identifies the SIM.

Response

Action accepted. The response contains a SIM card action; poll GET /sim_card_actions/{id} with the action id to track progress.

Example response

{
  "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"
  }
}

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status