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
}
}
Team
Je team ophalen
Haal het team waarvan je eigenaar bent op, inclusief de leden en het toegestane aantal gebruikers, plus je actieve lidmaatschap wanneer je in het team van een ander account werkt.
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
}
}
Haal het team waarvan je eigenaar bent op, inclusief de leden en het toegestane aantal gebruikers, plus je actieve lidmaatschap wanneer je in het team van een ander account werkt.
Vereiste machtigingen:
POST https://api.voicecheap.ai/v1/actions/team_get
Authenticatie en machtigingen
string
vereist
Stuur een VoiceCheap API-sleutel mee in deze header. Authorization: Bearer met dezelfde API-sleutel wordt ook ondersteund. OAuth-toegangstokens
worden alleen door MCP geaccepteerd, niet door dit REST-endpoint.
team:read.
Een actief betaald abonnement is vereist. Machtigingen wijzigen geen teamrollen, eigendom van resources, mediategoed of abonnementslimieten.
Parameters
Stuur een leeg JSON-object. Deze actie heeft geen invoervelden.Volledig invoerschema
Volledig invoerschema
Het onderstaande JSON Schema behoudt de exacte veldnamen, geneste typen, standaardwaarden, grenzen en toegestane waarden die discovery beschikbaar stelt. Aanvullende regels tussen velden staan in de opmerkingen bij de bewerking.
{
"type": "object",
"properties": {},
"additionalProperties": false
}
Voorbeeldaanvragen
Vervang de voorbeeldidentificaties van resources en mediasleutels door waarden die voor je account zijn geretourneerd. Behoud dezelfde aanvraagidentificatie wanneer je dezelfde wijziging opnieuw probeert.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)
Antwoord
Een geslaagde eerste uitvoering retourneert HTTP 200 met het resultaat van de bewerking onder data. Een herhaalde aanvraag kan in plaats daarvan de opgeslagen aanvraagstatus retourneren. Het voorbeeld toont één ondersteund antwoord, niet alle optionele velden. Retourneert het team waarvan het account eigenaar is en, indien van toepassing, het actieve lidmaatschap van een team van een ander account.{
"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
}
}
Resultaatvelden
| Veld | Beschrijving |
|---|---|
data.ownedTeam | Team waarvan de aanroeper eigenaar is, of null. |
data.ownedTeam.teamId | ID van het eigen team. |
data.ownedTeam.teamName | Naam van het eigen team. |
data.ownedTeam.members | Huidige leden van het eigen team. |
data.ownedTeam.members[].userId | Identificatie van het ledenaccount. |
data.ownedTeam.members[].email | E-mailadres van het lid. |
data.ownedTeam.members[].name | Weergavenaam van het lid. |
data.ownedTeam.members[].status | Huidige lidstatus; geldig voor een actief lidmaatschap. |
data.ownedTeam.seats.limit | Maximumaantal gasten dat het persoonlijke abonnement van de aanroepende gebruiker toestaat. |
data.ownedTeam.seats.used | Huidig aantal gasten. |
data.membership | Actief lidmaatschap van het team van een ander account, of null. |
data.membership.teamId | Teamidentificatie voor het actieve lidmaatschap. |
data.membership.teamName | Teamnaam voor het actieve lidmaatschap. |
data.membership.role | member bij een actief gastlidmaatschap. |
data.membership.owner | Openbare identiteit van de eigenaar met userId, displayName en email. |
Opmerkingen bij de bewerking
- De ledenlimiet van het team dat je bezit, gebruikt het persoonlijke abonnement van de aanroeper. Er wordt geen abonnement gebruikt dat via een teamlidmaatschap is overgenomen.
Verbruik
Elke geslaagde aanroep verbruikt één maandelijkse API/MCP-aanroep. Ook het mediategoed en de eigen generatielimieten van de bewerking zijn van toepassing.Fouten
| HTTP-status | Code | Betekenis of herstel |
|---|---|---|
| 400 | CREDENTIAL_IN_QUERY | Inloggegevens zijn opgegeven in een queryparameter access_token of api_key. Stuur inloggegevens in headers. |
| 400 | VALIDATION_ERROR | Het JSON-object bevat een niet-ondersteund veld, een ongeldige waarde of een ontbrekend verplicht argument. |
| 401 | API_KEY_EXPIRED | De API-sleutel is verlopen. |
| 401 | INVALID_API_KEY | Geef een geldige, niet-verlopen API-sleutel op. |
| 401 | INVALID_CREDENTIAL | De Authorization-header heeft een ongeldige indeling of is in strijd met x-api-key. |
| 401 | MISSING_CREDENTIAL | Er is geen bruikbaar authenticatiemiddel in de header opgegeven, of het overschreed 4096 tekens. |
| 401 | USER_NOT_FOUND | Het account dat bij de toegangsgegevens hoort, bestaat niet meer. |
| 403 | AMBIGUOUS_TEAM_API_KEY | De gebruiker van het authenticatiemiddel behoort tot meer dan één team, waardoor de factureringscontext onduidelijk is. |
| 403 | INSUFFICIENT_SCOPE | Verleen alle vereiste machtigingen of kies andere toegangsgegevens. |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | De integratielimieten van het account konden niet worden geverifieerd. |
| 403 | SUBSCRIPTION_REQUIRED | Gebruik een actief betaald abonnement. |
| 403 | TEAM_MEMBERSHIP_INVALID | Het huidige teamlidmaatschap van het account komt niet overeen met de werkruimte van deze verbinding. Vernieuw het lidmaatschap en maak opnieuw verbinding. |
| 403 | TEAM_OWNER_NOT_FOUND | Het effectieve account van de teameigenaar kon niet worden gevonden. |
| 404 | ACCOUNT_NOT_FOUND | Het account of het account van de actieve werkruimte kon niet worden gevonden. |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | Wacht tot de maandelijkse reset of wijzig je abonnement. |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Wacht de tijd uit Retry-After af wanneer deze aanwezig is en vergroot de wachttijd tussen nieuwe pogingen. |
| 500 | INTERNAL_ERROR | Controleer de opgeslagen aanvraagstatus en de resourcegeschiedenis voordat je besluit een wijziging opnieuw te proberen. |
| 503 | SERVER_RESTARTING | De server wordt opnieuw gestart. Probeer het zo opnieuw en behoud bij een wijziging dezelfde aanvraagidentificatie. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["team:read"]
}
}
Was deze pagina nuttig?

