Skip to main content
POST
/
actions
/
register
/
sim_cards
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const register = await client.actions.register.create({
  registration_codes: ['0000000001', '0000000002', '0000000003'],
});

console.log(register.data);
{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "sim_card",
      "status": {
        "value": "enabled",
        "reason": "The SIM card is active, ready to connect to networks and consume data."
      },
      "type": "physical",
      "iccid": "89310410106543789301",
      "imsi": "081932214823362973",
      "msisdn": "+13109976224",
      "sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "tags": [
        "personal",
        "customers",
        "active-customers"
      ],
      "data_limit": {
        "amount": "2048.0",
        "unit": "MB"
      },
      "current_billing_period_consumed_data": {
        "amount": "2049.0",
        "unit": "MB"
      },
      "actions_in_progress": true,
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z",
      "esim_installation_status": "released",
      "version": "4.3",
      "resources_with_in_progress_actions": [],
      "eid": null,
      "authorized_imeis": [
        "106516771852751",
        "534051870479563",
        "508821468377961"
      ]
    }
  ],
  "errors": [
    {
      "code": "<string>",
      "title": "<string>",
      "detail": "<string>",
      "source": {
        "pointer": "<string>",
        "parameter": "<string>"
      },
      "meta": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
registration_codes
string[]
required
Example:
["0000000001", "0000000002", "0000000003"]
sim_card_group_id
string<uuid>

The group SIMCardGroup identification. This attribute can be null when it's present in an associated resource.

Example:

"6a09cdc3-8948-47f0-aa62-74ac943d6c58"

tags
string[]

Searchable tags associated with the SIM card

Example:
["personal", "customers", "active-customers"]
status
enum<string>
default:enabled

Status on which the SIM card will be set after being successful registered.

Available options:
enabled,
disabled,
standby
Example:

"standby"

Response

Successful response

data
SIMCard · object[]

Successfully registered SIM cards.

errors
object[]