让您的总机成为软件的一部分。
一个 API 密钥,普通 HTTP,JSON 响应。从点击拨号、呼叫控制到自动外呼活动、语音助手任务、语音验证码,一切皆为 REST;结果通过 HMAC 签名的 Webhook 返回。
快速入门
您的首次请求只需 2 分钟
在面板 > 自动外呼 > API 标签页(或总机设置)中获取您的密钥;通过 Bearer 请求头、X-Api-Key 或 ?key= 发送。
- 密钥绑定您的客户账户;无法访问其他客户的数据。
- 读取操作使用 GET,更改数据的操作使用 POST;正文为 JSON 或表单。
- 错误响应始终
{"ok":false,"error":"…","code":"…"}格式。 - 速率限制:每个密钥每分钟 120 次请求;超出时 429。
# 点击拨号:先呼叫分机 1001,接听后再拨打目标号码
curl "https://api.buluthat.com/api/begin_call.php?key=K1234-…&extension=1001&destination=905321234567"
# 创建活动
curl -X POST "https://api.buluthat.com/api/autocall.php?action=create_campaign" \ -H "Authorization: Bearer bt_xxxxxxxx" \ -H "Content-Type: application/json" \ -d '{"name":"Ödeme hatırlatma","campaign_type":"ivr", "tts_template":"Merhaba {sayin}, {tutar} tutarındaki ödemeniz…", "digit_labels":{"1":"Ödedim","2":"Yetkili"}}'
# 发送语音验证码
curl -X POST "https://api.buluthat.com/api/voice_otp.php?action=send" \ -H "X-Api-Key: bt_xxxxxxxx" -d "phone=905321234567"
→ {"ok":true,"id":8812,"code":"472915","expires_in":300}
文档
API 请求头
每个标题下附有接口地址、参数、示例请求与响应。
概览
身份验证、请求格式、错误码、速率限制
读取API 安全
密钥与权限范围、IP 白名单、HMAC 请求签名、密钥轮换、请求日志
读取通话管理
点击拨号、结束、转接、静音
读取队列
队列列表、排队中的来电、添加/移除成员
读取坐席状态
分机状态与队列成员
读取黑名单
列出、添加、删除被屏蔽号码
读取语音文件
语音提示列表、上传、更新、删除
读取自动外呼
创建活动、添加号码、获取结果、Webhook
读取语音助手
通话、备注、预约、任务呼叫、嵌入
读取语音验证 (OTP)
发送验证码、验证、状态、Webhook
读取SMS API
批量/个性化短信、OTP 短信、送达报告、上行短信、黑名单
读取Webhook
签名验证、重试策略、事件结构
读取嵌入(CRM iframe)
在您的中央控制台和网页电话软件中:代码、签名链接、JavaScript 事件
读取Webhook
Webhook 文档 让结果主动找上您,而不是您去询问。
自动外呼结果、语音助手通话摘要、验证码状态——每个事件都会以 JSON 形式 POST 到您的地址;X-Buluthat-Signature 请求头是 HMAC-SHA256 签名。投递失败时,将按 1 分钟 → 6 小时的间隔重试。
// PHP:验证签名
$raw = file_get_contents('php://input'); $sig = $_SERVER['HTTP_X_BULUTHAT_SIGNATURE'] ?? ''; $calc = hash_hmac('sha256', $raw, $secret); if (!hash_equals($calc, $sig)) { http_response_code(401); exit; } $event = json_decode($raw, true);
// $event['event'] = 'call_finished' | 'session_ended' | 'otp_result' …
