Skip to main content
POST
Publique ou agende a mídia original do projeto nos seus próprios canais YouTube/TikTok conectados, opcionalmente com legendas dinâmicas. Esta ação publica externamente; escolha a privacidade explicitamente quando desejar acesso público.

Autenticação e permissões

string
obrigatório
Envie uma chave de API VoiceCheap neste cabeçalho. Authorization: Bearer com a mesma chave de API também é aceito. Tokens de acesso OAuth são aceitos apenas pelo MCP, não por este endpoint REST.
Permissões necessárias: publishing:write, projects:read. É necessária uma assinatura paga ativa. As permissões não alteram funções na equipe, propriedade dos recursos, créditos de mídia ou limites do plano.

Parâmetros

string
obrigatório
Valor de texto.Comprimento mínimo: 1. Comprimento máximo: 200. Padrão: ^[^/\\]+$.
string
obrigatório
Valor de texto.Comprimento mínimo: 1. Comprimento máximo: 200. Padrão: ^[^/\\]+$.
string
obrigatório
Valor de texto.Comprimento mínimo: 1. Comprimento máximo: 100.
string
Valor de texto.Comprimento máximo: 5000.
array
Lista de valores. Consulte o esquema de entrada completo para ver a estrutura dos itens.Máximo de itens: 20.
array
Lista de valores. Consulte o esquema de entrada completo para ver a estrutura dos itens.Máximo de itens: 20.
string
Valor de texto.Valores aceitos: “public”, “unlisted”, “private”. Valor padrão: “private”.
string
Valor de texto.Valores aceitos: “PUBLIC_TO_EVERYONE”, “MUTUAL_FOLLOW_FRIENDS”, “FOLLOWER_OF_CREATOR”, “SELF_ONLY”. Valor padrão: “SELF_ONLY”.
boolean
Valor booleano.Valor padrão: false.
string
Valor de texto.Formato: “date-time”. Padrão: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$.
string
Opcional na camada de transporte: o servidor insere um identificador antes da validação quando ele é omitido. Forneça seu próprio UUID v4 estável para recuperar com segurança uma resposta perdida.Formato: “uuid”. Padrão: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$.
O JSON Schema abaixo preserva os nomes exatos dos campos, tipos aninhados, valores padrão, limites e valores aceitos expostos pela descoberta. Regras adicionais entre campos são listadas nas notas da operação.

Idempotência

Use um UUID v4 em requestId ou no cabeçalho HTTP Idempotency-Key para cada alteração. Reutilize o mesmo identificador e argumentos idênticos após uma falha de rede. Se ambos forem fornecidos, devem ser iguais. Repetir uma requisição salva não repete a operação nem consome outra chamada mensal. Requisições com falha ou interrompidas não são reiniciadas automaticamente. Qualquer alteração pode retornar HTTP 202 quando uma nova tentativa encontra a mesma requisição ainda em execução, mesmo que a primeira execução normalmente seja síncrona. Se a execução foi concluída, mas resultStored é false, uma nova tentativa retorna HTTP 200 com o estado salvo da requisição em vez do resultado original. Recupere a saída pela ação de histórico, resultado ou download do domínio correspondente.

Exemplos de requisição

Substitua os identificadores de recursos e as chaves de mídia dos exemplos pelos valores retornados para sua conta. Mantenha o identificador da requisição ao tentar novamente a mesma alteração.

Resposta

Esta operação retorna HTTP 202 enquanto está em execução. Salve requestId e consulte action_request_get com esse identificador e o nome da operação original. Os estados de consulta são running, completed, failed e interrupted. Um resultado concluído pode apontar para um processamento de mídia separado; continue com a ação de status ou de saída específica da operação. Retorna o estado público atualizado da publicação original após solicitar a publicação ou o agendamento nos canais selecionados.

Campos do resultado

Recuperar e consultar esta requisição

Use o mesmo identificador mesmo após perder a conexão. Se resultStored for false, recupere a saída pela ação correspondente de histórico, resultado ou download. Nunca inicie uma segunda geração apenas para verificar o progresso.
HTTP 200

Notas da operação

  • Esta ação publica externamente e exige a propriedade do projeto. Pelo menos um dos arrays youtubeChannelIds ou tiktokChannelIds deve conter um canal conectado ao ator autenticado; cada array permite no máximo 20 entradas.
  • workId deve pertencer a este projeto, mesmo que a mídia selecionada seja o vídeo original.
  • A integração usa os padrões youtubePrivacyStatus private e tiktokPrivacyLevel SELF_ONLY. Defina explicitamente a privacidade desejada quando pretender conceder acesso mais amplo.
  • includeDynamicSubtitles usa false por padrão e exige subtitles:write quando ativado. Ele usa as cotas normais de legendas e os créditos de mídia.
  • scheduledAt é uma data e hora ISO opcional com deslocamento de fuso. Somente um horário estritamente no futuro agenda o fluxo original; um timestamp passado válido não o agenda e pode publicar imediatamente.
  • Esta é uma ação de longa duração. Consulte periodicamente action_request_get até a conclusão do handler e depois publishing_list para acompanhar o progresso da publicação do recurso ou os resultados agendados.
  • originalPublish pode ser null quando não há estado disponível ou mostrar o estado in-progress, scheduled, completed ou failed. Os resultados de cada canal estão em channels, portanto um resultado retornado não garante a publicação bem-sucedida em todos os canais.

Uso

Cada chamada bem-sucedida consome uma chamada mensal da API/MCP. Os créditos de mídia e as cotas de geração da própria operação também se aplicam.

Erros