API は Web ダッシュボードと同じエージェント、通話、クレジットを扱います。ダッシュボードで作ったものはすべて自社システムから操作でき、その逆も可能です。
| 内容 | エンドポイント |
|---|---|
| エージェント一覧 | GET /api/v1/voice/agents |
| エージェントを作成 | POST /api/v1/voice/agents |
| エージェントの取得・更新 | GET · PATCH /api/v1/voice/agents/{id} |
| 発信する | POST /api/v1/voice/calls |
| 通話一覧 | GET /api/v1/voice/calls |
| 通話の取得(文字起こし) | GET /api/v1/voice/calls/{id} |
| 通話の削除 | DELETE /api/v1/voice/calls/{id} |
| 発信者の通話の削除 | POST /api/v1/voice/calls/delete-by-caller |
| キャンペーン | GET · POST /api/v1/voice/campaigns |
| キャンペーンの取得 | GET /api/v1/voice/campaigns/{id} |
| 開始・一時停止・中止 | POST /api/v1/voice/campaigns/{id}/{action} |
| クローン音声 | GET · POST /api/v1/voice/voices |
| クローン音声の削除 | DELETE /api/v1/voice/voices/{id} |
| 発信停止リスト | GET · POST /api/v1/voice/do-not-call |
| リストから削除 | DELETE /api/v1/voice/do-not-call/{phone} |
| 言語・音声・テンプレート | GET /api/v1/voice/catalog |
| エージェントのテスト | GET · POST /api/v1/voice/agents/{id}/tests |
| テスト実行 / 実行結果の取得 | POST /api/v1/voice/agents/{id}/test-runs · GET /api/v1/voice/test-runs/{id} |
| 番号をエージェントに割り当て | PATCH /api/v1/voice/phone-numbers/{id} |
| 単語リスト | GET · POST /api/v1/voice/vocabularies |
| 文字チャット | POST /api/v1/voice/chats · POST /api/v1/voice/chats/{id}/messages · POST /api/v1/voice/chats/{id}/end |