Skip to main content

Request Private Wireless Gateway assignment for SIM card group

POST 

/sim_card_groups/:id/actions/set_private_wireless_gateway

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.

Request

Path Parameters

    id uuidrequired

    Identifies the resource.

Body

required

    private_wireless_gateway_id uuidrequired

    The identification of the related Private Wireless Gateway resource.

Responses

202: Successful Response

Schema

    data

    object

    This object represents a SIM card group action request. It allows tracking the current status of an operation that impacts the SIM card group and SIM card in it.

    id uuid

    Identifies the resource.

    record_type string
    sim_card_group_id uuid

    The SIM card group identification.

    type string

    Possible values: [set_private_wireless_gateway, remove_private_wireless_gateway]

    Represents the type of the operation requested.

    status string

    Possible values: [in-progress, completed, failed]

    settings

    object

    A JSON object representation of the action params.

    private_wireless_gateway_id uuid

    The identification of the related Private Wireless Gateway resource.

    created_at string

    ISO 8601 formatted date-time indicating when the resource was created.

    updated_at string

    ISO 8601 formatted date-time indicating when the resource was updated.

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

  • code intrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object
  • ]

Loading...