Vapi との接続ガイド

お申し込みと、接続に使う情報のやりとり

お申し込み後に、クラコールから接続に使う情報をお渡しします。お客様からは、Vapi 側の情報をお知らせください。

お問い合わせの本文に「BYOC 接続」とお書きのうえ、お送りください。BYOC では、着信・発信とも、INVITE の宛先（Request-URI）・To・From の電話番号を +81 から始まる E.164 形式にしてください（例：03-1234-5678 → +81312345678）。

資格情報（credential）を作り、着信・発信の通り道にクラコールを登録する

Vapi の資格情報（credential）は、BYO SIP トランクの設定のまとまりです。ユーザー名・パスワードによる認証ではありません。その中のゲートウェイ（gateways）に、クラコールの SBC の IP アドレス（着信用）と、お客様専用のドメイン（発信用）を登録します。

ターミナル（curl）：BYO SIP トランク（byo-sip-trunk）の資格情報を作る

curl -X POST "https://api.vapi.ai/credential" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $VAPI_API_KEY" \
  -d '{
    "provider": "byo-sip-trunk",
    "name": "clocall",
    "gateways": [
      { "ip": "203.0.113.10", "inboundEnabled": true, "outboundEnabled": false },
      { "ip": "203.0.113.11", "inboundEnabled": true, "outboundEnabled": false },
      { "ip": "203.0.113.20", "inboundEnabled": true, "outboundEnabled": false },
      { "ip": "xyz.customer.clocall.jp", "inboundEnabled": false, "outboundEnabled": true }
    ],
    "outboundLeadingPlusEnabled": true
  }'

• provider の byo-sip-trunk：お客様が持ち込む SIP トランク（BYOC）であることを示します。
• 最初の3つの gateways（着信用）：クラコールの SBC の IP アドレスを、手順1でお渡しするものすべて入れます（IP アドレスごとに1つ。例の 203.0.113.10 などは例の値です）。着信を受けるゲートウェイに使えるのは IPv4 アドレスだけです。inboundEnabled を true にし、outboundEnabled は false にします（発信が SBC の IP アドレスへ直接向かわないようにするための、クラコールからのお願いです）。
• 最後の gateways（発信用）：お客様専用のドメイン（例：xyz.customer.clocall.jp）を ip に入れます。Vapi からの発信は、このゲートウェイを通ってクラコールへ送られます。発信専用にするため、inboundEnabled を false にします。ホスト名のゲートウェイで inboundEnabled が true（既定）のままだと、Vapi は「the SBC rejects the gateway configuration」と、設定を受け付けません。
• outboundLeadingPlusEnabled：true にすると、発信の電話番号の先頭に + が付きます。
• $VAPI_API_KEY：Vapi の API キーです。環境変数に入れて使い、コマンドに直接は書きません。アメリカのリージョンの API は https://api.vapi.ai です。EU（ヨーロッパ）で Vapi をご利用の場合は、https://api.eu.vapi.ai で作ります。
• ゲートウェイの port の既定は 5060、outboundProtocol の既定は udp です。標準では、この2つは書かなくても構いません。
• クラコールは、ユーザー名・パスワードによる認証は使いません。Vapi の公式ドキュメントの例にある outboundAuthenticationPlan は、ユーザー名・パスワードを使う他社の回線向けなので、付けないでください。認証は、お客様専用のドメインと発信者番号で行います。
• ポートは UDP・TCP が 5060 です（Vapi が TLS を受けるポートは 5061 です。暗号化の有料オプションをお申し込みの場合だけ使います）。

電話番号（phone number）を資格情報にひもづけ、発信に使う

お客様の電話番号を、Vapi の phone number（電話番号のリソース）として登録し、手順2の資格情報と、着信に答えるアシスタントにひもづけます。POST /phone-number で作ります。

ターミナル（curl）：番号を BYO 番号（byo-phone-number）として取り込み、手順2の資格情報にひもづける

curl -X POST "https://api.vapi.ai/phone-number" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $VAPI_API_KEY" \
  -d '{
    "provider": "byo-phone-number",
    "name": "clocall number",
    "number": "+81312345678",
    "numberE164CheckEnabled": true,
    "credentialId": "<credential-id>",
    "assistantId": "<assistant-id>"
  }'

• credentialId：手順2で作った資格情報の ID に置き換えます。この番号の着信・発信は、この資格情報（クラコールを登録したゲートウェイ）を通ります。
• number：ご利用の電話番号です。+81 から始まる E.164 形式で、先頭の + を付けて入れます（例の +81312345678 は例の番号です）。公式ドキュメントにも、E.164 形式で + を付けて入れ、Allow non-E164 phone numbers はオフのままにする、とあります。
• numberE164CheckEnabled：true（既定）にすると、E.164 形式の番号だけを受け付けます。
• assistantId：着信に答えるアシスタントの ID に置き換えます。assistantId・squadId・workflowId のどれも指定しないと、着信のたびに assistant-request が Server URL に送られます。
• EU で使う場合は、URL の https://api.vapi.ai を https://api.eu.vapi.ai に変えます。

発信するときは、発信元の番号として、ここで取り込んだ電話番号の ID（phoneNumberId）を指定します。この番号から発信すると、手順2の発信用ゲートウェイ（お客様専用のドメイン）を通ってクラコールへ送られます。発信者番号は、SIP の From ヘッダーに入れてください。P-Asserted-Identity には対応していません。

つながることを確認する

• 着信：クラコールの電話番号へ携帯電話などからかけ、お客様の Vapi に電話が届き、手順3の assistantId のアシスタントが答えることを確認します。
• 発信：手順3の番号（phoneNumberId）から、携帯電話などの日本の電話番号へかけ、電話が鳴ることを確認します。宛先の電話番号は、+81 から始まる E.164 形式で入れてください（例：+81355550000 は例の番号です）。発信者番号が、+81 から始まる E.164 形式で From ヘッダーに入っていることも確認してください。
• 両方の向きで、相手の声が聞こえることを確認します。