https://gateway.streamfizz.live/apiInvite des spectateurs sur un contenu. Fournir exactement un de mediaId, liveId, playlistId, webTVId ; l'inscription du contenu doit avoir été configurée (updateMediaPrivacy & co).
Les e-mails sont mis en minuscules ; un e-mail déjà présent sur le contenu est ignoré, quel que soit son statut. L'accès est accordé tout de suite (ACCEPTED). Un e-mail hors des domaines autorisés du contenu (allowedDomains) fait échouer tout le lot, sans rien enregistrer.
L'invitation part en arrière-plan : invitationStatus passe de PENDING à SENT ou FAILED. Sur un contenu PUBLIC, aucune invitation n'est envoyée.
Renvoie les seuls spectateurs créés.
| Nom | Type | Description |
|---|---|---|
mediaId | ID | Média dont les spectateurs sont gérés. |
liveId | ID | Direct dont les spectateurs sont gérés. |
playlistId | ID | Playlist dont les spectateurs sont gérés. |
webTVId | ID | WebTV dont les spectateurs sont gérés. |
users* | [VisitorAccessInput!]! | Spectateurs à inviter, 1 000 au plus. |
customEmailMessages | [EmailCustomMessageInput!] | Message ajouté aux invitations, un par langue au plus. Remplace le message déjà enregistré pour cette langue, et sert aussi aux relances. |
[VisitorAccess!]!| Nom | Type | Description |
|---|---|---|
id | ID! | - |
status | VisitorAccessStatus! | Décision d'accès. Seul |
email | String! | E-mail invité ou inscrit, en minuscules. |
invitationStatus | VisitorInvitationStatus | État du dernier e-mail d'invitation. |
locale | Locale! | Langue des e-mails envoyés à ce spectateur. |
lastLogin | DateTime | Dernière visite du contenu. |
createdAt | DateTime! | Date de l'invitation ou de la demande d'accès. |
updatedAt | DateTime! | - |
visitor | Visitor | Profil du spectateur. |
L'accès est accordé tout de suite, l'e-mail part en arrière-plan : invitationStatus revient en PENDING, puis passe à SENT ou FAILED. Pour retrouver les échecs, filtrez la liste, puis relancez-les avec inviteVisitors.
{
getVisitors(
mediaId: "MEDIA_ID"
filter: { invitationStatus: [FAILED] }
) {
totalCount
visitors {
id
email
}
}
}| 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 |
|---|---|---|
INPUT_VALIDATION_ERROR | Validation failed: mediaId: Provide exactly one of mediaId, liveId, playlistId or webTVId | Aucun, ou plusieurs, des arguments |
Validation failed: users.{index}.email: Invalid email | Un e-mail de | |
Validation failed: users.{index}.email: Email domain is not allowed on this content | Un e-mail de | |
Validation failed: users: {message} |
| |
Validation failed: customEmailMessages: {message} |
| |
NOT_FOUND | {Type} '{id}' has not been found | L'identifiant ne désigne aucun contenu de ce type ( |
This content has no privacy settings | Le contenu existe, mais son inscription n'a jamais été configurée. La configurer d'abord avec | |
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. |
60 requêtes par minute par clé API
En cas de dépassement, une erreur 429 Too Many Requests est retournée.