API リファレンス

Groups

参加リクエスト一覧

参加承認が有効なグループの保留中リクエストを一覧します。group_id はクエリパラメータで渡します。上流のプッシュ通知は保証されないため、本エンドポイントのポーリングを正としてください。

GEThttps://api.unifyport.ai/v1/accounts/{account_id}/groups/join-requests

呼び出す前に

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

パラメーターの取得元
account_id
アカウント作成・取得応答の data.id を使います。識別子は X-Api-Key のワークスペースに属します。 アカウント取得
group_id
操作対象のグループ — List groups が返す id。プロバイダの id には @ や : が含まれる可能性があるため、クエリ文字列で渡します。

リクエストパラメータ

ヘッダー

X-Api-Key
string必須

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

パスパラメータ

account_id
string必須

groups ルートで使用される識別子。

クエリパラメータ

group_id
string必須

操作対象のグループ — List groups が返す id。プロバイダの id には @ や : が含まれる可能性があるため、クエリ文字列で渡します。

リクエストボディ

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

結果の確認

記載された応答項目と HTTP 状態を確認します。204 成功には本文がありません。診断には X-Request-Id を使い、次は関連操作を参照します。

レスポンス 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "group_id": "group_example",
    "items": [
      {
        "id": "member_example",
        "phone": "8613912345678",
        "requested_at": "2026-06-08T12:34:56Z"
      }
    ]
  }
}

レスポンスボディ

id
string

参加リクエスト識別子。承認または却下時に member_ids として渡します。

phone
string

リクエスト者の電話番号（プロバイダが公開している場合）。

lid
string

利用可能な場合のリクエスト者のプロバイダ LID。

requested_at
string

参加がリクエストされた時刻の RFC3339 タイムスタンプ。

format: date-time

group_id
string

参加リクエストが属するグループ。

レスポンス

200

200 OK

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

400

Bad Request

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

401

Unauthorized

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

404

Not Found

要求されたプロバイダリソースが見つかりません。

409

Conflict

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

500

Internal Server Error

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

501

Not Implemented

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

502

Bad Gateway

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

失敗時の対応

HTTP 状態と error.code/numeric_code を確認し、request_id を保存します。原因に応じてパラメーター修正・認証・状態確認を行い、送信や書き込みの再試行前に前回の結果を確認します。 エラーリファレンス

invalid_request · 10000 · 400
必須項目、形式、チャネルの条件を確認して修正します。
invalid_api_key · 11001 · 401
X-Api-Key とワークスペースの有効性を確認します。