Skip to main content
POST
Créer

Supported products

Autorisations

Authorization
string
header
requis

The access token received from the authorization server in the OAuth 2.0 flow.

Corps

application/json
mediaType
enum<string>
requis

Le type de média lu, tel que « VIDÉO » , « AUDIO » , « DOCUMENT » , « AUTRE » ou « IMAGE » .

Options disponibles:
AUDIO,
DOCUMENT,
IMAGE,
OTHER,
VIDEO
occurredTimestamp
integer<int64>
requis

L'horodatage de l'événement de lecture du média, au format Unix.

sessionId
string
requis

Un identifiant unique pour la session pendant laquelle le média a été lu.

state
enum<string>
requis

L'état de l'événement de scénario multimédia, indiquant le statut actuel.

Options disponibles:
STARTED,
VIEWED
_hsenc
string

Un paramètre d'encodage utilisé en interne par HubSpot.

contactId
integer<int64>

L'identifiant unique du contact associé à l'événement de scénario.

contactUtk
string

La clé de suivi unique pour le contact, utilisée à des fins de suivi.

externalId
string

Un identifiant externe pour le média, utilisé pour la corrélation avec des systèmes externes.

externalPlayContext
enum<string>

Contexte additionnel sur l'événement de scénario média, fourni par des systèmes externes.

Options disponibles:
EMAIL,
EXTERNAL_PAGE
iframeUrl
string

L'URL de l'iframe contenant le média.

mediaBridgeId
integer<int64>

Un identifiant unique pour l'instance du pont media.

mediaName
string

Le nom du média qui a été lu.

mediaUrl
string

L'URL du média qui a été lu.

pageId
integer<int64>

Un identifiant unique pour la page où le média a été lu.

pageName
string

Le nom de la page où le média a été lu.

pageUrl
string

L'URL de la page où le média a été lu.

Réponse

successful operation

contactId
integer<int64>
requis

L'identifiant unique du contact associé à cet événement média.

mediaBridgeId
integer<int64>
requis

L'identifiant unique de l'instance de pont média associée à cet événement.

mediaBridgeObjectCoordinates
string
requis

Coordonnées qui spécifient l'emplacement ou le contexte de l'objet de pont multimédia.

mediaBridgeObjectTypeId
string
requis

L'identifiant de type de l'objet de pont média impliqué dans l'événement.

mediaName
string
requis

Le nom du contenu multimédia qui a été lu.

mediaType
enum<string>
requis

Le type de média lu, tel que la vidéo ou l'audio.

Options disponibles:
AUDIO,
DOCUMENT,
IMAGE,
OTHER,
VIDEO
occurredTimestamp
integer<int64>
requis

Un horodatage unix en millisecondes indiquant le moment où l'événement de lecture du média s'est produit.

portalId
integer<int32>
requis

L'identifiant unique du portail HubSpot où l'événement s'est produit.

providerId
integer<int32>
requis

L'identifiant unique du fournisseur de médias.

sessionId
string
requis

L'identifiant unique de la session pendant laquelle le média a été lu.

state
enum<string>
requis

L'état de l'événement de lecture multimédia, tel que « démarré » ou « terminé ».

Options disponibles:
STARTED,
VIEWED
externalPlayContext
enum<string>

Contexte additionnel fourni par des systèmes externes concernant l'événement de scénario.

Options disponibles:
EMAIL,
EXTERNAL_PAGE
iframeUrl
string

L'URL de l'iframe où le média a été intégré et lu.

mediaUrl
string

L'URL où le contenu multimédia est hébergé.

pageId
integer<int64>

L'identifiant unique de la page où le média a été lu.

pageName
string

Le nom de la page où le média a été lu.

pageObjectCoordinates
string

Coordonnées qui indiquent l'emplacement ou le contexte de l'objet de la page.

pageUrl
string

L'URL de la page où le média a été lu.

Dernière modification le 6 octobre 2026