開発者向け
お客様のシステムから、SMS・オートコール・FAX の一斉配信、クリックトゥコール、通話履歴の取得、 SIPプロファイルと発信プレフィックスの管理を自動化できます。配信結果や受信 FAX は Webhook で受け取れます。 本番の live とサンドボックスの test の 2 環境があり、 test ではメッセージが送信されず、料金も発生しません。
ベース URL: https://hub.naruko.app/api/public/v1
コンソールの「共通 → API キー」でキーを発行します。サンドボックスのキーは nrk_test_…、本番のキーは nrk_live_… で始まります。まずは test から始めるのがおすすめです。 このページで説明するすべての API を、同じキーで利用できます。
範囲の限定は、通話履歴・受信 FAX・配信・電話発信だけに働きます。 ほかの機能は、キャンペーンや電話番号を選んでも組織全体を扱えます。
| 機能 | 使用可能な API | 扱える範囲 |
|---|---|---|
| 通話履歴 | /calls・/phonenumbers/{id}/calls | キャンペーン・電話番号に限定できる |
| 受信 FAX | /fax-receipts | キャンペーン・電話番号に限定できる |
| 配信 | /delivery-jobs・/media・/sender-numbers・/sms-senders・/openai-realtime/{id}/test-call | キャンペーン・電話番号に限定できる |
| 連絡先 | /contacts・/contact-lists・/opt-outs | 組織全体 |
| 電話発信 | /click-to-call | キャンペーン・電話番号に限定できる |
| キャンペーン設定 | /campaigns・/phonenumbers | 組織全体 |
| OpenAI 連携設定 | /openai-realtime。テスト発信だけは配信です | 組織全体 |
| PBX 接続 | /sip-profiles・/caller-id-prefixes | 組織全体 |

各リクエストに API キーを付けます。Authorization: Bearer <key> を推奨、代替として X-Api-Key: <key> も使えます。
curl https://hub.naruko.app/api/public/v1/me \
-H "Authorization: Bearer nrk_test_xxxxxxxx"
# {"account":{"id":1,"name":"…","status":"active","plan":null},"environment":"test"}Retry-After / X-RateLimit-* を返すので、Retry-After 秒待って再試行します。 すべて https://hub.naruko.app/api/public/v1 配下です。 「使える機能」は、API キーを発行するときに選ぶ機能です。選ばなかった機能の API を呼ぶと 403 になります。
| メソッド | パス | 使える機能 | 用途 |
|---|---|---|---|
| GET | /me | どのキーでも | 疎通確認。account と environment を返します |
| POST | /media | 配信 | 原稿のアップロード。media_id を返します |
| POST | /media/cover-sheet | 配信 | FAX 送付状の作成。media_id を返します |
| GET | /contacts | 連絡先 | 宛先の一覧・検索。q は部分一致、phone・external_id・email は完全一致です |
| POST | /contacts | 連絡先 | 宛先の登録。id を返します |
| GET | /contacts/{id} | 連絡先 | 宛先 1 件 |
| PUT | /contacts/{id} | 連絡先 | 宛先の更新。送った項目だけが変わります |
| DELETE | /contacts/{id} | 連絡先 | 宛先の削除。一覧と配信の対象から外れます |
| GET | /opt-outs | 連絡先 | 配信停止電話番号の一覧。削除した宛先の電話番号も含みます |
| POST | /opt-outs | 連絡先 | 電話番号を配信停止にする |
| DELETE | /opt-outs/{phone} | 連絡先 | 電話番号の配信停止を解除する |
| GET | /contact-lists | 連絡先 | 宛先リストの一覧 |
| POST | /contact-lists | 連絡先 | 宛先リストの作成 |
| DELETE | /contact-lists/{id} | 連絡先 | 宛先リストの削除。宛先そのものは削除されません |
| POST | /contact-lists/{id}/members | 連絡先 | 宛先リストへ宛先を追加します。追加済みの宛先は無視します |
| DELETE | /contact-lists/{id}/members/{contactId} | 連絡先 | 宛先リストから宛先を取り除きます |
| GET | /sender-numbers | 配信 | 発信元電話番号の一覧。キャンペーンに割り当て済みのものを返します |
| GET | /sms-senders | 配信 | SMS の発信元の一覧。承認済みのものを返します |
| GET | /campaigns | キャンペーン設定 | キャンペーンの一覧。割り当て済みの発信元電話番号も返します |
| POST | /campaigns | キャンペーン設定 | キャンペーンの作成 |
| DELETE | /campaigns/{id} | キャンペーン設定 | キャンペーンの削除。割り当てていた電話番号は未割当に戻ります |
| PUT | /campaigns/{id}/channels | キャンペーン設定 | 同時発信数の割当。購入済みの本数が上限です |
| POST | /campaigns/{id}/phonenumbers | キャンペーン設定 | 購入済みの電話番号をキャンペーンへ割り当てます |
| DELETE | /campaigns/{id}/phonenumbers/{phonenumber} | キャンペーン設定 | 電話番号の割当を解除します |
| PUT | /campaigns/{id}/default-sender | キャンペーン設定 | 既定の発信元を決めます |
| PUT | /campaigns/{id}/send-window | キャンペーン設定 | 送信可能時間帯の上書き |
| PUT | /campaigns/{id}/post-call-notification | キャンペーン設定 | 通話後の通知の設定 |
| PUT | /campaigns/{id}/ring-seconds | キャンペーン設定 | オートコールの呼び出し秒数の既定 |
| PUT | /campaigns/{id}/tts-gender | キャンペーン設定 | オートコールの読み上げの声の既定 |
| PUT | /campaigns/{id}/retry | キャンペーン設定 | 失敗時の再送の回数と間隔の既定 |
| PUT | /campaigns/{id}/realtime-amd | キャンペーン設定 | AI と会話する自動発信の留守番電話の判定の既定 |
| GET | /campaigns/{id}/phonenumbers/{phonenumber}/incoming | キャンペーン設定 | キャンペーンの電話番号の、現在の着信の動作 |
| PUT | /campaigns/{id}/phonenumbers/{phonenumber}/incoming | キャンペーン設定 | キャンペーンの電話番号の着信の動作を切り替えます |
| GET | /phonenumbers/{id}/incoming | 電話番号設定 | キャンペーンに属さない電話番号の、現在の着信の動作 |
| PUT | /phonenumbers/{id}/incoming | 電話番号設定 | キャンペーンに属さない電話番号の着信の動作を切り替えます |
| GET | /phonenumbers/{id}/assignment | 電話番号設定 | 電話番号の、現在の用途と使い方 |
| PUT | /phonenumbers/{id}/assignment | 電話番号設定 | 電話番号の用途を付け替えます。旧用途は外れます |
| GET | /rooms | ルーム設定 | ルームの一覧。割り当て済みの電話番号とメンバーも返します |
| POST | /rooms | ルーム設定 | ルームの作成 |
| GET | /rooms/{id}/incoming | ルーム設定 | ルームの、現在の着信の設定 |
| PUT | /rooms/{id}/incoming | ルーム設定 | ルームの着信方式・呼び出し時間・無応答時の動作を変更します |
| GET | /phonenumbers | キャンペーン設定 | 購入済みの電話番号の一覧。未割当のものも返します |
| POST | /delivery-jobs | 配信 | 一斉配信の受付。SMS・オートコール・FAX・email に対応します |
| GET | /delivery-jobs/{id} | 配信 | ジョブの状態取得 |
| GET | /delivery-jobs/{id}/deliveries | 配信 | 宛先ごとの配信結果。各行に contact_id・to_address・status・result_code が入ります |
| GET | /delivery-jobs/{id}/stats | 配信 | ジョブの集計。到達率と失敗率を返します |
| POST | /delivery-jobs/{id}/cancel | 配信 | ジョブのキャンセル |
| POST | /delivery-jobs/{id}/reschedule | 配信 | 予約日時の変更。予約中のジョブだけ変更できます |
| GET | /fax-receipts | 受信 FAX | 受信 FAX の一覧。新しい順に返します |
| GET | /fax-receipts/{id} | 受信 FAX | 受信 FAX 1 件 |
| GET | /fax-receipts/{id}/content | 受信 FAX | 受信 FAX の PDF 本文。期限はありません |
| GET | /calls | 通話履歴 | 通話履歴の一覧。新しい順に返します |
| GET | /calls/{uniqueid} | 通話履歴 | 通話 1 件 |
| GET | /phonenumbers/{id}/calls | 通話履歴 | 1 つの電話番号の通話の一覧。キャンペーンに属さない電話番号も対象です |
| GET | /openai-realtime | OpenAI 連携設定 | リアルタイムAI連携の一覧。API キーとシークレットは返しません |
| POST | /openai-realtime | OpenAI 連携設定 | 連携の作成 |
| PATCH | /openai-realtime/{id} | OpenAI 連携設定 | 連携の更新。送信した項目にだけ適用されます |
| DELETE | /openai-realtime/{id} | OpenAI 連携設定 | 連携の削除。使っている電話番号があるときは confirm が要ります |
| POST | /openai-realtime/{id}/register-webhook | OpenAI 連携設定 | Webhook URL をお使いの OpenAI プロジェクトへ登録します |
| GET | /openai-realtime/{id}/connection-check | OpenAI 連携設定 | 設定がそろっているかを項目ごとに確認します |
| GET | /openai-realtime/{id}/errors | OpenAI 連携設定 | 最近のエラーと件数。監視に使えます |
| POST | /openai-realtime/{id}/inbound-token | OpenAI 連携設定 | 着信トークンの再生成。新しい値を返します |
| POST | /openai-realtime/{id}/test-call | 配信 | テスト発信。通話料が発生します |
| POST | /click-to-call | 電話発信 | クリックトゥコール。担当者を鳴らしてから顧客へつなぎます |
| POST | /sandbox/webhook-events | どのキーでも | サンドボックスでダミー Webhook を送信。test キー専用です |
コンソールの 連絡先 で作成した宛先リスト、登録済みの宛先、電話番号のどれかを指定して送ります。受付は 202 Accepted で job_id を返し、実送信は非同期です。 Idempotency-Key を付けると、リトライ時の二重受付を防げます。キーは 48 時間有効で、同じキーで内容が違うリクエストは 409 になります。
curl -X POST https://hub.naruko.app/api/public/v1/delivery-jobs \
-H "Authorization: Bearer nrk_test_xxxxxxxx" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"send_type": "sms",
"content": { "text": "こんにちは" },
"target_spec": { "list_id": 123 }
}'
# 202 {"job_id":45,"status":"queued"}| 項目 | 指定できる値 |
|---|---|
send_type | sms / autocall / fax / email |
target_spec.list_id | 宛先リストへ送る |
target_spec.contact_ids | 宛先を 1 件ずつ指定して送る |
target_spec.phones | 電話番号を直接指定して送る。同じ電話番号の宛先があればそれを使い、無ければ登録します。test キーでも登録されます |
campaign_id | 配信ジョブを入れるキャンペーン。省略すると、発信元を割り当てたキャンペーンに入り、どちらも無ければ組織の既定のキャンペーンに入ります |
content.sms_sender_id | SMS の発信元。/sms-senders の id。省略したときの扱いは 配信の設定とキャンペーンの既定 にあります。0 を指定すると、キャンペーンの既定があっても共通の電話番号から送信します。共通の電話番号は SMS の発信元を選ぶ にあります |
| status | 意味 |
|---|---|
sent | 送信を実行した |
delivered | 到達を確認した。SMS は送信からおおむね数分以内に確定します |
failed | 1 回の試行が失敗した |
dead | 失敗が確定した。再送の上限に達したとき、または SMS が届かなかったときです |
status は Webhook で受け取るのが基本です。 お支払い方法が未登録のとき、sms / autocall / fax は 402 と payment_method_required を返します。
予約の確認のように 1 通ずつ送るときは、target_spec.phones に電話番号を指定します。宛先を先に登録する必要はありません。
curl -X POST https://hub.naruko.app/api/public/v1/delivery-jobs \
-H "Authorization: Bearer nrk_test_xxxxxxxx" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: reservation-20261120-0001" \
-d '{
"send_type": "sms",
"content": { "text": "11/20 15:00 のご予約を承りました。", "sms_sender_id": 3 },
"target_spec": { "phones": ["09000000000"] }
}'
# 202 {"job_id":46,"status":"queued","contacts":[{"phone":"09000000000","phone_e164":"+819000000000","contact_id":456}]}contacts に、指定した電話番号ごとの宛先の contact_id を返します。phone は送った値のままです。Webhook の data にも contact_id が入ります。status は suppressed、result_code は opt_out になり、Webhook は送信しません。 宛先の電話番号が利用されていなくても、配信ジョブの作成は 202 になり、送信は sent になります。届いたかどうかは数分後に確定し、 delivered か dead になります。 Webhook は delivery.sent のあとに delivery.delivered か delivery.dead が届きます。
| status | 状態 | result_code |
|---|---|---|
| queued | 配信ジョブを作成した直後 | null |
| sending | 配信事業者へ送信している | null |
| sent | 配信事業者が受け付けた。届いたかどうかは数分後に決まる | 0000 |
| delivered | 宛先の携帯電話に届いた | 0001 |
| dead | 届かなかった。到達の知らせが 48 時間以内に届かなかった場合も dead になる | 0002・0004・0034・sms_dr_expired |
result_code の 4 桁の数字は配信事業者が返す値、英字は送信しなかった理由か送信の失敗を表す値です。 dead のときは、到達ログの error_detail に届かなかった理由が入ります。
| result_code | status | 意味 |
|---|---|---|
| 0000 | sent | 配信事業者が受け付けた |
| 0001 | delivered | 届いた |
| 0002 | dead | 宛先の携帯電話に届かなかった。電源が入っていない・圏外・SMS の受信を拒否している など |
| 0004 | dead | 宛先の電話番号は利用されていない |
| 0034 | dead | 配信が取り消された |
| sms_send_failed | failed・dead | 配信事業者へ送信できなかった。再送の上限に達すると dead になります |
| sms_unsendable | dead | 本文か宛先が無いため送信していない |
| sms_dr_expired | dead | 到達の知らせが 48 時間以内に届かなかった。届いたかどうかは分からないため、送信し直す前に相手に届いているかを確認してください |
| opt_out | suppressed | 配信停止の宛先のため送信していない |
| no_address | suppressed | 宛先に SMS の電話番号が無いため送信していない |
| sandbox | delivered | test キーのため送信していない。到達として扱う |
content.sms_sender_id を省略し、キャンペーンにも既定の発信元が無ければ、共通の電話番号 050-5050-0072 から送ります。SoftBank の携帯では、携帯会社の仕様により 247450 と表示されます。承認済みの発信元から送るときは、一覧で id を確かめて指定します。 発信元に登録できるのは、代表電話などの固定電話・0120・0800・050 の電話番号です。携帯電話番号と英字の名前は登録できません。
curl https://hub.naruko.app/api/public/v1/sms-senders \
-H "Authorization: Bearer nrk_test_xxxxxxxx"
# 200 {"data":[{"id":3,"number":"0312345678","campaign_id":null}]}to_address と Webhook の to が対象です。コンソールから書き出す配信結果の CSV も同じ表記です。phone_format=e164 を指定すると +81 から始まる表記で返します。phone・phone_call・phone_sms・fax と、+81 から始まる表記の phone_e164・phone_call_e164・phone_sms_e164・fax_e164 の両方を返します。配信停止電話番号も phone と phone_e164 を返します。q は名前・電話番号・メールの部分一致です。お手元の記録から宛先を 1 件に決めるときは、完全一致の指定を使います。複数を指定した場合は、すべてに一致する宛先を返します。削除した宛先は含めません。
| 指定 | 照合 |
|---|---|
phone | 電話番号の完全一致。ハイフン・空白・+81 の違いは同じ電話番号として扱います |
phone_type | call・sms・fax のいずれか。phone と一緒に指定します。省略するとすべての電話番号と照合します |
external_id | 完全一致 |
email | 完全一致。大文字と小文字は区別しません |
phone_type に call か sms を指定すると、その種別の電話番号が登録されていない宛先は、登録時の phone で照合します。配信ジョブで target_spec.phones を指定したときと同じ宛先が見つかります。
curl "https://hub.naruko.app/api/public/v1/contacts?phone=03-1234-5678&phone_type=call" \
-H "Authorization: Bearer nrk_test_xxxxxxxx"
# 200 {"data":[{"id":456,"phone_call_e164":"+81312345678",...}],...} 更新では、送った項目だけが変わります。値を消すときは null を送ります。削除した宛先は、一覧と配信の対象から外れます。
配信停止の宛先を削除しても、その電話番号は配信停止電話番号に残り、送信しません。同じ電話番号で宛先を登録し直した場合も、配信停止になります。
# 名前だけを変える。電話番号と配信停止はそのまま
curl -X PUT https://hub.naruko.app/api/public/v1/contacts/456 \
-H "Authorization: Bearer nrk_test_xxxxxxxx" -H "Content-Type: application/json" \
-d '{"name":"山田 太郎"}'
# 配信停止にする
curl -X PUT https://hub.naruko.app/api/public/v1/contacts/456 \
-H "Authorization: Bearer nrk_test_xxxxxxxx" -H "Content-Type: application/json" \
-d '{"opt_out":true}'
# 削除する
curl -X DELETE https://hub.naruko.app/api/public/v1/contacts/456 \
-H "Authorization: Bearer nrk_test_xxxxxxxx"配信停止の宛先が持つ電話番号です。削除した宛先の電話番号も含みます。どの宛先を指定しても、この電話番号へは送信しません。
opt_out を false にした場合も、同じ電話番号の削除した宛先の配信停止を外します。# 一覧。phone で絞り込めます
curl "https://hub.naruko.app/api/public/v1/opt-outs?phone=03-1234-5678" \
-H "Authorization: Bearer nrk_test_xxxxxxxx"
# 200 {"data":[{"phone_e164":"+81312345678","contact_ids":[456]}],...}
# 配信停止にする
curl -X POST https://hub.naruko.app/api/public/v1/opt-outs \
-H "Authorization: Bearer nrk_test_xxxxxxxx" -H "Content-Type: application/json" \
-d '{"phone":"03-1234-5678"}'
# 201 {"phone_e164":"+81312345678","contact_ids":[456],"created":false}
# 解除する
curl -X DELETE https://hub.naruko.app/api/public/v1/opt-outs/+81312345678 \
-H "Authorization: Bearer nrk_test_xxxxxxxx"
# 200 {"phone_e164":"+81312345678","released_contacts":2}オートコールと FAX は、発信元電話番号をキャンペーンへ割り当て、同時発信数を決めてから送ります。 キャンペーン管理 と同じことを API でも行えます。電話番号と同時発信数の購入はコンソールで行ってください。
# 1. キャンペーンを作る
curl -X POST https://hub.naruko.app/api/public/v1/campaigns \
-H "Authorization: Bearer $NARUKO_TODOKE_KEY" -H "Content-Type: application/json" \
-d '{"name":"9 月キャンペーン"}'
# 201 {"campaign":{"id":12,...}}
# 2. 購入済みで、まだどこにも割り当てていない電話番号を探す
curl "https://hub.naruko.app/api/public/v1/phonenumbers?unassigned=1&kind=voice" \
-H "Authorization: Bearer $NARUKO_TODOKE_KEY"
# 3. 電話番号を割り当てる。1 本目は既定の発信元になります
curl -X POST https://hub.naruko.app/api/public/v1/campaigns/12/phonenumbers \
-H "Authorization: Bearer $NARUKO_TODOKE_KEY" -H "Content-Type: application/json" \
-d '{"phonenumber_id":123}'
# 4. 同時発信数を割り当てる
curl -X PUT https://hub.naruko.app/api/public/v1/campaigns/12/channels \
-H "Authorization: Bearer $NARUKO_TODOKE_KEY" -H "Content-Type: application/json" \
-d '{"channels":2}'購入済みの本数を全キャンペーンの合計が超える割当は 422 になります。
組織ごとに最初から用意してある「既定のキャンペーン」は、削除と送信可能時間帯の上書きができず、どちらも 422 になります。既定のキャンペーンの送信可能時間帯は、組織全体の送信可能時間帯を使います。「既定のキャンペーン」と同じ名前のキャンペーンは作れません。
下の設定は content で配信ごとに指定します。 省略するとキャンペーンの既定に従い、キャンペーンにも既定が無ければ表の「全体の既定」です。 範囲外・候補にない値は 422 になります。 キャンペーンの既定は表の API に値を送信して設定し、null で解除します。
| content のキー | 指定できる値 | 全体の既定 | キャンペーンの既定 |
|---|---|---|---|
retry_max | 送信に失敗したときに送信し直す回数。0〜5 の整数。オートコールは発信できなかったときのみ送信し直し、無応答・話中では送信し直しません | 2 | PUT /campaigns/{id}/retry |
retry_interval_minutes | 送信し直す間隔の分数。1〜60 の整数。SMS・FAX は回数に比例して間隔が延びます | SMS・FAX は 5・オートコールは 1 | PUT /campaigns/{id}/retry |
send_window | 送信可能時間帯。enabled・skip_holidays・days を PUT /campaigns/{id}/send-window と同じ形で指定します。SMS・オートコール・FAX で使えます | 組織の送信可能時間帯 | PUT /campaigns/{id}/send-window |
sms_sender_id | SMS の発信元。/sms-senders の id。キャンペーンの既定は、キャンペーンに割り当てた承認済みの発信元から選びます | 共通の電話番号 | PUT /campaigns/{id}/default-sender に sms_sender_id |
ring_seconds | 相手を呼び出す秒数。10〜60 の整数。経過すると発信を打ち切り、result_code が no_answer になります | 30 | PUT /campaigns/{id}/ring-seconds |
tts_gender | 読み上げの声。female か male。本文・プッシュ応答・電話アンケートの読み上げに使います | female | PUT /campaigns/{id}/tts-gender |
realtime_amd | AI と会話する自動発信の留守番電話の判定。true か false | false | PUT /campaigns/{id}/realtime-amd |
curl -X POST https://hub.naruko.app/api/public/v1/delivery-jobs \
-H "Authorization: Bearer nrk_test_xxxxxxxx" -H "Content-Type: application/json" \
-d '{
"send_type": "autocall",
"content": {
"text": "ご予約の確認です。",
"sender_phonenumber_id": 123,
"ring_seconds": 45,
"tts_gender": "male"
},
"target_spec": { "contact_ids": [456] }
}'
curl -X PUT https://hub.naruko.app/api/public/v1/campaigns/12/tts-gender \
-H "Authorization: Bearer nrk_test_xxxxxxxx" -H "Content-Type: application/json" \
-d '{"tts_gender": "male"}'content.mode に realtime を指定すると、読み上げではなく AI が応答します。 話す内容は リアルタイムAI連携 に設定した応答の指示で決まるため、読み上げ本文も音声ファイルも要りません。
curl -X POST https://hub.naruko.app/api/public/v1/delivery-jobs \
-H "Authorization: Bearer $NARUKO_TODOKE_KEY" -H "Content-Type: application/json" \
-d '{
"send_type": "autocall",
"content": {
"mode": "realtime",
"realtime_integration_id": 7,
"realtime_amd": true,
"sender_phonenumber_id": 123
},
"target_spec": { "contact_ids": [456] }
}'| 項目 | 意味 |
|---|---|
realtime_integration_id | どの連携で会話させるか。指定が無いと 422 になります |
realtime_amd | 留守番電話の判定。有効にすると、人が応答したと判定できたときだけ AI へつなぎます。判定には数秒を要し、その間は無音になります |
sender_phonenumber_id | 発信元電話番号。電話番号ごとの応答の指示もこれで決まります |
オートコールの通話が終わったあと、結果に応じて SMS と Webhook で本文を送信します。 content.post_call_notification を省略するとキャンペーンの設定を使い、 null を指定するとこの配信では送信しません。 キャンペーンの設定は PUT /campaigns/{id}/post-call-notification で同じ形を送信します。
curl -X POST https://hub.naruko.app/api/public/v1/delivery-jobs \
-H "Authorization: Bearer nrk_test_xxxxxxxx" -H "Content-Type: application/json" \
-d '{
"send_type": "autocall",
"content": {
"text": "ご予約の確認です。ご予約どおりなら 1 を、変更なら 2 を押してください。",
"ivr": { … },
"sender_phonenumber_id": 123,
"post_call_notification": {
"messages": {
"answered": "ご予約の確認のお電話でした。",
"unanswered": "ご予約の確認でお電話しました。",
"dtmf": { "1": "ご予約を確定しました。", "2": "変更はこちらから: https://example.com/r" }
},
"sms": { "sms_sender_id": 12 },
"webhook": { "endpoint_id": 34 }
}
},
"target_spec": { "contact_ids": [456] }
}'| 項目 | 送信するとき |
|---|---|
messages.answered | 応答。本文を決めていない回答のときも、この本文を送信します |
messages.unanswered | 無応答。応答が無い・話中・発信に失敗のとき |
messages.dtmf | 回答。相手が押した数字ごとの本文で、最初に押した数字で決まります |
sms | 宛先の SMS 用の電話番号へ送信します。料金は通常の SMS と同じです |
webhook | request_timing が post_call.notification の通知を送信します。組み立てJSON形式では {{ message }} に本文が入ります |
OpenAI のプロジェクト ID や API キーを API から設定できます。 使える機能で OpenAI 連携設定 を選んだキーが必要です。 更新は送信した項目にだけ適用されます。
# 連携の一覧。API キーと Webhook シークレットは返りません
curl https://hub.naruko.app/api/public/v1/openai-realtime \
-H "Authorization: Bearer $NARUKO_TODOKE_KEY" -H "Accept: application/json"
# プロジェクト ID を変更する
curl -X PATCH https://hub.naruko.app/api/public/v1/openai-realtime/7 \
-H "Authorization: Bearer $NARUKO_TODOKE_KEY" -H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"openai_project_id":"proj_xxxxxxxxxxxx"}'
# Webhook URL をお使いの OpenAI プロジェクトへ登録する
curl -X POST https://hub.naruko.app/api/public/v1/openai-realtime/7/register-webhook \
-H "Authorization: Bearer $NARUKO_TODOKE_KEY" -H "Accept: application/json"
# 設定がそろっているかを項目ごとに確認する。電話は発生しません
curl https://hub.naruko.app/api/public/v1/openai-realtime/7/connection-check \
-H "Authorization: Bearer $NARUKO_TODOKE_KEY" -H "Accept: application/json"
# 1 件だけ発信して、AI と会話できるかを確かめる
curl -X POST https://hub.naruko.app/api/public/v1/openai-realtime/7/test-call \
-H "Authorization: Bearer $NARUKO_TODOKE_KEY" -H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"callee":"09000000000"}'
Webhook URL の登録は何度でも実行できます。同じ URL がすでに登録されている場合は、登録内容を変更しません。 既に他の URL の登録がある場合は、既存の登録は変更されず、この Webhook URL が追加登録されます。
テスト発信は実際に電話を発信するため、通話料が発生し、同時発信数の枠を 1 ch 使います。 使える機能で 配信 を選んだキーが必要です。結果は配信ジョブとして確認できます。 発信元はこの連携を使っていてキャンペーンに割り当て済みの電話番号から選ばれ、候補が複数あるときは sender_phonenumber_id で指定します。
openai_api_key と openai_webhook_secret は設定できますが、取得はできません。 設定済みかどうかは config.has_api_key で判断します。
CRM や Excel マクロから「担当者 → 顧客」の 2 レグ発信を起こせます。先に担当者を鳴らし、応答したあとで顧客へダイヤルしてつなぎます。 発信元電話番号は from_phonenumber_id で指定します。お使いの組織が保有する電話番号だけを指定できます。
curl -X POST https://hub.naruko.app/api/public/v1/click-to-call \
-H "Authorization: Bearer $NARUKO_TODOKE_KEY" \
-H "Content-Type: application/json" \
-d '{"from_phonenumber_id": 123, "agent": "2001", "callee": "0312349003", "caller_id": "0312340000"}'
# 202 {"accepted":true,"call_id":"c2c_XXXXXXXX"}| 用意するもの | 内容 |
|---|---|
| キャンペーンと電話番号 | 送信の発信元になり、受信もこの電話番号で受けます |
| 配信チャネル | ⚠️ 割り当てが 0 のキャンペーンでは FAX を送信できません。同時に送れる数も割り当てた数までです |
| API キー | 送信は test でも試せますが、受信は live のみです |
配信ジョブは宛先の IDと発信元電話番号の IDで指定します。 どちらも API で引けます。
# 宛先を登録する。external_id はお使いのシステムの顧客 ID と突き合わせるために使えます
curl -X POST https://hub.naruko.app/api/public/v1/contacts \
-H "Authorization: Bearer $NARUKO_TODOKE_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"山田商店","fax":"0312345678","external_id":"cust-001"}'
# 201 {"contact":{"id":789,"fax_e164":"+81312345678", ...}}
# 発信元電話番号を引く。FAX 用でキャンペーンに割り当て済みのものが返ります
curl "https://hub.naruko.app/api/public/v1/sender-numbers?kind=fax" \
-H "Authorization: Bearer $NARUKO_TODOKE_KEY"
# {"data":[{"id":456,"number":"0312345600","kind":"fax","campaign_id":12}]} ① 原稿の PDF をアップロードして media_id をもらう → ② その ID を指定して配信ジョブを投げます。1 つの原稿を宛先リストへ一斉送信できます。
# ① 原稿の PDF をアップロードする。PDF のみ・最大 20MB
curl -X POST https://hub.naruko.app/api/public/v1/media \
-H "Authorization: Bearer $NARUKO_TODOKE_KEY" \
-F "file=@invoice.pdf"
# 201 {"media_id":123,"pages":2}
# ② FAX の配信ジョブを投げる
curl -X POST https://hub.naruko.app/api/public/v1/delivery-jobs \
-H "Authorization: Bearer $NARUKO_TODOKE_KEY" \
-H "Content-Type: application/json" \
-d '{
"send_type": "fax",
"content": { "media_id": 123, "sender_phonenumber_id": 456 },
"target_spec": { "list_id": 45 }
}'
# 202 {"job_id":67,"status":"queued"}| FAX だけの決まり | 内容 |
|---|---|
content.media_id | 原稿。必須です |
content.sender_phonenumber_id | 発信元電話番号。必須です |
| 宛先 | 連絡先の FAX 番号。入っていない宛先は送信されません |
| 原稿の形式 | PDF のみ・最大 20MB。送信用の形式への変換は Naruko 側で行います |
| 同時に送れる数 | 配信チャネルの割り当て数まで。割り当てが無いと 422 と todoke_channels_required を返します。⚠️ 超えた分は失敗にせず順番待ちになります |
| 失敗した宛先 | 既定で 2 回まで自動で再送します。回数と間隔は content.retry_max・content.retry_interval_minutes で変更できます。確定失敗は delivery.dead で通知されます |
送付状を付けるときは POST /media/cover-sheet を使います。 本文の書類を document に入れて一緒に送ると 結合した 1 つの PDF になり、 media_id が返るので、そのまま配信ジョブへ渡せます。 ⚠️ 1 通あたりのページ上限を超えると 422 で返ります。
FAX のキャンペーンに割り当てた電話番号へ着信すると、fax.received が 登録した Webhook に届きます。
{
"event": "fax.received",
"data": {
"fax_recv_id": 123,
"campaign_id": 45,
"campaign_name": "請求書送付キャンペーン",
"caller_phonenumber": "+81312349001",
"received_at": "2026-08-29T10:00:00+09:00",
"download_url": "https://...",
"fields": { "金額": "120,000", "請求書番号": null }
}
}environment=test で登録した URL には届きません。download_url は24 時間で期限切れになります。受け取ったあとすぐに取得して、お客様のシステム側に保存してください。取得に失敗したときは null で届きます。 FAX の電話番号ごとに読み取る項目の名前を登録すると、 受信した PDF から AI がその項目を読み取り、fields に入れて返します。 設定は「共通」→「電話番号」の、その電話番号のカードの中です。読み取る項目と、読み取りに使う OpenAI のキーを同じ場所で登録します。
null で返します。当て推量の値は入れません。fields は空です。

受信サーバーが停止していたなどで Webhook を取りこぼしたときは、 GET /fax-receipts でいつでも一覧を引き直せます。 項目名は fax.received と同じです。
curl https://hub.naruko.app/api/public/v1/fax-receipts?since=2026-09-01T00%3A00%3A00%2B09%3A00 \
-H "Authorization: Bearer nrk_live_..."
# PDF は期限を気にせずこちらから取得できます
curl https://hub.naruko.app/api/public/v1/fax-receipts/123/content \
-H "Authorization: Bearer nrk_live_..." -o fax.pdfcampaign_id / since / until / per_page です。1 ページの件数は最大 100 です。+09:00 の + はそのままだと空白として解釈されます。download_url は 24 時間で期限切れですが、/content は期限がありません。 キャンペーンに割り当てた電話番号の着信とオートコールの発信について、 いつ終わったか・応答したか・何秒話したかを API で確認できます。 direction で inbound / outbound に絞り込めます。
通話が終わったかは、通話 ID で引いて結果が返るかで判定します。 通話の記録は通話が終わった時点で書き込まれるため、通話中は 404 になります。
calldate_end が必ず入っています。終了の判定には使えません。404 は、対象外の電話番号や存在しない通話 ID でも返ります。終了を待つために再試行を続けないでください。incoming_call_hangup を使います。API は、受け取れなかった通話を引き直すときに使います。 キャンペーンに属さない電話番号の通話は、電話番号を指定して /phonenumbers/{id}/calls で取得します。 行の形は同じで、direction はその電話番号から見た向きです。
1 つの通話が、複数の行に分かれることがあります。 同じ通話の行は、同じ uniqueid を持ちます。 例えば、AI が応答できず外線へ転送した通話は、次の 2 行になります。
| 行 | action | stage | call_status |
|---|---|---|---|
| AI へつないだ行 | realtime_ai | null | NO ANSWER |
| 外線へ転送した行 | transfer | fallback | ANSWERED |
ルームのメンバーを順に呼び出したときも、呼び出しごとに 1 行になります。応答しなかった呼び出しも行として含まれます。 通話全体の結果は 1 行にまとめていません。行ごとの call_status で確かめてください。
# 期間で引く
curl "https://hub.naruko.app/api/public/v1/calls?since=2026-09-01T00%3A00%3A00%2B09%3A00" \
-H "Authorization: Bearer nrk_live_..."
# 通話 ID で引く
curl https://hub.naruko.app/api/public/v1/calls/1700000000.42 \
-H "Authorization: Bearer nrk_live_..."# 電話番号を指定して引く
curl https://hub.naruko.app/api/public/v1/phonenumbers/34/calls \
-H "Authorization: Bearer nrk_live_..."{
"data": [
{
"uniqueid": "1700000000.42",
"direction": "outbound",
"calldate": "2026-09-20T12:52:04+09:00",
"calldate_answer": "2026-09-20T12:52:13+09:00",
"calldate_end": "2026-09-20T12:53:00+09:00",
"call_status": "ANSWERED",
"caller_phonenumber": "0312340000",
"callee_phonenumber": "0312349003",
"call_duration": 47,
"action": "transfer",
"stage": "fallback",
"campaign_id": 11,
"campaign_name": "AI受付"
},
{
"uniqueid": "1700000000.42",
"direction": "inbound",
"calldate": "2026-09-20T12:51:44+09:00",
"calldate_answer": null,
"calldate_end": "2026-09-20T12:52:04+09:00",
"call_status": "NO ANSWER",
"caller_phonenumber": "0312345678",
"callee_phonenumber": "0312340000",
"call_duration": 0,
"action": "realtime_ai",
"stage": null,
"campaign_id": 11,
"campaign_name": "AI受付"
}
],
"total": 2
}| action | その行でしたこと |
|---|---|
| room | ルームのメンバーを呼び出しました |
| extension | 内線を呼び出しました |
| outbound | アプリ・電話機から外線へ発信しました |
| trunk | お使いの PBX とトランクでつなぎました。発信か着信かは direction で分かります |
| transfer | 外線へ転送しました |
| ivr | IVR の音声メニューで受けました |
| voicemail | 留守電で受けました |
| ai_agent | AIエージェントへつなぎました |
| realtime_ai | リアルタイムAI連携へつなぎました |
| autocall | オートコールで発信しました |
| fax | FAX を送信または受信しました。どちらかは direction で分かります |
| click_to_call | クリックトゥコールで発信しました |
| busy | 話中を返しました |
| blocked | 着信を拒否しました |
| null | 上のどれにも当たらない行です |
| stage | 意味 |
|---|---|
| fallback | 最初の動作で応答できず、次の動作へ進んだ行です。たとえば、AI が応答できずに外線へ転送した行や、ルームのメンバーが応答せずに留守電へ進んだ行です |
| null | 最初の動作の行です |
| 値 | 意味 |
|---|---|
| ANSWERED | 応答して通話が成立しました。 |
| NO ANSWER | 呼び出しましたが、応答がないまま終わりました。 |
| BUSY | 話中を返しました。AI 応答やルームへの着信で応答が間に合わなかったとき、チャネルが足りなかったときもこの値になります。 |
| FAILED | 接続できないまま終わりました。 |
| パラメータ | 説明 |
|---|---|
| uniqueid | 1 つの通話に絞り込みます。着信 Webhook で受け取った uniqueid をそのまま渡せます。 |
| direction | 通話の向きで絞り込みます。inbound か outbound を指定します。 |
| campaign_id | キャンペーンで絞り込みます。 |
| since | この時刻以降に始まった通話。日時は URL エンコードしてください。+09:00 の + は、そのままだと空白として解釈されます。 |
| until | この時刻までに始まった通話。書き方は since と同じです。 |
| per_page | 1 ページの件数。1 から 100 まで指定でき、既定は 50 です。 |
caller_phonenumber、転送先が callee_phonenumber になり、direction は outbound です。電話番号に着信したときの動作と、電話番号の用途を、API で取得・変更できます。 お使いのシステムに障害が発生した際に、AI による応答から担当者への転送へ切り替える用途を想定しています。 設定の保存と入力の検証は、管理画面と同じ処理で行います。
キャンペーンの電話番号は /campaigns/{id}/phonenumbers/{phonenumber}/incoming、 それ以外の電話番号は /phonenumbers/{id}/incoming を使用します。 誤った API を使用した場合は 409 を返し、使用すべき API をお知らせします。
# 1. 現状の設定を確認し、保存する
curl https://hub.naruko.app/api/public/v1/campaigns/12/phonenumbers/34/incoming \
-H "Authorization: Bearer nrk_live_..."
# {"data":{"phonenumber_id":34,"action":"realtime_ai","realtime_ai_target":"i3",...}}
# 2. 外線転送へ切り替える
curl -X PUT https://hub.naruko.app/api/public/v1/campaigns/12/phonenumbers/34/incoming \
-H "Authorization: Bearer nrk_live_..." -H "Content-Type: application/json" \
-d '{"action":"transfer","transfer_to":"0312345678","transfer_timeout":30}'
# 3. 復旧後、1 で取得した値を送信して元の設定に戻す
curl -X PUT https://hub.naruko.app/api/public/v1/campaigns/12/phonenumbers/34/incoming \
-H "Authorization: Bearer nrk_live_..." -H "Content-Type: application/json" \
-d '{"action":"realtime_ai","realtime_ai_target":"i3"}'取得時の項目名は、変更時に送信する項目名と同じです。取得した値をそのまま送信すると、元の設定に戻せます。
| action | 一緒に送る値 | 動作 |
|---|---|---|
| busy | なし | 話中で切断します |
| transfer | transfer_to・transfer_timeout | 外線へ転送します。呼び出しの待ち時間は 5〜120 秒で指定します |
| room | room_id | ルームで着信を受けます |
| ivr | ivr_id | IVR で着信を受けます |
| realtime_ai | realtime_ai_target | リアルタイム応答。値は「i」に続けて連携の ID を指定します |
| trunk | trunk_id | トランクへ転送します |
| schedule | schedule | 着信スケジュールにより、営業時間内と時間外で動作を切り替えます |
transfer と realtime_ai は、キャンペーンの電話番号でのみ選択できます。
電話番号の割り当て先を、ルーム・トランク・キャンペーンの間で変更します。変更すると、元の割り当ては解除されます。 対象は組織が保有するすべての電話番号で、API キーには「電話番号設定」の機能が必要です。
curl -X PUT https://hub.naruko.app/api/public/v1/phonenumbers/34/assignment \
-H "Authorization: Bearer nrk_live_..." -H "Content-Type: application/json" \
-d '{"target":"room","target_id":5}'
# {"data":{"phonenumber_id":34,"number":"0312340001","target":"room","target_id":5,"usage":"voice"}}| 項目 | 説明 |
|---|---|
| target | room・trunk・campaign・none のいずれかを指定します。none はどこにも割り当てません |
| target_id | 割り当て先のルーム・トランク・キャンペーンの ID。none 以外の場合は必須です |
| usage | voice・fax・ivr のいずれかを指定します。省略した場合は、現在の使い方を維持します |
オーナーとメンバーは、組織のユーザーのメールアドレスで指定します。API キーには「ルーム設定」の機能が必要です。 作成したルームへ電話番号を割り当てる場合は、上の「用途を変更する」を使います。
curl -X POST https://hub.naruko.app/api/public/v1/rooms \
-H "Authorization: Bearer nrk_live_..." -H "Content-Type: application/json" \
-d '{"name":"受付","owner_email":"owner@example.com","member_emails":["staff@example.com"]}'
# {"data":{"id":5,"name":"受付","type":"normal","phonenumber":null,"members":[...],"created_at":"..."}}| 項目 | 説明 |
|---|---|
| name | ルーム名 |
| owner_email | オーナーにするユーザーのメールアドレス |
| member_emails | メンバーにするユーザーのメールアドレスの配列。省略できます |
電話番号を割り当てたルームで設定できます。指定した項目だけを変更します。音声再生で再生する音声は、ルーム管理の画面で登録します。
curl -X PUT https://hub.naruko.app/api/public/v1/rooms/5/incoming \
-H "Authorization: Bearer nrk_live_..." -H "Content-Type: application/json" \
-d '{"incoming_mode":"queue","ring_timeout":60,"no_answer_action":"voicemail"}'| 項目 | 説明 |
|---|---|
| incoming_mode | 着信方式。queue は一斉呼び出し、queue_linear は順次呼び出し、confbridge は会議呼び出し、none は呼び出さない、announce は音声再生です |
| ring_timeout | 無応答時の動作へ切り替えるまでの秒数。5〜120 |
| no_answer_action | 無応答時の動作。voicemail は留守電、ai_agent は AIエージェント、external_forward は外線転送、hangup は切断です |
| no_answer_forward_number | 外線転送の転送先の電話番号。external_forward の場合は必須です |
コンソールの Webhook 画面 で通知先 URL と購読イベントを登録し、whsec_… で始まる署名鍵を控えます。 通知形式は JSON をそのまま送る raw のほか、Slack・Microsoft Teams・LINE 公式アカウント のテンプレートも選べるので、受信サーバーを用意しなくても既存のチャットツールへ通知できます。
通知先の API が決まった形の JSON を求める場合は、通知形式に「組み立てJSON形式」を選び、送信する JSON を書きます。 文字列の中に {{ to }} のように書いた箇所へ、通知の値が入ります。 値だけを書いた箇所は、数値や null をそのまま入れます。 認証に使う値は、JSON の中に書くか、ヘッダーとして追加します。どちらも暗号化して保存します。 署名の X-Webhook-Signature ヘッダーは付けません。
{
"id": "your-id",
"password": "your-password",
"phone_num": "{{ to }}",
"text": "ご回答 {{ dtmf_response }} を受け付けました。",
"job": "{{ job_id }}"
}| 差し込める値 | 使える通知 | 内容 |
|---|---|---|
| {{ event_id }} | すべての通知 | 通知の ID |
| {{ request_timing }} | すべての通知 | 通知の種類。delivery.delivered など |
| {{ created_at }} | すべての通知 | 通知の日時 |
| {{ environment }} | すべての通知 | live・test |
| {{ to }} | 配信の通知・通話後の通知 | 宛先の電話番号 |
| {{ status }} | 配信の通知・通話後の通知 | 配信の状態。sent・delivered・failed・dead |
| {{ result_code }} | 配信の通知・通話後の通知 | 結果のコード。SMS の値は「SMS の配信結果」の表のとおり |
| {{ dtmf_response }} | 配信の通知・通話後の通知 | オートコールで押された数字 |
| {{ amd_detection }} | 配信の通知・通話後の通知 | オートコールの留守番電話の判定 |
| {{ send_type }} | 配信の通知・通話後の通知 | sms・autocall・fax・email |
| {{ job_id }} | 配信の通知・通話後の通知 | 配信ジョブの ID |
| {{ delivery_id }} | 配信の通知・通話後の通知 | 宛先ごとの配信の ID |
| {{ contact_id }} | 配信の通知・通話後の通知 | 宛先の ID |
| {{ fax_recv_id }} | FAX の受信 | 受信した FAX の ID |
| {{ campaign_id }} | FAX の受信・リアルタイムAI連携の失敗 | キャンペーンの ID |
| {{ campaign_name }} | FAX の受信 | キャンペーンの名前 |
| {{ caller_phonenumber }} | FAX の受信 | 送信元電話番号 |
| {{ received_at }} | FAX の受信 | 受信した日時 |
| {{ download_url }} | FAX の受信 | FAX の PDF をダウンロードする URL |
| {{ uniqueid }} | リアルタイムAI連携の失敗 | 通話の ID |
| {{ integration_id }} | リアルタイムAI連携の失敗 | リアルタイムAI連携の ID |
| {{ integration_name }} | リアルタイムAI連携の失敗 | リアルタイムAI連携の名前 |
| {{ direction }} | リアルタイムAI連携の失敗 | inbound・outbound |
| {{ stage }} | リアルタイムAI連携の失敗 | どの段階で応答できなかったか |
| {{ reason_code }} | リアルタイムAI連携の失敗 | 理由のコード |
| {{ reason }} | リアルタイムAI連携の失敗 | 理由 |
| {{ callee_phonenumber }} | リアルタイムAI連携の失敗 | 着信先電話番号。着信のときだけ |
| {{ fallback_action }} | リアルタイムAI連携の失敗 | AI が応答できなかったあとに進んだ動作 |
| {{ occurred_at }} | リアルタイムAI連携の失敗 | 発生した日時 |
| {{ condition }} | 通話後の通知 | 通話後の通知の条件。answered・unanswered・dtmf_1 など |
| {{ message }} | 通話後の通知 | 通話後の通知の本文 |
| request_timing | 意味 |
|---|---|
| delivery.sent | 送信を実行した。SMS では配信事業者が受け付けた段階で、届いたかどうかは delivery.delivered か delivery.dead で決まる |
| delivery.delivered | 到達を確認した |
| delivery.failed | 1 回の試行が失敗した |
| delivery.dead | 失敗が確定した |
| fax.received | FAX を受信した |
| realtime.failed | リアルタイム応答で AI が応答できなかった |
raw で受け取る場合のペイロード例:
{
"id": "evt_XXXXXXXX",
"request_timing": "delivery.delivered",
"created_at": "2026-07-06T09:00:00+09:00",
"environment": "live",
"data": {
"delivery_id": 987,
"job_id": 45,
"contact_id": 456,
"send_type": "sms",
"to": "09000000000",
"status": "delivered",
"result_code": null
}
}data.to は日本の電話番号なら 0 から始まる形式で、国外の電話番号は + から始まります。 id を冪等キーにして二重処理を防いでください。2xx を返すと、この通知は送信済みになります。
raw には X-Webhook-Signature ヘッダが付きます。 署名対象は "{t の値}.{raw データ}" の HMAC-SHA256 を 16 進で表したものです。 ヘッダは t=<unix秒>,v1=<hex> の形式です。 検証は raw データのまま行ってください。
PHP
use Naruko\Todoke\WebhookSignature;
$payload = file_get_contents('php://input');
$header = $_SERVER['HTTP_X_WEBHOOK_SIGNATURE'] ?? '';
if (! WebhookSignature::verify($payload, $header, getenv('WEBHOOK_SECRET'))) {
http_response_code(400); exit;
}
$event = json_decode($payload, true);
// $event['request_timing'] = delivery.sent | delivery.delivered | delivery.failed | delivery.dead
// $event['id'] を冪等キーにして二重処理を防ぐ。2xx を返すと配信成功。Node.js
const crypto = require("crypto");
function verify(rawBody, header, secret, toleranceSec = 300) {
const parts = Object.fromEntries(header.split(",").map((p) => p.trim().split("=")));
if (!parts.t || !parts.v1) return false;
if (Math.abs(Date.now() / 1000 - Number(parts.t)) > toleranceSec) return false;
const expected = crypto
.createHmac("sha256", secret)
.update(`${parts.t}.${rawBody}`)
.digest("hex");
return crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(parts.v1));
}test キーなら、メッセージを送らずに Webhook 連携を試せます。 POST /sandbox/webhook-events がダミーの配信イベントを、 登録済みの test Webhook エンドポイントへ実際に署名付きで送ります。メッセージは送信されず、料金も発生しません。
curl -X POST https://hub.naruko.app/api/public/v1/sandbox/webhook-events \
-H "Authorization: Bearer nrk_test_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"request_timing":"delivery.sent"}'
# {"event_id":"evt_…","request_timing":"delivery.sent","environment":"test","endpoints_notified":1}X-Webhook-Signature 付きで届き、data.sandbox=true が入ります。上の署名検証をそのまま試せます。| メソッド | パス | 用途 |
|---|---|---|
| GET | /sip-profiles | 一覧・検索。?tag=タグ / ?q=label で部分一致 |
| POST | /sip-profiles | 登録。201 を返します |
| GET | /sip-profiles/{id} | 1 件取得 |
| PUT | /sip-profiles/{id} | 編集 |
| DELETE | /sip-profiles/{id} | 削除 |
入力フィールドはいずれも任意です。 label・ display_name・ server・ sip_domain・ transport・ username・ password ほか。 tags と codecs は配列で渡します。
curl -X POST https://hub.naruko.app/api/public/v1/sip-profiles \
-H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
-d '{"label":"本社","tags":["営業","東京"],"server":"sip.example.jp","username":"u1","password":"p1"}'?tag=営業 でタグ絞り込み検索ができます。has_credentials で判断します。| メソッド | パス | 用途 |
|---|---|---|
| GET | /caller-id-prefixes | 一覧・検索。?q=prefix / name で部分一致 |
| POST | /caller-id-prefixes | 登録。並び順は自動で採番し、201 を返します |
| GET | /caller-id-prefixes/{id} | 1 件取得 |
| PUT | /caller-id-prefixes/{id} | 編集 |
| DELETE | /caller-id-prefixes/{id} | 削除 |
入力フィールドは prefix と name が必須、 emoji は任意です。 prefix に使えるのは数字と *# だけです。