Teloz REST API

あらゆるものに音声を組み込む Teloz API

通話の開始、Webhook の受信、トランスクリプトのストリーミング、フル機能のダイヤラーの埋め込みはすべて、主要な言語ごとに SDK を備えたクリーンな REST API を通じて行われます。

REST APIWebhookOpenAPI仕様SDK99.99% の稼働時間
200 OK — 通話がキューに入れられています
OpenAPI 3.0仕様が含まれています
teloz-api.js
// Initiate an outbound call
 
const response = await teloz.calls.create({
to: "+12025550123",
from: "+18005550199",
record: true,
webhook: "https://your-app.com/events"
});
 
// Response
// {
// sid: "CA3f9a…"
// status: "queued"
// duration: null
// }
数字で見る

初日から実稼働向けに構築

Teloz API は、米国の何千ものシステムに電力を供給しているのと同じインフラストラクチャです ビジネスフォンシステム 毎日。

99.99%
API稼働時間SLA
エンタープライズグレードの信頼性
< 100ms
応答時間の中央値
米国のすべての地域で
50+
RESTエンドポイント
電話、連絡先、番号など
4つのSDK
公式言語ライブラリ
ノード、Python、PHP、Go
エンドポイント

6 つのリソース グループ、50 以上のエンドポイント

音声、SMS、コンタクト センターの機能を製品に組み込むために必要なものがすべて揃っています。

投稿・取得・削除

電話

発信通話を開始し、通話記録を取得し、録音にアクセスし、リアルタイムのトランスクリプトをストリーミングします。

役職/v1/calls
得る/v1/calls/:sid
得る/v1/calls/:sid/recording
消去/v1/calls/:sid
POST・GET・PUT・DELETE

連絡先

連絡先を作成、読み取り、更新、削除します。 CRM と同期するか、独自の電話帳を作成します。

役職/v1/contacts
得る/v1/contacts
置く/v1/contacts/:id
消去/v1/contacts/:id
投稿・取得・削除

数字

利用可能な番号を検索し、ローカルまたはフリーダイヤルの DID をプロビジョニングし、番号構成を管理します。

得る/v1/numbers/available
役職/v1/numbers
得る/v1/numbers/:id
消去/v1/numbers/:id
投稿・取得・削除

Webhook

エンドポイントを登録して、通話、ボイスメール、トランスクリプト、SMS のリアルタイム イベントを受信します。

役職/v1/webhooks
得る/v1/webhooks
置く/v1/webhooks/:id
消去/v1/webhooks/:id
得る

分析

コールの量、継続時間、処理、キューの統計をダッシュ​​ボードとレポートにプルします。

得る/v1/analytics/calls
得る/v1/analytics/queues
得る/v1/analytics/agents
得る/v1/analytics/summary
JavaScript SDK

埋め込みダイヤラ

数行の JavaScript を使用して、フル機能の Click-to-Call ウィジェットを任意の Web アプリにドロップします。

teloz.dialer.init(config)
teloz.dialer.call(number)
teloz.dialer.on('event', fn)
teloz.dialer.destroy()
コード例

選択した言語で統合

Node.js、Python、PHP、Go の公式 SDK — または REST API あらゆる言語から直接。

通話を開始する
import Teloz from "@teloz/node";
 
const client = new Teloz(process.env.TELOZ_API_KEY);
 
const call = await client.calls.create({
to: "+12025550123",
from: "+18005550199",
record: true,
transcribe: true,
webhook: "https://your-app.com/events",
});
 
console.log(call.sid); // CA3f9a7b…
Webhook

すべての通話イベントに反応する リアルタイム

Webhook URL を登録すると、Teloz はイベントが発生した瞬間に署名付き JSON ペイロードをエンドポイントに POST します。ポーリングは必要ありません。 Webhook を組み合わせる 統合 ワークフローをエンドツーエンドで自動化します。

すべてのペイロードの HMAC-SHA256 署名
指数バックオフによる自動再試行
ダッシュボードでの配信ログとリプレイ
エンドポイントごとのイベントタイプでフィルタリング可能
イベントカテゴリ
call.initiated発信通話がキューに入れられると発生します
電話
call.ringing宛先の電話が鳴っている
電話
call.answered電話が応答されました — 発信者のメタデータが含まれています
電話
call.completed通話が終了しました — 期間、態度を含む
電話
call.missedかかってきた電話に応答がなかった
電話
recording.ready録画ファイルの URL をダウンロードできます
録音
transcript.ready完全なトランスクリプトテキストと発言者ラベルが添付されています
AI
voicemail.new音声 URL 付きの新しいボイスメールを受信しました
ボイスメール
sms.inboundプロビジョニングされた番号で受信した受信 SMS
SMS
APIに関するよくある質問

短い答え。

構築を開始する前によくある質問。

Teloz アカウントにサインアップし、[設定] → [開発者] → [API キー] に移動します。範囲指定されたアクセス許可 (読み取り専用、呼び出し専用、管理者) を持つ複数のキーを作成し、いつでもそれらを取り消すことができます。

はい。 OpenAPI 3.0 の完全な仕様は api.teloz.com/openapi.json で入手でき、Postman、Insomnia、または互換性のあるクライアントに直接インポートできます。リリースごとに同期が保たれます。

API はベアラー トークン認証を使用します。 API キーを Authorization ヘッダーに「Bearer YOUR_API_KEY」として渡します。サーバー間で使用する場合は、スコープ付きキーをお勧めします。ブラウザに組み込まれたダイヤラーの場合は、OAuth の有効期限の短いトークンを使用します。

はい - デフォルトの制限は、API キーごとに 1 秒あたり 100 リクエストです。最大 500 req/s のバーストが最大 10 秒間許可されます。エンタープライズ プランでは、より高い制限をリクエストできます。レート制限ヘッダー (X-RateLimit-Remaining、X-RateLimit-Reset) はすべての応答で返されます。

すべての Webhook POST には、Webhook シークレットで署名された生のリクエスト本文の HMAC-SHA256 ハッシュを含む X-Teloz-Signature ヘッダーが含まれています。自分側で同じハッシュを計算して比較し、一致しないリクエストを拒否します。

はい。ベース URL https://api.sandbox.teloz.com をテスト API キーとともに使用します。サンドボックス モードで行われた通話は PSTN に接続されることはありません。録音やトランスクリプトを含むイベント ライフサイクル全体がシミュレートされます。

Teloz API を使用して構築を開始します。 無料のサンドボックスが含まれています。

API キーは 2 分以内に取得できます。本番稼働前にフル機能のサンドボックスでテストしてください。クレジット カードは必要ありません。

OpenAPI の完全な仕様4つの公式SDKサンドボックス環境米国の開発者サポート