API利用ガイド

nocall 公開 API を使うと、外部システムからコンタクトの登録・即時架電・通話結果の取得ができます。各 API のパラメータとレスポンスは、生成された APIリファレンス を参照してください。

ベースURL

https://api.nocall.ai/api/v1

新しい連携では /api/v1 を使用してください。

APIキーを取得する

1. nocall コンソールで対象のプロジェクトを開きます。
2. 左サイドバーの「APIキー」を開きます。
3. 「APIキーを作成」を選び、用途が分かる名前を入力します。
4. 作成直後に表示されるキーを安全な場所へ保存します。

APIキーの値は一度だけ表示されます。ブラウザやモバイルアプリへ直接埋め込まず、サーバー側の環境変数やシークレット管理サービスで保管してください。

認証する

すべての API リクエストで、次のどちらかのヘッダーを指定します。

x-api-key: NOCALL_API_KEY

Authorization: Bearer NOCALL_API_KEY

APIキーごとのレート制限は、目安として1分あたり100リクエストです。429 Too Many Requests を受け取った場合は、時間を置いて再試行してください。

IDを確認する

agentId はエージェント詳細画面、userGroupId はコンタクトグループ詳細画面で確認できます。各画面に表示されるIDをクリックしてコピーしてください。

agentId または userGroupId を省略すると、プロジェクト内の既定候補が選択されます。意図しない対象を使わないよう、外部連携では明示することを推奨します。

旧フィールドから移行する

familyName、givenName、familyNameKana、givenNameKana、companyName、email は互換性のため受け付けますが、非推奨です。新しい連携では attributions に属性を指定してください。

{
  "phoneNumber": "+818011119999",
  "userGroupId": "ugp_XXX",
  "agentId": "agt_XXX",
  "attributions": [
    { "label": "姓", "value": "山田" },
    { "label": "名", "value": "太郎" },
    { "label": "会社名", "value": "株式会社テスト" }
  ]
}

attributions の label は同じリクエスト内で重複できません。エージェントが必須としている属性もすべて指定してください。

API一覧

• エンドユーザーを作成して即時架電する
• 通話結果一覧を取得する
• 通話IDから通話結果詳細を取得する
• 架電タスクIDから通話結果詳細を取得する
• 通話IDから録音音声URLを取得する
• 架電タスクIDから録音音声URLを取得する

各ページには、固定URL、認証方法、パラメータ、リクエストボディ、ステータスコード別レスポンス、レスポンスフィールド、curl などのコード例が表示されます。