SIM Card Groups

Request Private Wireless Gateway assignment for SIM card group

Changed on

This action will asynchronously assign a provisioned Private Wireless Gateway to the SIM card group. Completing this operation defines that all SIM cards in the SIM card group will get their traffic controlled by the associated Private Wireless Gateway. This operation will also imply that new SIM cards assigned to a group will inherit its network definitions. If it's moved to a different group that doesn't have a Private Wireless Gateway, it'll use Telnyx's default mobile network configuration.

post/sim_card_groups/{id}/actions/set_private_wireless_gateway

Request

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

Path parameters

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

Identifies the SIM group.

Request body

private_wireless_gateway_idstring uuid required

The identification of the related Private Wireless Gateway resource.

Example request

{
  "private_wireless_gateway_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
}

Response

Successful Response

Example response

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "sim_card_group_action",
    "sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "type": "set_private_wireless_gateway",
    "status": "in-progress",
    "settings": {
      "private_wireless_gateway_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "wireless_blocklist_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
    },
    "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

    • info

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