https://gateway.streamfizz.live/apiInvite les spectateurs listés dans un fichier CSV, comme addVisitors.
Une ligne par spectateur, 1 000 au plus. La première ligne est un en-tête si l'une de ses cellules vaut Email, Liste email ou Locale (sans tenir compte de la casse) : les colonnes sont alors lues par leur nom, dans n'importe quel ordre. Sinon, elle est lue comme un spectateur, la première colonne valant e-mail et la deuxième langue (FR ou EN, FR par défaut). Le séparateur — virgule ou point-virgule — est détecté sur la première ligne. Les lignes dont l'e-mail est invalide, ou hors des domaines autorisés (allowedDomains), sont ignorées ; si aucune ligne n'est dans un domaine autorisé, rien n'est ajouté ni retiré. Un export de exportVisitorsToCsv se réimporte tel quel.
Renvoie les seuls spectateurs créés.
Une ligne d'en-tête, puis un spectateur par ligne. La langue vaut FR si elle est absente ou inconnue ; le séparateur peut être une virgule ou un point-virgule. Un fichier produit par exportVisitorsToCsv convient aussi : les colonnes qui suivent sont ignorées.
Email;Locale
jeanne.martin@exemple.fr;FR
john.smith@example.com;EN| 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. |
url* | String! | URL publique du fichier .csv, 5 Mo au plus. Téléchargé pendant la requête ; la copie est effacée dès sa lecture. |
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. |
shouldReplace | Boolean= false | Retire les spectateurs absents du fichier, sauf ceux qui ont déjà visité le contenu. Sont aussi retirés ceux dont l'e-mail figure dans le fichier mais hors des domaines autorisés. |
[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: {field}: URL must point to a public host |
| |
Validation failed: url: Too many rows (1000 max) | Le fichier compte plus de 1 000 spectateurs valides. L'erreur porte sur | |
Validation failed: url: No row has an allowed email domain | Aucune ligne valide du fichier n'est dans les domaines autorisés du contenu ( | |
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. |
URL_UNREACHABLE | Unable to reach URL |
|
URL_ACCESS_DENIED | Cannot access URL |
|
DOWNLOAD_FAILED | Source too large: {size}b (max {max}b) | Le fichier dépasse 5 Mo. Le téléchargement s'interrompt dès que la limite est franchie et rien n'est conservé. Quand le serveur distant n'annonce pas la taille, le message devient |
INVALID_CSV_FORMAT | URL must point to a .csv file | Le chemin de l'URL ne se termine pas par |
The CSV file could not be read or contains no usable row | Le fichier n'est pas un CSV lisible, ou aucune de ses lignes ne porte d'e-mail valide. Aucun spectateur n'est ajouté ni retiré. |
60 requêtes par minute par clé API
En cas de dépassement, une erreur 429 Too Many Requests est retournée.