通話

現在の通話を取得beta

この機能はクローズドベータ版です。ワークスペースでの利用を希望する場合は、テクニカルサポートにお問い合わせください。

現在は WhatsApp の1対1音声・ビデオ通話のみ対応しています。本システムが管理する通話を返します。なければ data: {}。WhatsApp モバイルアプリでの通話中状態は判定できません。

GEThttps://api.unifyport.ai/v1/calls/active

対応チャネル

呼び出す前に

対象ワークスペースの X-Api-Key をサーバー側で使用します。実行前にすべてのプレースホルダーを置き換えます。

ワークスペースの非公開ベータ利用資格を確認します。通話作成前に WhatsApp の認証を完了し、runtime_status=running を確認してください。相手には現在のアカウントに属する個人会話の conversation_id を使います。

パラメーターの取得元

account_id: アカウント作成・取得応答の data.id を使います。識別子は X-Api-Key のワークスペースに属します。アカウント取得

リクエストパラメータ

ヘッダー

X-Api-Key

string必須

ワークスペース API キー。このヘッダーからワークスペースを特定します。

クエリパラメータ

account_id

string必須

現在のワークスペースのアカウント ID。

pattern: ^acc_[A-Za-z0-9][A-Za-z0-9_-]*$

リクエストボディ

このエンドポイントは JSON ボディを必要としません。

結果の確認

UnifyPort が現在管理している通話の call_id/state を確認します。data={} は該当する通話が見つからないことを表しますが、双方の WhatsApp モバイルアプリで通話中かどうかは判断できません。

レスポンス 200 · active

{
  "request_id": "req_example",
  "data": {
    "call_id": "call_example",
    "state": "active",
    "direction": "inbound",
    "media_type": "voice"
  }
}

レスポンス 200 · idle

{
  "request_id": "req_example",
  "data": {}
}

レスポンスボディ

call_id

string

通話 ID。切断にも使用します。

maxLength: 128

state

string

現在の通話状態。

enum: preparing, dialing, ringing, connecting, active

direction

string

通話の方向。

enum: inbound, outbound

media_type

string

voice は音声、video はビデオ対応通話。

enum: voice, video

レスポンス

200

200 · active

リクエスト成功。レスポンスボディの例を参照してください。

400

Bad Request

リクエストボディ、パス、またはパラメータが不正です。

401

Unauthorized

X-Api-Key ヘッダが欠落しているか無効です。

403

Forbidden

リクエストは識別されましたが、この操作は許可されていません。

404

Not Found

要求されたリソースが見つかりません。error.code と現在の操作を合わせて確認してください。

409

Conflict

要求された操作が、既存のプロバイダアカウントまたはリソースと競合しています。

500

Internal Server Error

サービスで予期しないエラーが発生しました。

501

Not Implemented

選択したプロバイダはこの操作を実装していません。

502

Bad Gateway

プロバイダアダプタまたは上流サービスが操作を完了できませんでした。

503

Service Unavailable

必要なバックエンドサービスが一時的に利用できません。

失敗時の対応

HTTP 状態と error.code/numeric_code を確認し、request_id を保存します。ベータ資格、アカウント、call_id を確認します。作成が競合した場合は現在の通話を取得し、作成や切断の再試行前に状態を確認してください。エラーリファレンス

invalid_request · 10000 · 400: 必須項目、形式、チャネルの条件を確認して修正します。
missing_api_key · 11000 · 401: X-Api-Key とワークスペースの有効性を確認します。
invalid_api_key · 11001 · 401: X-Api-Key とワークスペースの有効性を確認します。
account_not_found · 20020 · 404: account_id を確認し、アカウントが属するワークスペースの X-Api-Key を使います。このワークスペースにないアカウントには現在のキーでアクセスできません。
unsupported_by_provider · 30003 · 501: チャネル能力ガイドを確認し、対応するチャネルまたは操作を選びます。再送しても対応範囲は変わりません。
beta_feature_not_enabled · 41002 · 403: 技術サポートにワークスペースの非公開ベータ利用を申請します。再送やリクエスト内の is_beta の変更では利用資格は得られません。