Telnyx API 技能(适用于Claude代码)
作者 汤姆·迪米诺 仓库: https://github.com/tdimino/telnyx 翻译为中文可以是:“https://github.com/tdimino/telnyx(GitHub上的Telnyx项目仓库)”。不过,通常在中文语境下,我们可能会直接保留网址不变,因为网址本身是国际通用的,不需要翻译。但如果要对网址所代表的内容进行简要说明,可以如上所述
一项全面的Claude Code技能,专为与Telnyx通信平台协作而设计,涵盖短信/彩信消息服务、语音通信、电话号码管理以及10DLC合规性。
这项技能提供的内容
快速参考示例
- 发送简单的短信/彩信
- 通过Webhooks处理传入的消息
- 验证并格式化电话号码(E.164格式)
- 发送消息时包含错误处理和重试逻辑
- 带速率限制的批量消息发送
- 验证Webhook签名以确保安全
- 安排消息稍后发送
- 构建双向对话流程
- 多语言支持(Node.js,Python)
综合参考指南
- 10dlc.md(文件名或网址等,直接翻译为中文保持原样,若需解释性翻译则为“10dlc的markdown文件”或“指向10dlc的markdown文件/网址”,具体根据上下文确定) - 10DLC注册、品牌验证、广告活动审批阶段
- \
authentication.md\翻译成中文是:“认证说明文件”或“身份验证指南”。这里,“.md”通常表示该文件是Markdown格式的,常用于编写技术文档或说明文件。因此,整个文件名可以理解为一个关于认证或身份验证的Markdown格式说明或指南 API密钥管理及安全最佳实践 - 消息传递API.md 完成消息传递API参考
- webhooks.md(文件名,可译为“关于webhooks的说明/文档”) - Webhook集成、安全性和事件处理
- error-codes.md 翻译为中文是:“错误代码.md” - 完整的错误参考和处理策略
- 最佳实践指南.md - 生产部署模式及优化
- number-management.md 翻译为中文是:“号码管理.md” - 电话号码的操作与配置
安装
先决条件
1. 安装技能
选项A:从此仓库获取
# Clone this repository
git clone https://github.com/tdimino/telnyx.git
# Copy to your Claude skills directory
cp -r telnyx ~/.claude/skills/telnyx-api选项B:手动安装
- 下载或克隆此存储库
- 将整个文件夹复制到
~/.claude/skills/telnyx-api
2. 设置Telnyx MCP服务器(可选,但推荐)
Telnyx MCP服务器提供来自Claude Code的直接API访问:
# Install uv/uvx (if not already installed)
curl -LsSf https://astral.sh/uv/install.sh | sh
# Or via Homebrew:
brew install uv
# Add Telnyx MCP server to Claude Code
claude mcp add \
--transport stdio \
telnyx \
--env TELNYX_API_KEY=YOUR_API_KEY_HERE \
-- uvx --from git+https://github.com/team-telnyx/telnyx-mcp-server.git telnyx-mcp-server或者复制提供的 .mcp.json 配置:
# Copy .mcp.json to your project
cp .mcp.json /path/to/your/project/
# Edit the file and replace YOUR_TELNYX_API_KEY_HERE with your actual key3. 配置环境变量
创建一个 .env 项目中的文件:
# Telnyx Configuration
TELNYX_API_KEY=KEY019A080F468AAFD4AF4F6888D7795244_xxx
TELNYX_PHONE_NUMBER=+18628026208
TELNYX_MESSAGING_PROFILE_ID=40019a09-498f-45b1-98e4-ca1339a3babc
TELNYX_WEBHOOK_PUBLIC_KEY=your_public_key_for_signature_verification快速入门
1. 发送你的第一条短信
const axios = require('axios');
async function sendSMS(to, from, text) {
const response = await axios.post(
'https://api.telnyx.com/v2/messages',
{ from, to, text },
{
headers: {
'Authorization': `Bearer ${process.env.TELNYX_API_KEY}`,
'Content-Type': 'application/json'
}
}
);
return response.data;
}
// Usage
sendSMS('+14155552671', '+18628026208', 'Hello from Telnyx!');2. 设置Webhook处理器
const express = require('express');
const app = express();
app.use(express.json());
app.post('/webhooks/telnyx', (req, res) => {
const event = req.body.data;
if (event.event_type === 'message.received') {
const from = event.payload.from.phone_number;
const text = event.payload.text;
console.log(`Received: "${text}" from ${from}`);
// Auto-reply
sendSMS(from, event.payload.to[0].phone_number, 'Thanks for your message!');
}
res.status(200).send('OK');
});
app.listen(3000);3. 在Claude代码中使用该技能
安装完成后,在Claude代码中调用该技能:
Activate your Telnyx API skill and help me set up SMS messaging for my application.这个技能将引导你完成:
- 设置电话号码
- 实现消息发送功能
- 配置Webhooks
- 处理错误
- 10DLC合规性(如适用)
10DLC注册(仅限美国)
如果你正在向美国电话号码发送短信,你 必须 注册10DLC(10-digit long code,10位长码):
活动审批阶段
您的活动分为三个阶段:
- TCR_ACCEPTED 翻译为中文是“TCR被接受” ✅ - 活动注册获得批准(1-3天)
- MNO_PENDING 翻译为中文是“运营商待处理”或“移动网络运营商待确认” ⏳ - 等待承运商批准(1-3天)
- MNO_PROVISIONED 可以翻译为“已由移动网络运营商(MNO)提供/配置” 🎯 - 已完全批准,准备发货!
总时间线: 从品牌提交到获得全面批准需3-5个工作日
快速注册核对清单
- \[ \] 注册您的品牌(商业信息、雇主识别号(EIN)、网站)
- \[ \] 等待品牌批准(24-48小时)
- \[ \] 创建活动(描述、使用场景、示例消息)
- \[ \] 提供选择加入/选择退出的流程
- \[ \] 包含隐私政策和条款的网址
- \[ \] 等待TCR_ACCEPTED(1-3天)
- \[ \] 等待MNO_PROVISIONED(1-3天)
- \[ \] 将电话号码与活动关联(仅限门户)
- \[ \] 测试消息传递
看见 references/10dlc.md 以获取完整的注册指南。
关键特性
适合初学者
- 简单的短信发送示例
- 电话号码验证
- 基本的webhook处理
- 错误处理模式
对于中级用户
- 双向对话流畅进行
- Webhook签名验证
- 批量发送时的速率限制
- 消息分段处理
针对高级用户
- 生产部署模式
- 基于队列的消息处理
- 全面监控
- 成本优化策略
- 10DLC合规自动化
用例
这项技能有助于你构建:
- 客户支持系统 - 支持双向短信对话
- 通知服务 - 订单更新,预约提醒
- 2FA/认证 - 一次性密码传递
- 营销活动 - 合规性宣传信息
- 调查与民意测验 - 互动式短信调查
- 警报与监控 - 系统警报和监控通知
MCP服务器工具
当Telnyx MCP服务器安装完成后,您可以在Claude Code中访问这些工具:
list_phone_numbers- 查看您的电话号码get_phone_number- 获取号码详情update_phone_number- 配置数字设置send_message- 发送短信/彩信get_message- 获取消息详情list_messaging_profiles- 查看消息配置文件create_messaging_profile- 创建新配置文件update_messaging_profile- 更新个人资料设置- 此外,还有更多功能用于助手、通话和集成
API精要
基本URL
https://api.telnyx.com/v2认证
Authorization: Bearer YOUR_API_KEY速率限制
- 标准:每个端点每秒10个请求
- 高流量:请联系Telnyx以提高限额
短信费用(10DLC审批通过后)
- 客户服务:约0.0079美元/段
- 营销:约0.0095美元/段
- 2FA:每段约0.0055美元
支持与资源
文档
- Telnyx 文档https://developers.telnyx.com/(译文:https://developers.telnyx.com/(注:网址本身无需翻译,保持原样))
- API 参考https://developers.telnyx.com/api/(注:此为网址,中文翻译通常不直接翻译网址内容,但为符合问题要求,可表述为“Telnyx开发者API文档页面”)
- 任务控制门户https://portal.telnyx.com/(网址保持原样,不进行翻译)
- 状态页面https://status.telnyx.com/ 的中文翻译可以是:“https://telnyx.com 状态页面”。不过,通常我们不会直接翻译网址,而是直接使用原网址,或者在需要说明其用途时,像这样简单地描述其为“Telnyx的状态页面”或“Telnyx的服务状态页面”
寻求帮助
- 检查
references/error-codes.md针对特定错误 - 评论
references/best-practices.md对于图案 - 通过Mission Control门户联系Telnyx支持团队
- 电子邮箱:10dlcquestions@telnyx.com(用于10DLC相关问题)
常见问题
- 401 未授权检查API密钥格式(
Bearer YOUR_API_KEY) - 10001 无效的电话号码使用E.164格式
+14155552671) - 429 请求速率过高(或“请求限速”)实现速率限制
- 未收到Webhooks验证URL是否为公开且具有有效SSL证书
做出贡献
欢迎投稿!请:
- 为这个仓库创建分支
- 创建一个特性分支
- 做出你的更改
- 彻底测试
- 提交拉取请求
许可证
这项技能作为原样提供,用于与Claude Code一起使用。Telnyx API的使用受Telnyx服务条款的约束。
更新日志
版本1.0.0(2025年10月24日)
- 首次发布
- 完善10DLC参考,包含审批阶段
- 品牌验证和广告活动审核指南
- 手动审核要求(截至2023年1月)
- MNO_PROVISIONED 阶段文档
- 更新后的成本结构和时间表
- 生产部署模式
- 错误处理和监控指南
______________________________________________________________________
为使用Claude Code的Telnyx开发者构建 🚀(火箭/快速上升/飞速发展等,具体含义根据上下文而定)
