curl --request POST 'https://api.voicecheap.ai/v1/actions/team_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{}'
const input = {};
const response = await fetch('https://api.voicecheap.ai/v1/actions/team_get', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/team_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"ownedTeam": {
"teamId": "f79512aa-cdbc-4f11-92e1-7a3af204bf45",
"teamName": "Studio team",
"members": [
{
"userId": "user_456",
"email": "member@example.com",
"name": "Studio member",
"status": "valid"
}
],
"seats": {
"limit": 5,
"used": 1
}
},
"membership": null
}
}
チーム
チームを取得
ご自身が所有するチーム、そのメンバーとメンバー数の利用枠、および別のアカウントのチームで作業する際の現在の所属情報を取得します。
POST
/
v1
/
actions
/
team_get
curl --request POST 'https://api.voicecheap.ai/v1/actions/team_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{}'
const input = {};
const response = await fetch('https://api.voicecheap.ai/v1/actions/team_get', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/team_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"ownedTeam": {
"teamId": "f79512aa-cdbc-4f11-92e1-7a3af204bf45",
"teamName": "Studio team",
"members": [
{
"userId": "user_456",
"email": "member@example.com",
"name": "Studio member",
"status": "valid"
}
],
"seats": {
"limit": 5,
"used": 1
}
},
"membership": null
}
}
ご自身が所有するチーム、そのメンバーとメンバー数の利用枠、および別のアカウントのチームで作業する際の現在の所属情報を取得します。
必要な権限:
POST https://api.voicecheap.ai/v1/actions/team_get
認証と権限
string
必須
このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP
でのみ使用でき、この REST エンドポイントでは使用できません。
team:read.
有効な有料サブスクリプションが必要です。権限によってチーム内のロール、リソースの所有権、メディアクレジット、プランの制限が変わることはありません。
パラメーター
空の JSON オブジェクトを送信してください。このアクションに入力フィールドはありません。完全な入力スキーマ
完全な入力スキーマ
以下の JSON Schema は、ディスカバリーで公開される正確なフィールド名、ネストされた型、デフォルト値、範囲、許容値を保持しています。フィールド間の追加ルールは操作の注意事項に記載されています。
{
"type": "object",
"properties": {},
"additionalProperties": false
}
リクエスト例
例に記載されたリソース識別子とメディアキーを、ご自身のアカウントで返された値に置き換えてください。同じ変更操作を再試行する場合は、リクエスト識別子を変更しないでください。curl --request POST 'https://api.voicecheap.ai/v1/actions/team_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{}'
const input = {};
const response = await fetch('https://api.voicecheap.ai/v1/actions/team_get', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/team_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
レスポンス
初回実行が成功すると、操作結果を data に格納して HTTP 200 を返します。同じリクエストを再送した場合は、代わりに保存済みリクエストの状態を返すことがあります。例はサポートされるレスポンスの一例であり、すべての任意フィールドを示すものではありません。 アカウントが所有するチームと、該当する場合は、別のアカウントのチームでの有効なメンバーシップを返します。{
"data": {
"ownedTeam": {
"teamId": "f79512aa-cdbc-4f11-92e1-7a3af204bf45",
"teamName": "Studio team",
"members": [
{
"userId": "user_456",
"email": "member@example.com",
"name": "Studio member",
"status": "valid"
}
],
"seats": {
"limit": 5,
"used": 1
}
},
"membership": null
}
}
結果フィールド
| フィールド | 説明 |
|---|---|
data.ownedTeam | 呼び出し元が所有するチーム。なければ null。 |
data.ownedTeam.teamId | 所有するチームの識別子。 |
data.ownedTeam.teamName | 所有するチームの名前。 |
data.ownedTeam.members | 所有するチームの現在のメンバー。 |
data.ownedTeam.members[].userId | メンバーアカウントの識別子。 |
data.ownedTeam.members[].email | メンバーのメールアドレス。 |
data.ownedTeam.members[].name | メンバーの表示名。 |
data.ownedTeam.members[].status | 現在のメンバーステータス。アクティブなメンバーシップに対して有効です。 |
data.ownedTeam.seats.limit | 呼び出し元の個人プランで許可されるゲスト数の上限。 |
data.ownedTeam.seats.used | 現在のゲスト数。 |
data.membership | 別のアカウントのチームへの有効な所属情報、または null。 |
data.membership.teamId | 現在の所属先のチーム識別子。 |
data.membership.teamName | 現在の所属先のチーム名。 |
data.membership.role | 有効なゲスト所属の場合は member。 |
data.membership.owner | userId、displayName、email を含む、所有者の公開情報。 |
操作の注意事項
- 所有するチームのシート数上限には、呼び出し元の個人プランが適用されます。チームメンバーシップから継承したプランは使用されません。
使用量
正常に実行された呼び出しごとに、月間 API/MCP 呼び出し回数を 1 回消費します。メディアクレジットと、その操作固有の生成枠も適用されます。エラー
| HTTP ステータス | コード | 意味または対処方法 |
|---|---|---|
| 400 | CREDENTIAL_IN_QUERY | access_token または api_key クエリパラメーターに認証情報が指定されています。認証情報はヘッダーで送信してください。 |
| 400 | VALIDATION_ERROR | JSONオブジェクトに未対応のフィールド、無効な値、または必須引数の欠落があります。 |
| 401 | API_KEY_EXPIRED | API キーの有効期限が切れています。 |
| 401 | INVALID_API_KEY | 有効期限内の有効な API キーを指定してください。 |
| 401 | INVALID_CREDENTIAL | Authorization ヘッダーの形式が不正、または x-api-key と競合しています。 |
| 401 | MISSING_CREDENTIAL | 利用可能なヘッダー認証情報が指定されていないか、4096文字を超えています。 |
| 401 | USER_NOT_FOUND | 認証情報に対応するアカウントはすでに存在しません。 |
| 403 | AMBIGUOUS_TEAM_API_KEY | 認証情報のユーザーが複数のチームに属しているため、課金コンテキストが曖昧です。 |
| 403 | INSUFFICIENT_SCOPE | 必要な権限をすべて付与するか、別の認証情報を使用してください。 |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | アカウントの連携上限を確認できませんでした。 |
| 403 | SUBSCRIPTION_REQUIRED | 有効な有料サブスクリプションを使用してください。 |
| 403 | TEAM_MEMBERSHIP_INVALID | アカウントの現在のチーム所属が、この接続のワークスペースと一致しません。所属情報を更新して再接続してください。 |
| 403 | TEAM_OWNER_NOT_FOUND | 実効的なチームオーナーのアカウントが見つかりませんでした。 |
| 404 | ACCOUNT_NOT_FOUND | アカウントまたはアクティブなワークスペースのアカウントが見つかりませんでした。 |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | 月次リセットを待つか、プランを変更してください。 |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Retry-After がある場合は指定時間を待ち、バックオフを使用してください。 |
| 500 | INTERNAL_ERROR | 変更操作を再試行するか判断する前に、保存済みリクエストの状態とリソースの履歴を確認してください。 |
| 503 | SERVER_RESTARTING | サーバーが再起動中です。少し待ってから再試行し、変更操作では同じリクエスト識別子を使用してください。 |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["team:read"]
}
}
このページは役に立ちましたか？