Skip to main content
POST
Criar

Supported products

Autorizações

Authorization
string
header
obrigatório

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

Corpo

application/json
mediaType
enum<string>
obrigatório

O tipo de mídia que foi reproduzida, como "VIDEO", "AUDIO", "DOCUMENT", "OTHER" ou "IMAGE".

Opções disponíveis:
AUDIO,
DOCUMENT,
IMAGE,
OTHER,
VIDEO
occurredTimestamp
integer<int64>
obrigatório

A data/hora em que o evento de reprodução de mídia ocorreu, no formato de tempo Unix.

sessionId
string
obrigatório

O identificador exclusivo da sessão durante a qual a mídia foi reproduzida.

state
enum<string>
obrigatório

O estado do evento de reprodução de mídia, indicando o status atual.

Opções disponíveis:
STARTED,
VIEWED
_hsenc
string

Um parâmetro de codificação usado internamente pela HubSpot.

contactId
integer<int64>

O identificador exclusivo do contato associado ao evento de reprodução de mídia.

contactUtk
string

A chave de rastreamento exclusiva do contato, usada para fins de rastreamento.

externalId
string

Um identificador externo da mídia, usado para correlacionar com sistemas externos.

externalPlayContext
enum<string>

Contexto adicional sobre o evento de reprodução de mídia, fornecido por sistemas externos.

Opções disponíveis:
EMAIL,
EXTERNAL_PAGE
iframeUrl
string

A URL do iframe que contém a mídia, se aplicável.

mediaBridgeId
integer<int64>

Um identificador exclusivo para a instância da media bridge.

mediaName
string

O nome da mídia que foi reproduzida.

mediaUrl
string

A URL da mídia que foi reproduzida.

pageId
integer<int64>

Um identificador exclusivo para a página onde a mídia foi reproduzida.

pageName
string

O nome da página em que a mídia foi reproduzida.

pageUrl
string

A URL da página onde a mídia foi reproduzida.

Resposta

successful operation

contactId
integer<int64>
obrigatório

O identificador exclusivo para o contato associado a este evento de mídia.

mediaBridgeId
integer<int64>
obrigatório

O identificador exclusivo da instância de Media Bridge associada a este evento.

mediaBridgeObjectCoordinates
string
obrigatório

Coordenadas que especificam a localização ou o contexto do objeto de Media Bridge.

mediaBridgeObjectTypeId
string
obrigatório

O identificador de tipo do objeto de Media Bridge envolvido no evento.

mediaName
string
obrigatório

O nome do conteúdo de mídia que foi reproduzido.

mediaType
enum<string>
obrigatório

O tipo de mídia que foi reproduzida, como vídeo ou áudio.

Opções disponíveis:
AUDIO,
DOCUMENT,
IMAGE,
OTHER,
VIDEO
occurredTimestamp
integer<int64>
obrigatório

Uma data/hora Unix em milissegundos que indica quando o evento de reprodução de mídia ocorreu.

portalId
integer<int32>
obrigatório

O identificador exclusivo do portal HubSpot onde o evento ocorreu.

providerId
integer<int32>
obrigatório

O identificador exclusivo para o provedor de mídia.

sessionId
string
obrigatório

O identificador exclusivo da sessão durante a qual a mídia foi reproduzida.

state
enum<string>
obrigatório

O estado do evento de reprodução de mídia, como "started" ou "completed".

Opções disponíveis:
STARTED,
VIEWED
externalPlayContext
enum<string>

Contexto adicional fornecido por sistemas externos sobre o evento de reprodução.

Opções disponíveis:
EMAIL,
EXTERNAL_PAGE
iframeUrl
string

A URL do iframe onde a mídia foi incorporada e reproduzida.

mediaUrl
string

A URL onde o conteúdo de mídia está hospedado.

pageId
integer<int64>

O identificador exclusivo da página em que a mídia foi reproduzida.

pageName
string

O nome da página em que a mídia foi reproduzida.

pageObjectCoordinates
string

Coordenadas que especificam a localização ou o contexto do objeto da página.

pageUrl
string

A URL da página onde a mídia foi reproduzida.

Última modificação em 6 de outubro de 2026