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
}
}
Equipe
Consultar sua equipe
Consulte a equipe da qual você é proprietário, seus membros e a cota de membros, além da sua participação ativa quando trabalha na equipe de outra conta.
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
}
}
Consulte a equipe da qual você é proprietário, seus membros e a cota de membros, além da sua participação ativa quando trabalha na equipe de outra conta.
Permissões necessárias:
POST https://api.voicecheap.ai/v1/actions/team_get
Autenticação e permissões
string
obrigatório
Envie uma chave de API VoiceCheap neste cabeçalho. Authorization: Bearer com a mesma chave de API também é aceito. Tokens de acesso OAuth são
aceitos apenas pelo MCP, não por este endpoint REST.
team:read.
É necessária uma assinatura paga ativa. As permissões não alteram funções na equipe, propriedade dos recursos, créditos de mídia ou limites do plano.
Parâmetros
Envie um objeto JSON vazio. Esta ação não possui campos de entrada.Esquema de entrada completo
Esquema de entrada completo
O JSON Schema abaixo preserva os nomes exatos dos campos, tipos aninhados, valores padrão, limites e valores aceitos expostos pela descoberta. Regras adicionais entre campos são listadas nas notas da operação.
{
"type": "object",
"properties": {},
"additionalProperties": false
}
Exemplos de requisição
Substitua os identificadores de recursos e as chaves de mídia dos exemplos pelos valores retornados para sua conta. Mantenha o identificador da requisição ao tentar novamente a mesma alteração.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)
Resposta
Uma primeira execução bem-sucedida retorna HTTP 200 com o resultado da operação em data. Uma repetição pode retornar o estado salvo da requisição. O exemplo mostra uma resposta aceita, não todos os campos opcionais. Retorna a equipe que pertence à conta e sua participação ativa na equipe de outra conta, quando aplicável.{
"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
}
}
Campos do resultado
| Campo | Descrição |
|---|---|
data.ownedTeam | Equipe pertencente ao chamador, ou null. |
data.ownedTeam.teamId | Identificador da equipe pertencente à conta. |
data.ownedTeam.teamName | Nome da equipe pertencente à conta. |
data.ownedTeam.members | Membros atuais da equipe própria. |
data.ownedTeam.members[].userId | Identificador da conta do membro. |
data.ownedTeam.members[].email | Endereço de e-mail do membro. |
data.ownedTeam.members[].name | Nome de exibição do membro. |
data.ownedTeam.members[].status | Status atual do membro; válido para uma participação ativa. |
data.ownedTeam.seats.limit | Número máximo de convidados permitido pelo plano pessoal do solicitante. |
data.ownedTeam.seats.used | Número atual de convidados. |
data.membership | Participação ativa na equipe de outra conta ou null. |
data.membership.teamId | Identificador da equipe da participação ativa. |
data.membership.teamName | Nome da equipe da participação ativa. |
data.membership.role | member para uma participação ativa como convidado. |
data.membership.owner | Identidade pública do proprietário contendo userId, displayName e email. |
Notas da operação
- O limite de vagas da equipe pertencente ao solicitante usa seu plano pessoal. Não usa um plano herdado da participação em uma equipe.
Uso
Cada chamada bem-sucedida consome uma chamada mensal da API/MCP. Os créditos de mídia e as cotas de geração da própria operação também se aplicam.Erros
| Status HTTP | Código | Significado ou recuperação |
|---|---|---|
| 400 | CREDENTIAL_IN_QUERY | Foram fornecidas credenciais em um parâmetro de consulta access_token ou api_key. Envie as credenciais nos cabeçalhos. |
| 400 | VALIDATION_ERROR | O objeto JSON contém um campo não compatível, um valor inválido ou um argumento obrigatório ausente. |
| 401 | API_KEY_EXPIRED | A chave de API expirou. |
| 401 | INVALID_API_KEY | Forneça uma chave de API válida e dentro do prazo de validade. |
| 401 | INVALID_CREDENTIAL | O cabeçalho Authorization está malformado ou entra em conflito com x-api-key. |
| 401 | MISSING_CREDENTIAL | Nenhuma credencial utilizável foi fornecida no cabeçalho, ou ela excedeu 4096 caracteres. |
| 401 | USER_NOT_FOUND | A conta da credencial não existe mais. |
| 403 | AMBIGUOUS_TEAM_API_KEY | O usuário da credencial pertence a mais de uma equipe, portanto o contexto de cobrança é ambíguo. |
| 403 | INSUFFICIENT_SCOPE | Conceda todas as permissões necessárias ou escolha outra credencial. |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | Não foi possível verificar os limites de integração da conta. |
| 403 | SUBSCRIPTION_REQUIRED | Use uma assinatura paga ativa. |
| 403 | TEAM_MEMBERSHIP_INVALID | O vínculo atual da conta com a equipe não corresponde ao espaço de trabalho desta conexão. Atualize o vínculo de membro e reconecte. |
| 403 | TEAM_OWNER_NOT_FOUND | Não foi possível encontrar a conta efetiva do proprietário da equipe. |
| 404 | ACCOUNT_NOT_FOUND | Não foi possível encontrar a conta ou a conta do espaço de trabalho ativo. |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | Aguarde a renovação do limite mensal ou mude de plano. |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Aguarde o prazo de Retry-After, quando presente, e aumente progressivamente o intervalo entre as tentativas. |
| 500 | INTERNAL_ERROR | Verifique o estado da requisição salva e o histórico do recurso antes de decidir repetir uma alteração. |
| 503 | SERVER_RESTARTING | O servidor está reiniciando. Tente novamente em breve e mantenha o mesmo identificador de requisição para uma alteração. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["team:read"]
}
}
Esta página foi útil?

