https://gateway.streamfizz.live/apiConfigure l'inscription des spectateurs d'un direct. Le premier appel crée la configuration, publique par défaut ; ensuite, les arguments absents ou à null restent inchangés.
Renvoie le direct : la configuration se lit dans privacy.
| Nom | Type | Description |
|---|---|---|
id* | ID! | Direct à configurer. |
type | PrivacyType |
|
allowDirectRegister | Boolean | Inscription ouverte ( |
allowPreviewContent | Boolean | Montre le titre et la vignette du contenu sur la page d'inscription. Défaut à la création : |
allowMultiSession | Boolean | Autorise un spectateur à regarder depuis plusieurs appareils à la fois. Sinon, une nouvelle connexion ferme la précédente sur ce contenu. Défaut à la création : |
allowSocialLogin | Boolean | Propose la connexion avec Google ou LinkedIn. Défaut à la création : |
allowedDomains | [String!] | Domaines d'e-mail autorisés, invités compris. Remplace la liste ; une liste vide autorise tous les domaines. Chaque domaine est mis en minuscules, sans |
fields | [InscriptionFieldInput!] | Champs demandés à l'inscription, dans l'ordre d'affichage. Remplace la liste. Le libellé |
Live| Nom | Type | Description |
|---|---|---|
id | ID! | Identifiant unique du direct. |
title | String! | Titre du direct. |
status | LiveStatusType! | Statut courant du direct. Valeurs possibles :
|
myCapability | AuthzCapability! | Ce que l'appelant a le droit de faire sur ce contenu, compte tenu de ses
groupes et de ses accès directs : |
note | String | Note interne sur le direct. |
duration | Int | Durée du direct en secondes. |
currentAudienceDéprécié | Int | Audience temps réel : nombre de spectateurs uniques sur la dernière minute glissante. Calculé à la volée : spectateurs du direct en Running, spectateurs en attente en Preview, null sinon. Déprécié : Utiliser getLiveAnalytics(id: ...).realtime.currentViewers |
maxPeakViewersDéprécié | Int | Pic de spectateurs uniques atteint pendant le direct, figé à la fin du direct. À afficher une fois le direct terminé. Déprécié : Utiliser getLiveAnalytics(id: ...).realtime.peakConcurrentViewers |
fallbackAcknowledged | Boolean | Indique si le fallback a été acquitté par l'utilisateur. |
publicUrl | String | URL de la page de lecture publique. |
publicEmbedUrl | String | URL d'intégration (embed) publique. |
shouldShowCountdown | Boolean | Affiche un compte à rebours avant le direct. |
isRocket | Boolean! | Indique si le direct est diffusé via Roquette (sinon Wowza legacy). |
activeSource | RelaySource | Source d'ingest actuellement diffusée — Roquette uniquement. |
fallbackActive | Boolean | Indique si le fallback est actuellement actif. |
waitingThumbKey | String | Clé S3 de la vignette d'attente. |
waitingThumbCdnUrl | String | URL CDN de la vignette d'attente. |
thumbnailVttCdnUrl | String | URL CDN du VTT des vignettes de scrubbing (live Rocket uniquement, sinon null). |
deltaChapter | Int | Décalage en secondes appliqué aux points de chapitre à la lecture, pour rattraper la latence d'encodage et de diffusion. |
accessGroups | [Group!]! | Groupes ayant accès à ce direct. |
directUsers | [PublicUser!]! | Utilisateurs ayant un accès direct à ce direct. |
publisher | User | Utilisateur ayant créé le direct. |
account | Account | Compte propriétaire du direct. |
createdAt | DateTime | Date de création du direct. |
updatedAt | DateTime | Date de dernière modification du direct. |
scheduledStartAt | DateTime | Date de début programmée, informative. À la création, vaut par défaut la prochaine demi-heure ; modifiable ou effaçable par updateLive. |
lifecycle | LiveLifecycle | Dates réelles du cycle de vie (démarrages, fin, échéances d'arrêt auto). |
ingest | LiveIngest | Credentials d'ingest (RTMP / SRT). |
playback | LivePlayback | URLs de lecture du direct (HLS). |
recording | LiveRecording | Options d'enregistrement et de relecture (DVR, VOD, replay). |
relaySources | [RelaySourceInfo!] | État de chaque source d'ingest (primary / backup) — Roquette uniquement. |
transcoderDéprécié | TranscoderTMP | Transcoder Wowza associé (legacy). Déprécié : Transcoder Wowza legacy, sera retiré. |
transcoderInfos | TranscoderInfos | Infos temps réel du transcoder (bitrate, résolution, cibles). |
subtitles | LiveSubtitles | Configuration du sous-titrage en direct — Roquette uniquement. |
chapters | [Chapter] | Chapitres associés au direct. |
files | [File!] | Fichiers joints au direct. |
discussion | Discussion | Discussion (chat) associée au direct. |
liveDestinations | [LiveDestination] | Destinations de simulcast (réémission RTMP vers des plateformes tierces). |
relatedTags | [Tag] | Tags rattachés. |
relatedCategories | [Category] | Catégories rattachées. |
pageSetting | BrandSetting | Paramètres de personnalisation de la page de lecture. |
embedSetting | BrandSetting | Paramètres de personnalisation de l'embed. |
seo | SEO | Paramètres SEO de la page de lecture. |
confidentiality | Confidentiality | Niveau de confidentialité (nouveau modèle). |
privacy | Privacy | Inscription des spectateurs. |
playlists | PlaylistConnection | Playlists contenant ce direct. |
webTVs | WebTVConnection | WebTVs contenant ce direct. |
originalPublisher | DeletedUser | - |
| Code | Message | Description |
|---|---|---|
UNAUTHENTICATED | Invalid or expired API key | Clé API manquante ( |
API_ADDON_REQUIRED | This account does not have the API addon | La clé est valide mais le compte n'a pas l'option API. La réponse porte un code HTTP 403 ; la requête n'est pas exécutée. |
INPUT_VALIDATION_ERROR | Validation failed: {field}: {message} | Un ou plusieurs champs sont invalides (format, longueur, protocole…). Le détail est dans extensions.fieldErrors[]. Tout argument texte qui n'est pas de l'Unicode valide — caractère NUL ( |
GRAPHQL_VALIDATION_FAILED | Query depth limit of 10 exceeded, found {depth}. | Le document ne respecte pas le schéma : champ ou argument inconnu, valeur écrite en dur dans la requête qui n'a pas le type attendu (valeur d'enum inexistante…), ou limite par requête dépassée (profondeur, coût, alias, directives — voir Rate Limiting). La réponse porte un code HTTP 400 ; rien n'est exécuté. |
BAD_USER_INPUT | Variable "$name" got invalid value {value}; {reason} | Une variable ( |
INTERNAL_SERVER_ERROR | Internal server error | Erreur interne du serveur. Le message est volontairement générique : le détail est journalisé côté Streamfizz, jamais renvoyé. |
| Code | Message | Description |
|---|---|---|
NOT_FOUND | Live '{id}' has not been found | L' |
FORBIDDEN | You don't have the permission for this request | Le contenu appartient à un autre compte, ou l'utilisateur de la clé n'a pas le droit d'écriture sur lui. Pour une clé qui n'est ni propriétaire ni administrateur du compte, un identifiant inconnu donne aussi cette erreur. |
INPUT_VALIDATION_ERROR | Validation failed: allowedDomains.{index}: Invalid domain | Une entrée de |
Validation failed: fields: Duplicate form label | Un même | |
Validation failed: fields: Unknown form label | Un | |
Validation failed: {field}: Too big: expected array to have <={max} items |
|
60 requêtes par minute par clé API
En cas de dépassement, une erreur 429 Too Many Requests est retournée.