Tiimi-API #

Tiimisi koostuu kaikista tililläsi työskentelevistä henkilöistä sinun lisäksesi – ylläpitäjistä, agenteista ja vain luku -oikeudella varustetuista katselijoista – sekä lähettämistäsi kutsuista ja osastoista, joihin olet heidät järjestänyt. Tiimi-API on ohjelmallinen versio kohdasta Asetukset → Tiimi: lisää ja poista ihmisiä, määritä mitä kukin heistä voi nähdä ja tehdä, lähetä ja muistuta kutsuista sekä hallinnoi osastoja.

Kaikki alla olevat päätepisteet ovat suhteessa perus-URL-osoitteeseen https://api.youraiconnector.com/v1. Katso hallintapaneeliversio kaikesta tällä sivulla olevasta kohdasta Tiimin hallinta.

Todennus: nämä päätepisteet vaativat sisäänkirjautuneen henkilön #

Tämä on se osa APIa, jota API-avain ei voi käyttää. Jokainen /team-päätepiste, lukuun ottamatta osasto-päätepisteitä, on kutsuttava sisäänkirjautuneen istunnon Firebase ID -tunnuksella:

Authorization: Bearer <Firebase ID token>

Jos lähetät API-avaimen, pyyntö hylätään virheellä 401:

{
  "success": false,
  "error_code": 401,
  "error": "This endpoint requires a Firebase ID token (Authorization: Bearer <token>)."
}

Syy on se, että nämä päätepisteet päättävät toimintatavan sen perusteella, kuka on kirjautunut sisään: roolisi, yläraja sille, mitä saat myöntää muille, ja se, työskenteletkö parhaillaan toisen tilin sisällä. API-avain on integraatio, ei henkilö, joten näitä sääntöjä ei voida soveltaa kehenkään.

Käytännössä tämä tarkoittaa, että Tiimi-API on tarkoitettu ensimmäisen osapuolen sovellukselle, jossa on sisäänkirjautunut Your AI Connector-käyttäjä (katso Todennus → Firebase ID -tunnus). Palvelimien välinen integraatio ei voi hallinnoida tiimin jäseniä – näitä tunnuksia ei voi luoda sovelluksen ulkopuolelta.

Poikkeus: neljä osasto-päätepistettä ovat tavallisia API-päätepisteitä. Ne hyväksyvät API-avaimesi aivan kuten muukin API, sekä sisäänkirjautuneen istunnon.

Jokainen tämän sivun vastaus noudattaa tavallista kirjekuorirakennetta: success: true ja päätepisteen kentät ylimmällä tasolla, tai success: false, jossa on error ja error_code, kun jokin menee vikaan.

Roolit ja käyttöoikeudet #

Jokaisella tiimin jäsenellä on yksi rooli, joka määrittää heidän oletusarvoisen pääsynsä sovelluksen 12 eri osa-alueelle. Voit sen jälkeen ohittaa yksittäisiä osa-alueita.

Jokainen osa-alue on asetettu yhdelle neljästä tasosta: none (piilotettu), view (vain luku), edit (luo ja muuta), full (mukaan lukien poistaminen).

Jos haluat poiketa roolin oletusasetuksista, lähetä permission_overrides – taulukko { "area": ..., "level": ... }-objekteja. Jokainen merkintä korvaa roolin oletusasetuksen kyseisellä osa-alueella; kaikki, mitä et listaa, säilyttää roolin oletusasetuksen.

"permission_overrides": [
  { "area": "analytics", "level": "full" },
  { "area": "billing", "level": "none" }
]

Kuka voi kutsua näitä päätepisteitä

• Tilin omistaja voi aina tehdä kaiken.
• Tiimin jäsen tarvitsee team_management-oikeuden tasolla view lukeakseen jäsenluetteloa ja kutsulistaa, sekä tasolla edit lisätäkseen, muuttaakseen, keskeyttääkseen, poistaakseen, kutsuakseen, peruuttaakseen tai lähettääkseen kutsun uudelleen. Järjestelmänvalvojilla on oletuksena edit; muokkaajilla ja katselijoilla on none, joten oletuksena vain järjestelmänvalvojat voivat hallinnoida tiimiä.
• Kukaan ei voi myöntää korkeampia käyttöoikeuksia kuin itsellään on. Jos yrität antaa jollekulle tason, jota sinulla ei itselläsi ole – tai muokata, keskeyttää tai poistaa henkilöä, jonka käyttöoikeudet ovat jo laajemmat kuin omasi – pyyntö hylätään virheellä 403 ja viestillä, joka nimeää kyseisen osa-alueen.

Tiimin jäsen -objekti #

GET /team/members palauttaa yhden näistä per jäsen:

Poistettuja jäseniä ei palauteta – luettelo sisältää vain aktiiviset ja keskeytetyt jäsenet.

Näkyvyysrajoitukset ovat tässä vain kirjoitettavissa. contact_scope, contact_scope_axes ja sub_account_access (katso Jäsenen näkyvyyden rajoittaminen) voidaan asettaa luonnin, päivityksen ja kutsun yhteydessä, mutta tämä päätepiste ei palauta niitä.

Listaa tiimin jäsenet #

GET /team/members

Palauttaa jäsenluettelon sekä tilauksesi paikkamäärät, jotta voit näyttää “3/5 paikkaa käytössä” ja tietää, milloin kutsuminen on estymässä.

cURL

curl "https://api.youraiconnector.com/v1/team/members" \
  -H "Authorization: Bearer FIREBASE_ID_TOKEN"

JavaScript

const res = await fetch("https://api.youraiconnector.com/v1/team/members", {
  headers: { Authorization: `Bearer ${idToken}` },
});
const { members, seat_limit, seats_used } = await res.json();

Python

import requests

res = requests.get(
    "https://api.youraiconnector.com/v1/team/members",
    headers={"Authorization": f"Bearer {id_token}"},
)
data = res.json()

Vastaus

{
  "success": true,
  "members": [
    {
      "account_owner_uid": "owner_uid_123",
      "member_uid": "uid_alice",
      "member_email": "alice@example.com",
      "member_display_name": "Alice Chen",
      "role": "admin",
      "permission_overrides": [],
      "status": "active",
      "auto_assign_enabled": true,
      "created_by": "owner_uid_123",
      "created_at": "2026-05-01T10:00:00.000Z",
      "updated_at": "2026-06-02T09:15:00.000Z"
    }
  ],
  "seat_limit": 5,
  "seats_used": 3
}

seat_limit on null, kun tilauksessasi ei ole paikkakiintiötä. seats_used laskee vain aktiiviset jäsenet – jonkun keskeyttäminen tai poistaminen vapauttaa hänen paikkansa välittömästi.

Lisää tiimin jäsen suoraan #

POST /team/members

Lisää henkilön tiimiisi välittömästi ilman kutsua.

Tämä ei lähetä sähköpostia. Kenellekään ei ilmoiteta heidän lisäämisestään, ja jos heillä ei ollut jo Your AI Connector-kirjautumistunnuksia, heille luodulla tilillä ei ole salasanaa, joten he eivät voi kirjautua sisään ennen kuin he nollaavat sen. Käytä Lähetä kutsu -toimintoa, ellet itse kerro henkilölle asiasta ja auta häntä kirjautumaan sisään.

Pyynnön kentät

cURL

curl -X POST "https://api.youraiconnector.com/v1/team/members" \
  -H "Authorization: Bearer FIREBASE_ID_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "sam@example.com",
    "display_name": "Sam Rivera",
    "role": "editor"
  }'

JavaScript

const res = await fetch("https://api.youraiconnector.com/v1/team/members", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${idToken}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    email: "sam@example.com",
    display_name: "Sam Rivera",
    role: "editor",
  }),
});
const { member_uid } = await res.json();

Vastaus — 201 Created

{
  "success": true,
  "team_member_id": "owner_uid_123_uid_sam",
  "member_uid": "uid_sam",
  "message": "Team member created successfully."
}

Aiemmin jäädytetyn tai poistetun henkilön lisääminen palauttaa hänet tiimiin epäonnistumisen sijaan.

Päivitä tiimin jäsen #

PATCH /team/members/{memberUid}

Muuttaa jäsenen roolia, käyttöoikeuksia, näkyvyyttä, asiakaspääsyä tai sitä, osallistuuko hän automaattiseen yhteystietojen jakoon. Lähetä vain ne kentät, joita haluat muuttaa; kaikki pois jätetyt säilyttävät nykyisen arvonsa.

Pyynnön kentät

Tämä on ainoa rajapinta, jossa null tarkoittaa “tyhjennä”. Arvojen "contact_scope": null, "contact_scope_axes": null tai "sub_account_access": null lähettäminen poistaa rajoituksen kokonaan ja palauttaa jäsenen näkemään kaiken. Luonnin ja kutsun yhteydessä null tarkoittaa yksinkertaisesti “ei määritetty”.

cURL

curl -X PATCH "https://api.youraiconnector.com/v1/team/members/uid_sam" \
  -H "Authorization: Bearer FIREBASE_ID_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "role": "admin",
    "permission_overrides": [{ "area": "billing", "level": "none" }]
  }'

Vastaus

{
  "success": true,
  "message": "Team member updated successfully."
}

Jäädytä tiimin jäsen #

POST /team/members/{memberUid}/suspend

Jäädyttää henkilön: hän säilyttää paikkansa tiimissä, mutta menettää käyttöoikeudet. Käytä tätä poistamisen sijaan, kun tauko on väliaikainen — palauta hänet takaisin käyttämällä PATCH /team/members/{memberUid} ja {"status": "active"}.

cURL

curl -X POST "https://api.youraiconnector.com/v1/team/members/uid_sam/suspend" \
  -H "Authorization: Bearer FIREBASE_ID_TOKEN"

Vastaus

{
  "success": true,
  "message": "Team member suspended successfully."
}

Jäädytetty jäsen vapauttaa paikkansa, joten voit kutsua jonkun muun hänen tilalleen. Hänen käyttöoikeutensa päättyvät, kun hänen nykyinen istuntotunnisteensa päivittyy seuraavan kerran, mikä voi kestää jopa tunnin — poista hänet, jos tarvitset välittömän vaikutuksen.

Tiimin jäsenen poistaminen #

DELETE /team/members/{memberUid}

Poistaa henkilön tiimistäsi ja vapauttaa hänen paikkansa. Hänet kirjataan ulos ja hän menettää pääsyn tilillesi; hänen oma kirjautumisensa säilyy ennallaan.

cURL

curl -X DELETE "https://api.youraiconnector.com/v1/team/members/uid_sam" \
  -H "Authorization: Bearer FIREBASE_ID_TOKEN"

Vastaus

{
  "success": true,
  "message": "Team member removed successfully."
}

Poistaminen on pysyvää sinun puoleltasi: poistettua jäsentä ei voi aktivoida uudelleen päivityksen päätepisteen kautta — kutsu hänet uudelleen, jos muutat mielesi. Hänen sähköpostiosoitteensa poistetaan myös tilisi ilmoituslistalta.

Jäsenen näkyvyyden rajoittaminen #

Kolme valinnaista kenttää, jotka hyväksytään lisäyksessä, päivityksessä ja kutsussa, määrittävät, kuinka paljon henkilö näkee tilistä. Ne yhdistyvät: jos jäsen on rajoitettu useammalla kuin yhdellä tavalla, häntä rajoittavat ne kaikki.

contact_scope — all (oletus: jokainen yhteystieto ja keskustelu) tai assigned (vain hänelle määritetyt). Kun käytössä on assigned, lisää "contact_scope_unassigned": true, jotta hän näkee myös yhteystiedot, joita kukaan ei vielä omista.

contact_scope_axes — rajoittaa hänet nimettyihin agentteihin, kanaviin tai osastoihin:

Agenttien ja osastojen tunnuksia ei tarkisteta tallennettaessa — olematon tunnus ei yksinkertaisesti vastaa mitään, mikä näkyy tyhjänä postilaatikkona virheen sijaan. Kanavien nimet tarkistetaan: tunnistamaton nimi hylätään virheellä 400.

Mitään näistä kolmesta ei voi asettaa tilin omistajalle — kyseinen pyyntö hylätään virheellä 400.

Listaa kutsut #

GET /team/invites

Lähettämäsi kutsut uusimmasta alkaen, jotta näet, kuka ei ole vielä hyväksynyt kutsua.

Kyselyparametrit

cURL

curl "https://api.youraiconnector.com/v1/team/invites?status=pending" \
  -H "Authorization: Bearer FIREBASE_ID_TOKEN"

Vastaus

{
  "success": true,
  "invites": [
    {
      "id": "inv_abc123",
      "account_owner_uid": "owner_uid_123",
      "account_owner_display_name": "Acme Ltd",
      "invitee_email": "sam@example.com",
      "invitee_uid": null,
      "role": "editor",
      "permission_overrides": [],
      "status": "pending",
      "created_by": "owner_uid_123",
      "created_at": "2026-06-10T12:00:00.000Z",
      "expires_at": "2026-06-17T12:00:00.000Z",
      "responded_at": null
    }
  ]
}

Kutsutunnistetta ei palauteta koskaan — se on olemassa vain lähetetyssä sähköpostiviestissä.

Lähetä kutsu #

POST /team/invites

Lähettää sähköpostitse kutsun liittyä tiimiisi. Tämä on tavallinen tapa lisätä tiimin jäsen: he klikkaavat linkkiä, kirjautuvat sisään omilla tunnuksillaan ja hyväksyvät kutsun. Jos heillä ei ole vielä Your AI Connector-tiliä, sellainen luodaan heille ja sähköpostiviesti opastaa salasanan asettamisessa.

Pyynnön kentät

Käyttöoikeuksien määrittäminen etukäteen tarkoittaa, ettei jäsentä tarvitse muokata jälkikäteen — kaikki kopioidaan heidän jäsenyyteensä, kun he hyväksyvät kutsun.

cURL

curl -X POST "https://api.youraiconnector.com/v1/team/invites" \
  -H "Authorization: Bearer FIREBASE_ID_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "email": "sam@example.com", "role": "editor" }'

JavaScript

const res = await fetch("https://api.youraiconnector.com/v1/team/invites", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${idToken}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ email: "sam@example.com", role: "editor" }),
});
const { invite_id } = await res.json();

Vastaus — 201 Created

{
  "success": true,
  "invite_id": "inv_abc123",
  "message": "Team invite sent successfully."
}

Huomioitavia asioita

• Kutsut vanhenevat 7 päivän kuluttua. Vanhentuneen kutsun voi lähettää uudelleen, mikä aloittaa uuden 7 päivän jakson.
• Vireillä olevat kutsut varaavat paikan. Toisin kuin jäsentä suoraan lisättäessä, paikkojen tarkistus laskee tässä aktiiviset jäsenet sekä vireillä olevat kutsut, joten tili, jonka kaikki paikat on varattu, hylätään ennen kuin sähköpostia lähetetään.
• 20 kutsua päivässä, laskettuna tiliä kohden sekä lähetysten että uudelleenlähetysten osalta.

Peruuta kutsu #

DELETE /team/invites/{inviteId}

Peruuttaa kutsun ennen kuin se on hyväksytty. Sähköpostissa oleva linkki lakkaa toimimasta.

cURL

curl -X DELETE "https://api.youraiconnector.com/v1/team/invites/inv_abc123" \
  -H "Authorization: Bearer FIREBASE_ID_TOKEN"

Vastaus

{
  "success": true,
  "message": "Team invite cancelled."
}

Sekä pending- että expired-kutsut voidaan peruuttaa. Kutsu, joka on jo hyväksytty, hylätty tai peruutettu, palauttaa 400; kutsu, joka ei ole sinun, palauttaa 403; tuntematon tunnus palauttaa 404.

Lähetä kutsu uudelleen #

POST /team/invites/{inviteId}/resend

Lähettää kutsusähköpostin uudelleen — jos se jäi huomaamatta tai päätyi roskapostiin. Toimii pending- ja expired-kutsuille ja nollaa vanhenemisajan 7 päivän päähän tästä hetkestä.

cURL

curl -X POST "https://api.youraiconnector.com/v1/team/invites/inv_abc123/resend" \
  -H "Authorization: Bearer FIREBASE_ID_TOKEN"

Vastaus

{
  "success": true,
  "message": "Team invite resent successfully."
}

Uusi sähköposti sisältää uuden linkin, ja vanha linkki toimii myös edelleen, joten henkilö, joka löytää ensimmäisen sähköpostin myöhemmin, ei jää jumiin. Uudelleenlähetys lasketaan samaan 20 kpl päivittäiseen rajoitukseen kuin lähettäminen, ja vanhentuneen kutsun elvyttäminen tarkistaa paikkamääräsi uudelleen — täysi tilaus hylätään virheellä 429.

Hyväksy kutsu #

POST /team/invites/accept

Hyväksyy kutsun sähköpostiviestissä olevalla tunnisteella ja liittää kirjautuneen käyttäjän kyseisen tilin tiimiin.

Tämä on henkilökohtainen toiminto. Kirjaudu sisään omana itsenäsi — toiminto hylätään tarkoituksella virheellä 403, jos työskentelet jonkun toisen tilin sisällä.

Pyynnön kentät

cURL

curl -X POST "https://api.youraiconnector.com/v1/team/invites/accept" \
  -H "Authorization: Bearer FIREBASE_ID_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "invite_token": "1f4c…" }'

Vastaus

{
  "success": true,
  "team_member_id": "owner_uid_123_uid_sam",
  "account_owner_uid": "owner_uid_123",
  "message": "Team invite accepted successfully."
}

Hylkää kutsu #

POST /team/invites/decline

Hylkää kutsun sähköpostiviestissä olevalla tunnisteella. Kuten hyväksyminen, tämä on henkilökohtainen toiminto, ja se hylätään, jos työskentelet toisen tilin sisällä.

cURL

curl -X POST "https://api.youraiconnector.com/v1/team/invites/decline" \
  -H "Authorization: Bearer FIREBASE_ID_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "invite_token": "1f4c…" }'

Vastaus

{
  "success": true,
  "message": "Team invite declined."
}

Osastot #

Osasto on tiimisi nimetty ryhmä – esimerkiksi myynti, asiakaspalvelu tai HR. Se antaa liidille omistajatiimin, voi ottaa uusia keskusteluja vastaan itsenäisesti, ja sitä voidaan käyttää rajoittamaan sitä, mitä jäsen näkee.

Nämä neljä päätepistettä vaativat API-avaimen. Toisin kuin muualla tällä sivulla, ne todennetaan samalla tavalla kuin kaikki muutkin API:n päätepisteet (katso Todennus). Myös sisäänkirjautunut istunto toimii: lukeminen vaatii contacts osoitteessa view, ja luominen, muuttaminen tai poistaminen vaatii team_management osoitteessa edit.

Osasto-objekti

Kun sekä routing_agents että routing_channels on asetettu, keskustelun on täytettävä molemmat ehdot, jotta se kirjataan tänne – näin voit antaa tiimille esimerkiksi “tukiedustaja, mutta vain WhatsAppissa”.

Tilillä voi olla enintään 50 osastoa.

Listaa osastot #

GET /team/departments

curl "https://api.youraiconnector.com/v1/team/departments?apiKey=YOUR_API_KEY"

Vastaus

{
  "success": true,
  "departments": [
    {
      "id": "dep_abc123",
      "name": "Sales",
      "color": "#2f6fed",
      "member_uids": ["uid_alice", "uid_bob"],
      "auto_assign_enabled": true,
      "routing_agents": [],
      "routing_channels": ["whatsapp"],
      "created_by": "owner_uid_123"
    }
  ]
}

Luo osasto #

POST /team/departments

Pyynnön kentät

cURL

curl -X POST "https://api.youraiconnector.com/v1/team/departments?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Sales",
    "color": "#2f6fed",
    "member_uids": ["uid_alice", "uid_bob"],
    "routing_channels": ["whatsapp"]
  }'

JavaScript

const res = await fetch("https://api.youraiconnector.com/v1/team/departments", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Sales",
    color: "#2f6fed",
    member_uids: ["uid_alice", "uid_bob"],
    routing_channels: ["whatsapp"],
  }),
});
const { department } = await res.json();

Python

import requests

res = requests.post(
    "https://api.youraiconnector.com/v1/team/departments",
    headers={"X-API-Key": "YOUR_API_KEY"},
    json={
        "name": "Sales",
        "color": "#2f6fed",
        "member_uids": ["uid_alice", "uid_bob"],
        "routing_channels": ["whatsapp"],
    },
)
department = res.json()["department"]

Vastaus — 201 Created

{
  "success": true,
  "department": {
    "id": "dep_abc123",
    "name": "Sales",
    "color": "#2f6fed",
    "member_uids": ["uid_alice", "uid_bob"],
    "auto_assign_enabled": true,
    "routing_agents": [],
    "routing_channels": ["whatsapp"],
    "created_by": "owner_uid_123"
  }
}

Päivitä osasto #

PATCH /team/departments/{departmentId}

Muuttaa osastoa. Vain lähettämäsi kentät muuttuvat.

curl -X PATCH "https://api.youraiconnector.com/v1/team/departments/dep_abc123?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "member_uids": ["uid_alice"], "auto_assign_enabled": false }'

Vastaus

{
  "success": true,
  "department": {
    "id": "dep_abc123",
    "name": "Sales",
    "color": "#2f6fed",
    "member_uids": ["uid_alice"],
    "auto_assign_enabled": false,
    "routing_agents": [],
    "routing_channels": ["whatsapp"],
    "created_by": "owner_uid_123"
  }
}

Jos yhtään tunnistettua kenttää ei lähetetä, palautetaan 400; tuntematon osasto palauttaa 404; nimi, joka on ristiriidassa toisen osaston kanssa, palauttaa 409.

Osaston poistaminen #

DELETE /team/departments/{departmentId}

curl -X DELETE "https://api.youraiconnector.com/v1/team/departments/dep_abc123?apiKey=YOUR_API_KEY"

Vastaus

{
  "success": true,
  "deleted": "dep_abc123"
}

Osaston poistaminen, johon joku on rajoitettu, evätään. 400-vastaus nimeää ne jäsenet, joiden näkyvyys on rajoitettu kyseiseen osastoon, jotta voit muuttaa heidän laajuuttaan ensin. Tämä on harkittua: heidän rajoitustensa hiljainen poistaminen antaisi heille pääsyn koko asiakaskuntaasi ilman, että siitä jäisi mitään merkkiä.

Poistetun osaston alle arkistoituja yhteystietoja ei muuteta – niissä ei vain enää näy osastoa, ja seuraavan kerran kun arkistoit ne, se tallentuu.

Tarkista omat käyttöoikeutesi #

GET /team/permissions

Palauttaa tiedot siitä, mitä kirjautunut henkilö saa tehdä tilillä, jossa hän parhaillaan työskentelee. Käytä tätä piilottaaksesi painikkeet, joita jäsen ei voi käyttää, sen sijaan että antaisit heidän huomata rajoituksen virheilmoituksen kautta.

cURL

curl "https://api.youraiconnector.com/v1/team/permissions" \
  -H "Authorization: Bearer FIREBASE_ID_TOKEN"

Vastaus – tilin omistaja

{
  "success": true,
  "role": "owner",
  "is_team_mode": false,
  "permissions": {
    "campaigns": "full",
    "contacts": "full",
    "messages": "full",
    "appointments": "full",
    "settings": "full",
    "billing": "full",
    "team_management": "full",
    "analytics": "full",
    "phone_numbers": "full",
    "integrations": "full",
    "faqs": "full",
    "daily_summaries": "full"
  }
}

Vastaus – tiimin jäsen, joka työskentelee tilin sisällä

{
  "success": true,
  "role": "editor",
  "is_team_mode": true,
  "permissions": { "campaigns": "edit", "billing": "none", "…": "…" },
  "member": {
    "uid": "uid_sam",
    "email": "sam@example.com",
    "display_name": "Sam Rivera",
    "account_owner_uid": "owner_uid_123"
  }
}

role on owner, kun kirjautunut henkilö on tilin omistaja; muussa tapauksessa se on hänen tiimiroolinsa. member on läsnä vain tiimitilassa, ja se sisältää contact_scope, contact_scope_unassigned ja contact_scope_axes, kun heidän jäsenyytensä ne sisältää.

Istuntotunnisteet #

Viisi päätepistettä luovat kertakäyttöisen kirjautumistunnisteen tilien välillä vaihtamista varten. Ne kaikki vastaavat samalla tavalla:

{
  "success": true,
  "customToken": "eyJhbGciOi…"
}

Tunniste vaihdetaan istuntoon Firebase-asiakas-SDK:n avulla. Se ei ole API-avain, eikä sitä voi lähettää sellaisena, minkä vuoksi nämä päätepisteet ovat hyödyllisiä vain ensimmäisen osapuolen sovelluksissa.

Jokainen hylätään virheellä 403, kun istunnolla ei ole siihen oikeutta: käyttäjä ei ole kyseisen tilin jäsen, ei ole henkilökuntaa, kyseinen alatili ei kuulu toimistollesi tai sitä ei ole myönnetty sinulle, tai istunto ei ole tällä hetkellä siinä tilassa, jota päätepiste edellyttää.

Määritä alustarooli #

POST /team/users/{targetUid}/role

Asettaa käyttäjän alustaroolin — User, Dev, Support tai Agency. Tämä ei ole tiimin jäsenyys: se määrittää, millainen Your AI Connector-tili henkilöllä on.

Tämä päätepiste on rajoitettu Your AI Connector-henkilökunnalle, eikä viimeistä jäljellä olevaa Dev-käyttäjää voi alentaa. Listattu täydellisyyden vuoksi; se ei ole osa oman tiimin hallintaa.

{
  "success": true,
  "targetUid": "uid_sam",
  "role": "Agency",
  "claimUpdated": true
}

Tiimin API-virheet #

Tiimin päätepisteet palauttavat vakioituja virheviestejä, joissa on aina error_code HTTP-tilan ohella:

{
  "success": false,
  "error_code": 403,
  "error": "Cannot grant \"full\" access to \"billing\" — exceeds your own permissions."
}

Jaetut koodit, jotka jokainen päätepiste voi palauttaa — 429 (nopeusrajoitus) ja 500 — on listattu uudelleenkokeiluohjeiden kera kohdassa Virheet ja sivutus.

Aiheeseen liittyvää #

• Tiimin hallinta — samat ominaisuudet hallintapaneelissa kuvakaappausten kera.
• Todennus — miten lähetät Firebase ID -tunnisteen API-avaimen sijaan.
• Yhteystietojen API — yhteystiedot, joihin jäsenen näkyvyysrajoitukset soveltuvat.