免费在 GitHub 公开

telnyx-messaging-hosted-javascript

Set up hosted SMS numbers, toll-free verification, and RCS messaging. Use when migrating numbers or enabling rich messaging features. This skill provides JavaScript SDK examples.

中文简介正在准备中。当前显示原文说明。

team-telnyx/ai

集成工具X (Twitter)

查看安装方法

包含的文件（1）

SKILL.md22.8 KB

SKILL.md（原文）

安装前可以查看交给 AI 代理的指令内容。

Telnyx Messaging Hosted - JavaScript

Installation

npm install telnyx@6.74.2

Setup

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.

Error Handling

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).

Important Notes

Phone numbers must be in E.164 format (e.g., +13125550001). Include the + prefix and country code. No spaces, dashes, or parentheses.
Pagination: List methods return an auto-paginating iterator. Use for await (const item of result) { ... } to iterate through all pages automatically.

Send an RCS message

Queues an outbound RCS message through the selected RCS agent. Check recipient capabilities before sending features that require RCS support.

POST /messages/rcs — Required: agent_id, to, messaging_profile_id, agent_message

Optional: mms_fallback (object), sms_fallback (object), type (enum: RCS), webhook_url (url)

const response = await client.messages.rcs.send({
  agent_id: 'Agent007',
  agent_message: {},
  messaging_profile_id: '550e8400-e29b-41d4-a716-446655440000',
  to: '+13125551234',
});

console.log(response.data);

Returns: body (object), direction (string), encoding (string), from (object), id (string), messaging_profile_id (string), organization_id (string), received_at (date-time), record_type (string), to (array[object]), type (string), wait_seconds (float)

Generate RCS deeplink

Generate a deeplink URL that can be used to start an RCS conversation with a specific agent.

GET /messages/rcs/deeplinks/{agent_id}

const response = await client.messages.rcs.generateDeeplink('agent_id');

console.log(response.data);

Returns: url (string)

List all RCS agents

Returns RCS agents available to the authenticated account.

GET /messaging/rcs/agents

// Automatically fetches more pages as needed.
for await (const rcsAgent of client.messaging.rcs.agents.list()) {
  console.log(rcsAgent.agent_id);
}

Returns: agent_id (string), agent_name (string), created_at (date-time), enabled (boolean), profile_id (uuid), updated_at (date-time), user_id (string), webhook_failover_url (url), webhook_url (url)

Retrieve an RCS agent

Returns the configuration and current state of the specified RCS agent.

GET /messaging/rcs/agents/{id}

const rcsAgentResponse = await client.messaging.rcs.agents.retrieve('550e8400-e29b-41d4-a716-446655440000');

console.log(rcsAgentResponse.data);

Modify an RCS agent

Updates the supplied configuration fields on the specified RCS agent.

PATCH /messaging/rcs/agents/{id}

Optional: profile_id (uuid), webhook_failover_url (url), webhook_url (url)

const rcsAgentResponse = await client.messaging.rcs.agents.update('550e8400-e29b-41d4-a716-446655440000');

console.log(rcsAgentResponse.data);

Check RCS capabilities (batch)

Returns RCS capability information for multiple recipients in one request.

POST /messaging/rcs/bulk_capabilities — Required: agent_id, phone_numbers

const response = await client.messaging.rcs.listBulkCapabilities({
  agent_id: 'TestAgent',
  phone_numbers: ['+13125551234'],
});

console.log(response.data);

Returns: agent_id (string), agent_name (string), features (array[string]), phone_number (string), record_type (enum: rcs.capabilities)

Check RCS capabilities

Returns the RCS features supported by the specified recipient for the selected agent.

GET /messaging/rcs/capabilities/{agent_id}/{phone_number}

const response = await client.messaging.rcs.retrieveCapabilities('+13125550001', {
  agent_id: '550e8400-e29b-41d4-a716-446655440000',
});

console.log(response.data);

Returns: agent_id (string), agent_name (string), features (array[string]), phone_number (string), record_type (enum: rcs.capabilities)

Add RCS test number

Adds a test phone number to an RCS agent for testing purposes.

PUT /messaging/rcs/test_number_invite/{id}/{phone_number}

const response = await client.messaging.rcs.inviteTestNumber('+13125550001', { id: '550e8400-e29b-41d4-a716-446655440000' });

console.log(response.data);

Returns: agent_id (string), phone_number (string), record_type (enum: rcs.test_number_invite), status (string)

List messaging hosted number orders

Returns hosted-messaging orders for the authenticated account. Apply the documented filters and pagination parameters to narrow the result set.

GET /messaging_hosted_number_orders

// Automatically fetches more pages as needed.
for await (const messagingHostedNumberOrder of client.messagingHostedNumberOrders.list()) {
  console.log(messagingHostedNumberOrder.id);
}

Returns: id (uuid), messaging_profile_id (string | null), phone_numbers (array[object]), record_type (string), status (enum: carrier_rejected, compliance_review_failed, deleted, failed, incomplete_documentation, incorrect_billing_information, ineligible_carrier, loa_file_invalid, loa_file_successful, pending, provisioning, successful)

Create a messaging hosted number order

Creates an order to enable Telnyx messaging on phone numbers whose voice service remains with another carrier.

POST /messaging_hosted_number_orders

Optional: messaging_profile_id (string), phone_numbers (array[string])

const messagingHostedNumberOrder = await client.messagingHostedNumberOrders.create();

console.log(messagingHostedNumberOrder.data);

Check hosted messaging eligibility

Checks whether the supplied phone numbers are eligible for hosted messaging before an order is created.

POST /messaging_hosted_number_orders/eligibility_numbers_check — Required: phone_numbers

const response = await client.messagingHostedNumberOrders.checkEligibility({
  phone_numbers: ['string'],
});

console.log(response.phone_numbers);

Returns: phone_numbers (array[object])

Retrieve a messaging hosted number order

Returns the current state, phone numbers, and required actions for the specified hosted-messaging order.

GET /messaging_hosted_number_orders/{id}

const messagingHostedNumberOrder = await client.messagingHostedNumberOrders.retrieve('550e8400-e29b-41d4-a716-446655440000');

console.log(messagingHostedNumberOrder.data);

Delete a messaging hosted number order

Delete a messaging hosted number order and all associated phone numbers.

DELETE /messaging_hosted_number_orders/{id}

const messagingHostedNumberOrder = await client.messagingHostedNumberOrders.delete('550e8400-e29b-41d4-a716-446655440000');

console.log(messagingHostedNumberOrder.data);

Upload hosted number document

Uploads a supporting document to the specified hosted-messaging order.

POST /messaging_hosted_number_orders/{id}/actions/file_upload

import fs from 'fs';

const response = await client.messagingHostedNumberOrders.actions.uploadFile('550e8400-e29b-41d4-a716-446655440000');

console.log(response.data);

Validate hosted number codes

Validate the verification codes sent to the numbers of the hosted order. The verification codes must be created in the verification codes endpoint.

POST /messaging_hosted_number_orders/{id}/validation_codes — Required: verification_codes

const response = await client.messagingHostedNumberOrders.validateCodes('550e8400-e29b-41d4-a716-446655440000', {
  verification_codes: [{ code: 'code', phone_number: '+13125550001' }],
});

console.log(response.data);

Returns: order_id (uuid), phone_numbers (array[object])

Create hosted number verification codes

Create verification codes to validate numbers of the hosted order. The verification codes will be sent to the numbers of the hosted order.

POST /messaging_hosted_number_orders/{id}/verification_codes — Required: phone_numbers, verification_method

const response = await client.messagingHostedNumberOrders.createVerificationCodes('550e8400-e29b-41d4-a716-446655440000', {
  phone_numbers: ['string'],
  verification_method: 'sms',
});

console.log(response.data);

Returns: error (string), phone_number (string), type (enum: sms, call), verification_code_id (uuid)

Delete a messaging hosted number

Removes the specified hosted number from Telnyx messaging management.

DELETE /messaging_hosted_numbers/{id}

const messagingHostedNumber = await client.messagingHostedNumbers.delete('550e8400-e29b-41d4-a716-446655440000');

console.log(messagingHostedNumber.data);

List Verification Requests

Get a list of previously-submitted tollfree verification requests

GET /messaging_tollfree/verification/requests

// Automatically fetches more pages as needed.
for await (const verificationRequestStatus of client.messagingTollfree.verification.requests.list({
  page: 1,
  page_size: 1,
})) {
  console.log(verificationRequestStatus.id);
}

Returns: records (array[object]), total_records (integer)

Submit Verification Request

Submit a new tollfree verification request

POST /messaging_tollfree/verification/requests — Required: businessName, corporateWebsite, businessAddr1, businessCity, businessState, businessZip, businessContactFirstName, businessContactLastName, businessContactEmail, businessContactPhone, messageVolume, phoneNumbers, useCase, useCaseSummary, productionMessageContent, optInWorkflow, optInWorkflowImageURLs, additionalInformation

Optional: ageGatedContent (boolean), businessAddr2 (string), businessRegistrationCountry (string | null), businessRegistrationNumber (string | null), businessRegistrationType (string | null), campaignVerifyAuthorizationToken (string | null), doingBusinessAs (string | null), entityType (object), helpMessageResponse (string | null), isvReseller (string | null), optInConfirmationResponse (string | null), optInKeywords (string | null), privacyPolicyURL (string | null), termsAndConditionURL (string | null), webhookUrl (string)

const verificationRequestEgress = await client.messagingTollfree.verification.requests.create({
  additionalInformation: 'Additional context for this request.',
  businessAddr1: '600 Congress Avenue',
  businessCity: 'Austin',
  businessContactEmail: 'email@example.com',
  businessContactFirstName: 'John',
  businessContactLastName: 'Doe',
  businessContactPhone: '+18005550100',
  businessName: 'Telnyx LLC',
  businessState: 'Texas',
  businessZip: '78701',
  corporateWebsite: 'http://example.com',
  messageVolume: '100,000',
  optInWorkflow:
    "User signs into the Telnyx portal, enters a number and is prompted to select whether they want to use 2FA verification for security purposes. If they've opted in a confirmation message is sent out to the handset",
  optInWorkflowImageURLs: [
    { url: 'https://telnyx.com/sign-up' },
    { url: 'https://telnyx.com/company/data-privacy' },
  ],
  phoneNumbers: [{ phoneNumber: '+18773554398' }, { phoneNumber: '+18773554399' }],
  productionMessageContent: 'Your Telnyx OTP is XXXX',
  useCase: '2FA',
  useCaseSummary:
    'This is a use case where Telnyx sends out 2FA codes to portal users to verify their identity in order to sign into the portal',
});

console.log(verificationRequestEgress.id);

Returns: additionalInformation (string), ageGatedContent (boolean), businessAddr1 (string), businessAddr2 (string), businessCity (string), businessContactEmail (string), businessContactFirstName (string), businessContactLastName (string), businessContactPhone (string), businessName (string), businessRegistrationCountry (string), businessRegistrationNumber (string), businessRegistrationType (string), businessState (string), businessZip (string), campaignVerifyAuthorizationToken (string | null), corporateWebsite (string), doingBusinessAs (string), entityType (object), helpMessageResponse (string), id (uuid), isvReseller (string), messageVolume (object), optInConfirmationResponse (string), optInKeywords (string), optInWorkflow (string), optInWorkflowImageURLs (array[object]), phoneNumbers (array[object]), privacyPolicyURL (string), productionMessageContent (string), termsAndConditionURL (string), useCase (object), useCaseSummary (string), verificationRequestId (string), verificationStatus (object), webhookUrl (string)

Get Verification Request

Get a single verification request by its ID.

GET /messaging_tollfree/verification/requests/{id}

const verificationRequestStatus = await client.messagingTollfree.verification.requests.retrieve(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(verificationRequestStatus.id);

Returns: additionalInformation (string), ageGatedContent (boolean), businessAddr1 (string), businessAddr2 (string), businessCity (string), businessContactEmail (string), businessContactFirstName (string), businessContactLastName (string), businessContactPhone (string), businessName (string), businessRegistrationCountry (string), businessRegistrationNumber (string), businessRegistrationType (string), businessState (string), businessZip (string), campaignVerifyAuthorizationToken (string | null), corporateWebsite (string), createdAt (date-time), doingBusinessAs (string), entityType (object), helpMessageResponse (string), id (uuid), isvReseller (string), messageVolume (object), optInConfirmationResponse (string), optInKeywords (string), optInWorkflow (string), optInWorkflowImageURLs (array[object]), phoneNumbers (array[object]), privacyPolicyURL (string), productionMessageContent (string), reason (string), termsAndConditionURL (string), updatedAt (date-time), useCase (object), useCaseSummary (string), verificationStatus (object), webhookUrl (string)

Update Verification Request

Update an existing tollfree verification request. This is particularly useful when there are pending customer actions to be taken.

PATCH /messaging_tollfree/verification/requests/{id} — Required: businessName, corporateWebsite, businessAddr1, businessCity, businessState, businessZip, businessContactFirstName, businessContactLastName, businessContactEmail, businessContactPhone, messageVolume, phoneNumbers, useCase, useCaseSummary, productionMessageContent, optInWorkflow, optInWorkflowImageURLs, additionalInformation

const verificationRequestEgress = await client.messagingTollfree.verification.requests.update(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  {
    additionalInformation: 'Additional context for this request.',
    businessAddr1: '600 Congress Avenue',
    businessCity: 'Austin',
    businessContactEmail: 'email@example.com',
    businessContactFirstName: 'John',
    businessContactLastName: 'Doe',
    businessContactPhone: '+18005550100',
    businessName: 'Telnyx LLC',
    businessState: 'Texas',
    businessZip: '78701',
    corporateWebsite: 'http://example.com',
    messageVolume: '100,000',
    optInWorkflow:
      "User signs into the Telnyx portal, enters a number and is prompted to select whether they want to use 2FA verification for security purposes. If they've opted in a confirmation message is sent out to the handset",
    optInWorkflowImageURLs: [
      { url: 'https://telnyx.com/sign-up' },
      { url: 'https://telnyx.com/company/data-privacy' },
    ],
    phoneNumbers: [{ phoneNumber: '+18773554398' }, { phoneNumber: '+18773554399' }],
    productionMessageContent: 'Your Telnyx OTP is XXXX',
    useCase: '2FA',
    useCaseSummary:
      'This is a use case where Telnyx sends out 2FA codes to portal users to verify their identity in order to sign into the portal',
  },
);

console.log(verificationRequestEgress.id);

Delete Verification Request

Delete a verification request

A request may only be deleted when when the request is in the "rejected" state. * HTTP 200: request successfully deleted

HTTP 400: request exists but can't be deleted (i.e. not rejected)
HTTP 404: request unknown or already deleted

DELETE /messaging_tollfree/verification/requests/{id}

await client.messagingTollfree.verification.requests.delete('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

Get Verification Request Status History

Get the history of status changes for a verification request. Returns a paginated list of historical status changes including the reason for each change and when it occurred.

GET /messaging_tollfree/verification/requests/{id}/status_history

const response = await client.messagingTollfree.verification.requests.retrieveStatusHistory(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  { 'page[number]': 1, 'page[size]': 1 },
);

console.log(response.records);

Returns: records (array[object]), total_records (integer)

List messaging URL domains

Returns the URL domains available to the authenticated account for message URL shortening.

GET /messaging_url_domains

// Automatically fetches more pages as needed.
for await (const messagingURLDomainListResponse of client.messagingURLDomains.list()) {
  console.log(messagingURLDomainListResponse.id);
}

Returns: id (string), record_type (string), url_domain (string), use_case (string)

查看 team-telnyx 的全部技能

报告此技能的问题

安装

用命令安装

npx skills add https://github.com/team-telnyx/ai --skill telnyx-messaging-hosted-javascript

粘贴到终端中运行（需要 Node.js）。可以选择安装到 Claude Code、Codex 等代理。

让代理安装

请安装以下 Agent Skill。
https://github.com/team-telnyx/ai/tree/main/skills/telnyx-messaging-hosted-javascript

请先检查 SKILL.md 和附带文件的内容，确认没有可疑的处理（向外部发送数据、读取认证信息等）后，再放到 ~/.claude/skills/telnyx-messaging-hosted-javascript/（Claude Code）或 ~/.agents/skills/telnyx-messaging-hosted-javascript/（Codex）。

把这段文字直接发给 Claude Code 或 Codex，它会先检查内容再安装。

在 GitHub 查看源代码

仓库: team-telnyx/ai
星标: 222
复刻: 24
分类: 开发
许可证: MIT
原文语言: 英语
最后更新: 2026年10月22日

技能是给 AI 代理的指令和脚本的集合。cccskills 不保证其内容的安全性，安装前请务必确认内容。