Register SIM card

POST 
/wireless/sim_cards/actions/register

Register a SIM card code.

application/json

Body

required

SIM card update request

registration_codes string[]

A list of SIM card registration codes.

sim_card_group_id uuid

The SIM card group to which the provided SIM cards should be associated with after registration. If no ID is provided then the SIM cards will be registered to the default SIM card group.

tags string[]

A list of tags to be applied to the SIM cards after registration.

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object

failed_registrations string[]

successful_registrations string[]

{
  "data": {
    "failed_registrations": [
      "string"
    ],
    "successful_registrations": [
      "string"
    ]
  }
}

401: Authentication error

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

Array [

code string

an application-specific error code, expressed as a stringified integer.

title string

a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

detail string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

pointer string

JSON pointer to the field which is causing the error.

]

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}

403: Authorization error

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

Array [

code string

an application-specific error code, expressed as a stringified integer.

title string

a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

detail string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

pointer string

JSON pointer to the field which is causing the error.

]

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/wireless/sim_cards/actions/register' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "registration_codes": [
    "string"
  ],
  "sim_card_group_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tags": [
    "string"
  ]
}'

Response samples

• 200
• 401
• 403

---

{
  "data": {
    "failed_registrations": [
      "string"
    ],
    "successful_registrations": [
      "string"
    ]
  }
}

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}