← API リファレンス
GroupsGET

参加リクエスト一覧

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

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

ヘッダー

X-Api-Key
string必須

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

パスパラメータ

account_id
string必須

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

クエリパラメータ

group_id
string必須

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

リクエストボディ

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

レスポンスボディ

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

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

リクエスト

curl -X GET https://api.unifyport.ai/v1/accounts/{account_id}/groups/join-requests?group_id=group_example \
  -H "X-Api-Key: <YOUR_API_KEY>"

レスポンス

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