Skip to main content

List wireless connectivity logs

GET 
/sim_cards/:sim_card_id/wireless_connectivity_logs

This API allows listing a paginated collection of Wireless Connectivity Logs associated with a SIM Card, for troubleshooting purposes.

Request​

Path Parameters

    sim_card_id uuidrequired

    Identifies a SIM card.

Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load.

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page.

Responses​

200: Successful response

Schema

    data

    object[]

  • Array [

    • record_type string
    id integer

    Uniquely identifies the session.

    sim_card_id uuid

    The identification UUID of the related SIM card resource.

    log_type string

    Possible values: [registration, data]

    The type of the session, 'registration' being the initial authentication session and 'data' the actual data transfer sessions.

    imsi string

    SIM cards are identified on their individual network operators by a unique International Mobile Subscriber Identity (IMSI).
    Mobile network operators connect mobile phone calls and communicate with their market SIM cards using their IMSIs. The IMSI is stored in the Subscriber Identity Module (SIM) inside the device and is sent by the device to the appropriate network. It is used to acquire the details of the device in the Home Location Register (HLR) or the Visitor Location Register (VLR).

    imei string

    The International Mobile Equipment Identity (or IMEI) is a number, usually unique, that identifies the device currently being used connect to the network.

    mobile_country_code string

    It's a three decimal digit that identifies a country.

    This code is commonly seen joined with a Mobile Network Code (MNC) in a tuple that allows identifying a carrier known as PLMN (Public Land Mobile Network) code.

    mobile_network_code string

    It's a two to three decimal digits that identify a network.

    This code is commonly seen joined with a Mobile Country Code (MCC) in a tuple that allows identifying a carrier known as PLMN (Public Land Mobile Network) code.

    start_time string

    ISO 8601 formatted date-time indicating when the session started.

    stop_time string

    ISO 8601 formatted date-time indicating when the session ended.

    created_at string

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

    last_seen string

    ISO 8601 formatted date-time indicating when the last heartbeat to the device was successfully recorded.

    apn string

    The Access Point Name (APN) identifies the packet data network that a mobile data user wants to communicate with.

    ipv4 string

    The SIM's address in the currently connected network. This IPv4 address is usually obtained dynamically, so it may vary according to the location or new connections.

    ipv6 string

    The SIM's address in the currently connected network. This IPv6 address is usually obtained dynamically, so it may vary according to the location or new connections.

    radio_access_technology string

    The radio technology the SIM card used during the session.

    state string

    The state of the SIM card after when the session happened.

    cell_id string

    The cell ID to which the SIM connected.

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

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

  • ]

Request samples

curl -L 'https://api.telnyx.com/v2/sim_cards/:sim_card_id/wireless_connectivity_logs' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "data": [
    {
      "record_type": "wireless_connectivity_log",
      "id": 137509451,
      "sim_card_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "log_type": "registration",
      "imsi": "081932214823362973",
      "imei": "490154203237518",
      "mobile_country_code": "310",
      "mobile_network_code": "410",
      "start_time": "2018-02-02T22:25:27.521Z",
      "stop_time": "2018-02-02T22:25:27.521Z",
      "created_at": "2018-02-02T22:25:27.521Z",
      "last_seen": "2018-02-02T22:25:27.521Z",
      "apn": "data00.telnyx",
      "ipv4": "192.168.0.0",
      "ipv6": "2001:cdba:0000:0000:0000:0000:3257:9652",
      "radio_access_technology": "LTE",
      "state": "provisioned",
      "cell_id": "311210-6813"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}