Get a Wireless Blocklist

GET 
/wireless_blocklists/:id

Retrieve information about a Wireless Blocklist.

Path Parameters

id uuidrequired

Identifies the wireless blocklist.

200: Successful Response

application/json

• Schema
• Example (from schema)

Schema

data

object

id uuid

Identifies the resource.

record_type string

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.

name string

The wireless blocklist name.

type string

Possible values: [country, mcc, plmn]

Default value: country

The type of the wireless blocklist.

values

object[]

Values to block. The values here depend on the type of Wireless Blocklist.

Array [

oneOf

• CountryCode
• MobileCountryCode
• PLMNCode

ISO 3166-1 Alpha-2 Country Code.

string

Mobile Country Code.

string

Public land mobile network code (MCC + MNC).

string

]

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "wireless_blocklist",
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "name": "My wireless blocklist.",
    "type": "country",
    "values": [
      "CA",
      "MX",
      "US"
    ]
  }
}

404: Resource not found

application/json

• Schema
• Example (from schema)

Schema

code stringrequired
title stringrequired
detail string

source

object

pointer string

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta

object

property name* any

{
  "code": "string",
  "title": "string",
  "detail": "string",
  "source": {
    "pointer": "string",
    "parameter": "string"
  },
  "meta": {}
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

Array [

code stringrequired

title stringrequired

detail string

source

object

pointer string

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta

object

property name* any

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Request samples

• cURL

---

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

Response samples

• 200
• 404
• default

---

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "wireless_blocklist",
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "name": "My wireless blocklist.",
    "type": "country",
    "values": [
      "CA",
      "MX",
      "US"
    ]
  }
}

{
  "code": "string",
  "title": "string",
  "detail": "string",
  "source": {
    "pointer": "string",
    "parameter": "string"
  },
  "meta": {}
}

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}