Skip to main content
POST
/
sim_card_data_usage_notifications
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const simCardDataUsageNotification = await client.simCardDataUsageNotifications.create({
  sim_card_id: '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
  threshold: {},
});

console.log(simCardDataUsageNotification.data);
{
  "data": {
    "id": "79228acc-3f08-4e70-ac68-cb5aae8b537a",
    "sim_card_id": "b34c1683-cd85-4493-b9a5-315eb4bc5e19",
    "threshold": {
      "amount": "2048.0",
      "unit": "MB"
    },
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.telnyx.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
sim_card_id
string<uuid>
required

The identification UUID of the related SIM card resource.

Example:

"6a09cdc3-8948-47f0-aa62-74ac943d6c58"

​
threshold
object
required

Data usage threshold that will trigger the notification.

Response

Successful Response

​
data
object

The SIM card individual data usage notification information.

Example:
{
  "id": "79228acc-3f08-4e70-ac68-cb5aae8b537a",
  "sim_card_id": "b34c1683-cd85-4493-b9a5-315eb4bc5e19",
  "threshold": { "amount": "2048.0", "unit": "MB" },
  "created_at": "2018-02-02T22:25:27.521Z",
  "updated_at": "2018-02-02T22:25:27.521Z"
}