From telnyx-javascript
Manage S3-compatible Telnyx Storage buckets and objects via JavaScript SDK, including SSL certificate operations for buckets.
npx claudepluginhub team-telnyx/skillsThis skill uses the workspace's default tool permissions.
<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->
Manage S3-compatible Telnyx Storage buckets and objects via JavaScript SDK, including SSL certificate operations for buckets.
Uploads files to Cloudflare R2, AWS S3, or S3-compatible storage via CLI and generates configurable presigned download URLs for secure sharing.
Guides AWS S3 bucket creation, object operations, versioning, encryption, public access control, lifecycle policies, and storage classes using CLI and boto3.
Share bugs, ideas, or general feedback.
npm install telnyx
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
All examples below assume client is already initialized as shown above.
All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:
try {
const result = await client.messages.send({ to: '+13125550001', from: '+13125550002', text: 'Hello' });
} catch (err) {
if (err instanceof Telnyx.APIConnectionError) {
console.error('Network error — check connectivity and retry');
} else if (err instanceof Telnyx.RateLimitError) {
// 429: rate limited — wait and retry with exponential backoff
const retryAfter = err.headers?.['retry-after'] || 1;
await new Promise(r => setTimeout(r, retryAfter * 1000));
} else if (err instanceof Telnyx.APIError) {
console.error(`API error ${err.status}: ${err.message}`);
if (err.status === 422) {
console.error('Validation error — check required fields and formats');
}
}
}
Common error codes: 401 invalid API key, 403 insufficient permissions,
404 resource not found, 422 validation error (check field formats),
429 rate limited (retry with exponential backoff).
Returns the stored certificate detail of a bucket, if applicable.
GET /storage/buckets/{bucketName}/ssl_certificate
const sslCertificate = await client.storage.buckets.sslCertificate.retrieve('');
console.log(sslCertificate.data);
Returns: created_at (date-time), id (string), issued_by (object), issued_to (object), valid_from (date-time), valid_to (date-time)
Uploads an SSL certificate and its matching secret so that you can use Telnyx's storage as your CDN.
PUT /storage/buckets/{bucketName}/ssl_certificate
const sslCertificate = await client.storage.buckets.sslCertificate.create('');
console.log(sslCertificate.data);
Returns: created_at (date-time), id (string), issued_by (object), issued_to (object), valid_from (date-time), valid_to (date-time)
Deletes an SSL certificate and its matching secret.
DELETE /storage/buckets/{bucketName}/ssl_certificate
const sslCertificate = await client.storage.buckets.sslCertificate.delete('');
console.log(sslCertificate.data);
Returns: created_at (date-time), id (string), issued_by (object), issued_to (object), valid_from (date-time), valid_to (date-time)
Returns the detail on API usage on a bucket of a particular time period, group by method category.
GET /storage/buckets/{bucketName}/usage/api
const response = await client.storage.buckets.usage.getAPIUsage('', {
filter: { end_time: '2019-12-27T18:11:19.117Z', start_time: '2019-12-27T18:11:19.117Z' },
});
console.log(response.data);
Returns: categories (array[object]), timestamp (date-time), total (object)
Returns the amount of storage space and number of files a bucket takes up.
GET /storage/buckets/{bucketName}/usage/storage
const response = await client.storage.buckets.usage.getBucketUsage('');
console.log(response.data);
Returns: num_objects (integer), size (integer), size_kb (integer), timestamp (date-time)
Returns a timed and authenticated URL to download (GET) or upload (PUT) an object. This is the equivalent to AWS S3’s “presigned” URL. Please note that Telnyx performs authentication differently from AWS S3 and you MUST NOT use the presign method of AWS s3api CLI or SDK to generate the presigned URL.
Refer to: https://developers.telnyx.com/docs/cloud-storage/presigned-urls
POST /storage/buckets/{bucketName}/{objectName}/presigned_url
Optional: ttl (integer)
const response = await client.storage.buckets.createPresignedURL('', { bucketName: '' });
console.log(response.content);
Returns: content (object)