Manage regulatory requirements, number bundles, supporting documents, and verified numbers for compliance. This skill provides JavaScript SDK examples.
日本語の概要は準備中です。原文の説明を表示しています。
実行スコア 未検証
インストール方法を見るインストールする前に、エージェントに与えられる指示の中身を確認できます。
npm install telnyx@6.74.2
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
publicKey: process.env['TELNYX_PUBLIC_KEY'], // Required for client.webhooks.unwrap() (webhook verification)
});
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, then retry the request (bounded exponential backoff)
const retryAfter = err.headers?.['retry-after'] || 1;
await new Promise(r => setTimeout(r, retryAfter * 1000));
// ...retry the call here (give up after a few attempts)
} 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');
}
}
throw err; // Re-throw: a failed request must never look like success to the caller
}
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).
+13125550001). Include the + prefix and country code. No spaces, dashes, or parentheses.for await (const item of result) { ... } to iterate through all pages automatically.Returns a paginated list of the billing bundles available to your account, with support for filtering.
GET /bundle_pricing/billing_bundles
// Automatically fetches more pages as needed.
for await (const billingBundleSummary of client.bundlePricing.billingBundles.list()) {
console.log(billingBundleSummary.id);
}
Returns: cost_code (string), created_at (date), currency (string), id (uuid), is_public (boolean), mrc_price (float), name (string), slug (string), specs (array[string])
Returns the details of a single billing bundle by its ID, so you can inspect its contents before purchasing a user bundle.
GET /bundle_pricing/billing_bundles/{bundle_id}
const billingBundle = await client.bundlePricing.billingBundles.retrieve(
'8661948c-a386-4385-837f-af00f40f111a',
);
console.log(billingBundle.data);
Returns: active (boolean), bundle_limits (array[object]), cost_code (string), created_at (date), id (uuid), is_public (boolean), name (string), slug (string)
Returns a paginated list of the bundles active on your account, with support for filtering.
GET /bundle_pricing/user_bundles
// Automatically fetches more pages as needed.
for await (const userBundle of client.bundlePricing.userBundles.list()) {
console.log(userBundle.id);
}
Returns: active (boolean), billing_bundle (object), created_at (date), id (uuid), resources (array[object]), updated_at (date), user_id (uuid)
Creates multiple user bundles for the user.
POST /bundle_pricing/user_bundles/bulk
Optional: idempotency_key (uuid), items (array[object])
const userBundle = await client.bundlePricing.userBundles.create();
console.log(userBundle.data);
Returns: active (boolean), billing_bundle (object), created_at (date), id (uuid), resources (array[object]), updated_at (date), user_id (uuid)
Returns all user bundles that aren't in use.
GET /bundle_pricing/user_bundles/unused
const response = await client.bundlePricing.userBundles.listUnused();
console.log(response.data);
Returns: billing_bundle (object), user_bundle_ids (array[string])
Returns the details of a single user bundle on your account by its ID.
GET /bundle_pricing/user_bundles/{user_bundle_id}
const userBundle = await client.bundlePricing.userBundles.retrieve(
'ca1d2263-d1f1-43ac-ba53-248e7a4bb26a',
);
console.log(userBundle.data);
Returns: active (boolean), billing_bundle (object), created_at (date), id (uuid), resources (array[object]), updated_at (date), user_id (uuid)
Deactivates the specified user bundle on your account and returns the deactivated bundle.
DELETE /bundle_pricing/user_bundles/{user_bundle_id}
const response = await client.bundlePricing.userBundles.deactivate(
'ca1d2263-d1f1-43ac-ba53-248e7a4bb26a',
);
console.log(response.data);
Returns: active (boolean), billing_bundle (object), created_at (date), id (uuid), resources (array[object]), updated_at (date), user_id (uuid)
Retrieves the resources of a user bundle by its ID.
GET /bundle_pricing/user_bundles/{user_bundle_id}/resources
const response = await client.bundlePricing.userBundles.listResources(
'ca1d2263-d1f1-43ac-ba53-248e7a4bb26a',
);
console.log(response.data);
Returns: created_at (date), id (uuid), resource (string), resource_type (string), updated_at (date)
List all documents links ordered by created_at descending.
GET /document_links
// Automatically fetches more pages as needed.
for await (const documentLinkListResponse of client.documentLinks.list()) {
console.log(documentLinkListResponse.id);
}
Returns: created_at (string), document_id (uuid), id (uuid), linked_record_type (string), linked_resource_id (string), record_type (string), updated_at (string)
List all documents ordered by created_at descending.
GET /documents
// Automatically fetches more pages as needed.
for await (const docServiceDocument of client.documents.list()) {
console.log(docServiceDocument.id);
}
Returns: av_scan_status (enum: scanned, infected, pending_scan, not_scanned), content_type (string), created_at (string), customer_reference (string), filename (string), id (uuid), record_type (string), sha256 (string), size (object), status (enum: pending, verified, denied), updated_at (string)
Upload a document. Uploaded files must be linked to a service within 30 minutes or they will be automatically deleted.
POST /documents
Optional: customer_reference (string), file (byte), filename (string), url (string)
const response = await client.documents.uploadJson({ document: {} });
console.log(response.data);
Returns: av_scan_status (enum: scanned, infected, pending_scan, not_scanned), content_type (string), created_at (string), customer_reference (string), filename (string), id (uuid), record_type (string), sha256 (string), size (object), status (enum: pending, verified, denied), updated_at (string)
Returns the details of a single document on your account, including its metadata.
GET /documents/{id}
const document = await client.documents.retrieve('6a09cdc3-8948-47f0-aa62-74ac943d6c58');
console.log(document.data);
Returns: av_scan_status (enum: scanned, infected, pending_scan, not_scanned), content_type (string), created_at (string), customer_reference (string), filename (string), id (uuid), record_type (string), sha256 (string), size (object), status (enum: pending, verified, denied), updated_at (string)
Updates the specified document's attributes and returns the updated document.
PATCH /documents/{id}
Optional: av_scan_status (enum: scanned, infected, pending_scan, not_scanned), content_type (string), created_at (string), customer_reference (string), filename (string), id (uuid), record_type (string), sha256 (string), size (object), status (enum: pending, verified, denied), updated_at (string)
const document = await client.documents.update('6a09cdc3-8948-47f0-aa62-74ac943d6c58');
console.log(document.data);
Returns: av_scan_status (enum: scanned, infected, pending_scan, not_scanned), content_type (string), created_at (string), customer_reference (string), filename (string), id (uuid), record_type (string), sha256 (string), size (object), status (enum: pending, verified, denied), updated_at (string)
Delete a document. A document can only be deleted if it's not linked to a service. If it is linked to a service, it must be unlinked prior to deleting.
DELETE /documents/{id}
const document = await client.documents.delete('6a09cdc3-8948-47f0-aa62-74ac943d6c58');
console.log(document.data);
Returns: av_scan_status (enum: scanned, infected, pending_scan, not_scanned), content_type (string), created_at (string), customer_reference (string), filename (string), id (uuid), record_type (string), sha256 (string), size (object), status (enum: pending, verified, denied), updated_at (string)
Downloads the raw file content of the specified document as originally uploaded.
GET /documents/{id}/download
const response = await client.documents.download('6a09cdc3-8948-47f0-aa62-74ac943d6c58');
console.log(response);
const content = await response.blob();
console.log(content);
Generates a temporary pre-signed URL that can be used to download the document directly from the storage backend without authentication.
GET /documents/{id}/download_link
const response = await client.documents.generateDownloadLink(
'550e8400-e29b-41d4-a716-446655440000',
);
console.log(response.data);
Returns: url (uri)
Returns the input fields an action requirement needs and the current requirement action for a sub number order. Action requirements are fulfilled by an external step rather than by uploading documents. Australia mobile ID verification is currently the only action requirement.
GET /external_requirements/{regulatory_requirement_id}/sub_number_orders/{sub_number_order_id}
const response = await client.externalRequirements.subNumberOrders.retrieve('regulatory_requirement_id', 'sub_number_order_id');
console.log(response.data);
Returns: fields_required (array[object]), regulatory_requirement_id (uuid), requirement_action (object)
Submits the end user's details to the external verification provider and returns the requirement action. Australia mobile ID verification is currently the only action requirement. It generates a unique Onfido verification link, returned in requirement_action.value, which you share with the end user.
POST /external_requirements/{regulatory_requirement_id}/sub_number_orders/{sub_number_order_id} — Required: requirement
const response = await client.externalRequirements.subNumberOrders.update('regulatory_requirement_id', 'sub_number_order_id', {
requirement: {},
});
console.log(response.data);
Returns: regulatory_requirement_id (uuid), requirement_action (object), sub_order_id (uuid)
Associates an existing requirement group with a phone number in a number order. The response contains the updated number-order phone-number details.
POST /number_order_phone_numbers/{id}/requirement_group — Required: requirement_group_id
const response = await client.numberOrderPhoneNumbers.updateRequirementGroup(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
{ requirement_group_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
);
console.log(response.data);
Returns: bundle_id (uuid), country_code (string), deadline (date-time), id (uuid), is_block_number (boolean), locality (string), order_request_id (uuid), phone_number (string), phone_number_type (string), record_type (string), regulatory_requirements (array[object]), requirements_met (boolean), requirements_status (string), status (string), sub_number_order_id (uuid)
Returns the regulatory requirements that apply to the supplied comma-separated phone numbers. The response includes the matching requirement records and pagination metadata.
GET /phone_numbers_regulatory_requirements
const phoneNumbersRegulatoryRequirement =
await client.phoneNumbersRegulatoryRequirements.retrieve();
console.log(phoneNumbersRegulatoryRequirement.data);
Returns: phone_number (string), phone_number_type (string), record_type (string), region_information (array[object]), regulatory_requirements (array[object])
Returns regulatory requirements for number ordering, porting, or other supported actions. Results can be filtered by phone number, requirement group, country, number type, and action.
GET /regulatory_requirements
const regulatoryRequirement = await client.regulatoryRequirements.retrieve();
console.log(regulatoryRequirement.data);
Returns: action (string), country_code (string), phone_number_type (string), regulatory_requirements (array[object])
Returns regulatory requirement groups for the account. Results can be filtered by country, number type, action, approval status, and customer reference.
GET /requirement_groups
const requirementGroups = await client.requirementGroups.list();
console.log(requirementGroups);
Creates a regulatory requirement group for a country, number type, and ordering or porting action. Optional customer-reference and requirement values are retained on the created group.
POST /requirement_groups — Required: country_code, phone_number_type, action
Optional: customer_reference (string), regulatory_requirements (array[object])
const requirementGroup = await client.requirementGroups.create({
action: 'ordering',
country_code: 'US',
phone_number_type: 'local',
});
console.log(requirementGroup.id);
Returns: action (string), country_code (string), created_at (date-time), customer_reference (string), id (string), phone_number_type (string), record_type (string), regulatory_requirements (array[object]), status (enum: approved, unapproved, pending-approval, declined, expired), updated_at (date-time)
Returns the regulatory requirement group identified by id, including its requirement values and current approval status.
GET /requirement_groups/{id}
const requirementGroup = await client.requirementGroups.retrieve('550e8400-e29b-41d4-a716-446655440000');
console.log(requirementGroup.id);
Returns: action (string), country_code (string), created_at (date-time), customer_reference (string), id (string), phone_number_type (string), record_type (string), regulatory_requirements (array[object]), status (enum: approved, unapproved, pending-approval, declined, expired), updated_at (date-time)
Updates the customer reference or regulatory requirement values on the specified requirement group. The response contains the updated group.
PATCH /requirement_groups/{id}
Optional: customer_reference (string), regulatory_requirements (array[object])
const requirementGroup = await client.requirementGroups.update('550e8400-e29b-41d4-a716-446655440000');
console.log(requirementGroup.id);
Returns: action (string), country_code (string), created_at (date-time), customer_reference (string), id (string), phone_number_type (string), record_type (string), regulatory_requirements (array[object]), status (enum: approved, unapproved, pending-approval, declined, expired), updated_at (date-time)
Deletes the regulatory requirement group identified by id. The response contains the deleted requirement-group representation.
DELETE /requirement_groups/{id}
const requirementGroup = await client.requirementGroups.delete('550e8400-e29b-41d4-a716-446655440000');
console.log(requirementGroup.id);
Returns: action (string), country_code (string), created_at (date-time), customer_reference (string), id (string), phone_number_type (string), record_type (string), regulatory_requirements (array[object]), status (enum: approved, unapproved, pending-approval, declined, expired), updated_at (date-time)
Submits the specified regulatory requirement group for approval. The response contains the requirement group with its resulting approval status.
POST /requirement_groups/{id}/submit_for_approval
const requirementGroup = await client.requirementGroups.submitForApproval('550e8400-e29b-41d4-a716-446655440000');
console.log(requirementGroup.id);
Returns: action (string), country_code (string), created_at (date-time), customer_reference (string), id (string), phone_number_type (string), record_type (string), regulatory_requirements (array[object]), status (enum: approved, unapproved, pending-approval, declined, expired), updated_at (date-time)
List all requirement types ordered by created_at descending
GET /requirement_types
const requirementTypes = await client.requirementTypes.list();
console.log(requirementTypes.data);
Returns: acceptance_criteria (object), created_at (string), description (string), example (string), id (uuid), name (string), record_type (string), type (enum: document, address, textual), updated_at (string)
Returns the details of a single requirement type by its identifier, describing a kind of documentation needed for regulatory purposes.
GET /requirement_types/{id}
const requirementType = await client.requirementTypes.retrieve(
'a38c217a-8019-48f8-bff6-0fdd9939075b',
);
console.log(requirementType.data);
Returns: acceptance_criteria (object), created_at (string), description (string), example (string), id (uuid), name (string), record_type (string), type (enum: document, address, textual), updated_at (string)
List all requirements with filtering, sorting, and pagination
GET /requirements
// Automatically fetches more pages as needed.
for await (const requirementListResponse of client.requirements.list()) {
console.log(requirementListResponse.id);
}
Returns: action (enum: both, branded_calling, ordering, porting), country_code (string), created_at (string), effective_end_at (date-time), effective_start_at (date-time), id (uuid), locality (string), phone_number_type (enum: local, mobile, multipurpose, national, shared_cost, toll_free), record_type (string), requirement_types (array[object]), updated_at (string), version (integer)
Returns a single document requirement record by its identifier, describing the documentation needed for number-related actions. A specific requirement version can be requested.
GET /requirements/{id}
const requirement = await client.requirements.retrieve('a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaa');
console.log(requirement.data);
Returns: action (enum: both, branded_calling, ordering, porting), country_code (string), created_at (string), effective_end_at (date-time), effective_start_at (date-time), id (uuid), locality (string), phone_number_type (enum: local, mobile, multipurpose, national, shared_cost, toll_free), record_type (string), requirement_types (array[object]), updated_at (string), version (integer)
Associates an existing requirement group with the specified sub number order. The response contains the updated sub number order requirement-group relationship.
POST /sub_number_orders/{id}/requirement_group — Required: requirement_group_id
const response = await client.subNumberOrders.updateRequirementGroup(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
{ requirement_group_id: 'a4b201f9-8646-4e54-a7d2-b2e403eeaf8c' },
);
console.log(response.data);
Returns: country_code (string), created_at (date-time), customer_reference (string), id (uuid), is_block_sub_number_order (boolean), order_request_id (uuid), phone_number_type (string), phone_numbers (array[object]), phone_numbers_count (integer), record_type (string), regulatory_requirements (array[object]), requirements_met (boolean), status (string), updated_at (date-time)
Returns a paginated list of your user addresses, with support for filtering and sorting.
GET /user_addresses
// Automatically fetches more pages as needed.
for await (const userAddress of client.userAddresses.list()) {
console.log(userAddress.id);
}
Returns: administrative_area (string), borough (string), business_name (string), country_code (string), created_at (string), customer_reference (string), extended_address (string), first_name (string), id (uuid), last_name (string), locality (string), neighborhood (string), phone_number (string), postal_code (string), record_type (string), street_address (string), updated_at (string)
Creates a new user address from the provided details and returns the created address.
POST /user_addresses — Required: first_name, last_name, business_name, street_address, locality, country_code
Optional: administrative_area (string), borough (string), customer_reference (string), extended_address (string), neighborhood (string), phone_number (string), postal_code (string), skip_address_verification (boolean)
const userAddress = await client.userAddresses.create({
business_name: "Toy-O'Kon",
country_code: 'US',
first_name: 'Alfred',
last_name: 'Foster',
locality: 'Austin',
street_address: '600 Congress Avenue',
});
console.log(userAddress.data);
Returns: administrative_area (string), borough (string), business_name (string), country_code (string), created_at (string), customer_reference (string), extended_address (string), first_name (string), id (uuid), last_name (string), locality (string), neighborhood (string), phone_number (string), postal_code (string), record_type (string), street_address (string), updated_at (string)
Retrieves the details of an existing user address.
GET /user_addresses/{id}
const userAddress = await client.userAddresses.retrieve('550e8400-e29b-41d4-a716-446655440000');
console.log(userAddress.data);
Returns: administrative_area (string), borough (string), business_name (string), country_code (string), created_at (string), customer_reference (string), extended_address (string), first_name (string), id (uuid), last_name (string), locality (string), neighborhood (string), phone_number (string), postal_code (string), record_type (string), street_address (string), updated_at (string)
Gets a paginated list of Verified Numbers.
GET /verified_numbers
// Automatically fetches more pages as needed.
for await (const verifiedNumber of client.verifiedNumbers.list()) {
console.log(verifiedNumber.phone_number);
}
Returns: phone_number (string), record_type (enum: verified_number), verified_at (string)
Initiates phone number verification procedure. Supports DTMF extension dialing for voice calls to numbers behind IVR systems.
POST /verified_numbers — Required: phone_number, verification_method
Optional: extension (string)
const verifiedNumber = await client.verifiedNumbers.create({
phone_number: '+15551234567',
verification_method: 'sms',
});
console.log(verifiedNumber.phone_number);
Returns: phone_number (string), verification_method (string)
Retrieve the details of a verified number on your account.
GET /verified_numbers/{phone_number}
const verifiedNumberDataWrapper = await client.verifiedNumbers.retrieve('+15551234567');
console.log(verifiedNumberDataWrapper.data);
Returns: phone_number (string), record_type (enum: verified_number), verified_at (string)
Remove a verified number from your account.
DELETE /verified_numbers/{phone_number}
const verifiedNumberDataWrapper = await client.verifiedNumbers.delete('+15551234567');
console.log(verifiedNumberDataWrapper.data);
Returns: phone_number (string), record_type (enum: verified_number), verified_at (string)
Submit the verification code received via the selected verification method to verify a phone number.
POST /verified_numbers/{phone_number}/actions/verify — Required: verification_code
const verifiedNumberDataWrapper = await client.verifiedNumbers.actions.submitVerificationCode(
'+15551234567',
{ verification_code: '123456' },
);
console.log(verifiedNumberDataWrapper.data);
Returns: phone_number (string), record_type (enum: verified_number), verified_at (string)
まだレビューはありません。使ってみた感想をお寄せください。
ログインなしで書き込めます。使ってみた感想、質問、動かなかった環境などを気軽にどうぞ。
まだコメントはありません。最初のコメントを書いてみませんか。
Test VoIP push notifications for Telnyx WebRTC iOS (APNs) and Android (FCM) apps. Use when debugging push notification delivery, validating certificate/credential setup, or testing that a device receives VoIP pushes correctly.
日本語の概要は準備中です。原文の説明を表示しています。
10DLC brand and campaign registration for US A2P messaging compliance. Assign phone numbers to campaigns.
日本語の概要は準備中です。原文の説明を表示しています。
10DLC brand and campaign registration for US A2P messaging compliance. Assign phone numbers to campaigns.
日本語の概要は準備中です。原文の説明を表示しています。
10DLC brand and campaign registration for US A2P messaging compliance. Assign phone numbers to campaigns.
日本語の概要は準備中です。原文の説明を表示しています。
10DLC brand and campaign registration for US A2P messaging compliance. Assign phone numbers to campaigns.
日本語の概要は準備中です。原文の説明を表示しています。
10DLC brand and campaign registration for US A2P messaging compliance. Assign phone numbers to campaigns.
日本語の概要は準備中です。原文の説明を表示しています。