API do X

​

Chaves de API BYO do X

​

Publicando no X (Twitter)

{
  "post": "The best Tweet ever #best https://www.twitter.com", // empty string is allowed
  "mediaUrls": ["https://img.ayrshare.com/012/gb.jpg"],
  "platforms": ["twitter"]
}

• O X mostrará automaticamente uma prévia do link no Tweet, a menos que haja uma imagem ou vídeo incluído. No exemplo acima, a imagem será exibida. Remover a imagem fará com que a prévia do link seja mostrada.
• Se seu vídeo não terminar em uma extensão de vídeo conhecida, como mp4, use o parâmetro isVideo. Consulte o endpoint /post para detalhes.
• O X também suporta o envio de mídia sem texto de publicação. Se você não quiser incluir texto na publicação, envie uma String vazia post: "".
• Você pode enviar até 4 imagens ou vídeos em um único Tweet. Consulte as importantes diretrizes e restrições sobre publicação de vídeos no Twitter.
• Consulte as Diretrizes de mídia do X e a Autorização do X para mais informações.

​

Opções do X

{
  "twitterOptions": {
    "altText": ["This is my best pic", "😃 here is the next one"],
    "blockCountries": ["US", "CA"], // or "allowCountries": ["GB", "IE"]
    "longPost": true,
    "longVideo": true,
    "poll": {
      "duration": 5, // required. Number in minutes
      "options": ["yes", "maybe", "no"] // required
    },
    "quoteTweetId": "651601430669664256",
    "replySettings": "mentioned",
    "subscribersOnly": true,
    "thumbNail": "https://img.ayrshare.com/012/gb.jpg",

    // Video Metadata
    "videoTitle": "My Product Demo",
    "videoDescription": "A short walkthrough of our latest release.",

    // Subtitles / Captions for Videos
    "subTitleUrl": "https://img.ayrshare.com/012/captions.srt",
    "subTitleLanguage": "en",
    "subTitleName": "English",

    // Thread Options
    "thread": true,
    "threadNumber": true,
    "mediaUrls": ["https://img.ayrshare.com/012/gb.jpg"],
  }
}

​

Texto alternativo

{
  "twitterOptions": {
    "altText": ["This is my best pic", "😃 here is the next one"] // Array of Alt Texts
  }
}

​

Restrições geográficas

{
  "twitterOptions": {
    "blockCountries": ["US", "CA"]
  }
}

{
  "twitterOptions": {
    "allowCountries": ["GB", "IE"]
  }
}

• blockCountries: um array de códigos de país a serem bloqueados. Consulte códigos de país.
• allowCountries: um array de códigos de país a serem permitidos. Consulte códigos de país.

​

Post longo

{
  "twitterOptions": {
    "longPost": true
  }
}

​

Vídeo longo

{
  "twitterOptions": {
    "longVideo": true
  }
}

​

Menções

{
  "post": "The best social media API @Ayrshare ever!",
  "platforms": ["twitter"]
}

​

Enquetes

{
  "twitterOptions": {
    "poll": {
      "duration": 5, // required. Number in minutes
      "options": ["yes", "maybe", "no"] // required
    }
  }
}

• duration: um número de minutos especificando a duração pela qual a enquete será realizada.
• options: um array de strings com as opções da enquete.

​

Quote Tweet

{
  "twitterOptions": {
    "quoteTweetId": "651601430669664256" // low-level Tweet Id
  }
}

​

Configurações de resposta

{
  "twitterOptions": {
    "replySettings": "mentioned"
  }
}

• following: apenas usuários que a conta do X segue podem responder.
• mentioned: apenas usuários mencionados na publicação podem responder.
• subscribers: apenas usuários que são assinantes da conta do X que publicou podem responder.
• verified: apenas usuários verificados no X podem responder à publicação.

​

Somente assinantes

{
  "twitterOptions": {
    "subscribersOnly": true
  }
}

​

Legendas / Subtítulos para vídeos

{
  "twitterOptions": {
    "subTitleUrl": "https://img.ayrshare.com/012/captions.srt",
    "subTitleLanguage": "en",
    "subTitleName": "English"
  }
}

• subTitleUrl: um arquivo SRT válido. A URL deve começar com https://, terminar em .srt e ser um arquivo SRT válido.
• subTitleLanguage: opcional. O idioma das legendas. Deve ser um código de idioma válido. Padrão: “en”.
• subTitleName: opcional. O nome da trilha de legenda. O nome deve ser visível para o usuário como uma opção durante a reprodução. O comprimento máximo suportado do nome é de 150 caracteres. Padrão: “English”.

​

Miniatura de vídeo

{
  "twitterOptions": {
    "thumbNail": "https://img.ayrshare.com/012/gb.jpg"
  }
}

• “thumbNail”: uma URL para a imagem da miniatura. Os formatos de imagem suportados são JPEG, PNG, BMP e WebP.
• A imagem da miniatura deve representar o conteúdo do vídeo e ser visualmente atraente para incentivar o engajamento.
• Consulte as Diretrizes de mídia do X para os requisitos de imagem.

​

Metadados de vídeo

{
  "twitterOptions": {
    "videoTitle": "My Product Demo",
    "videoDescription": "A short walkthrough of our latest release."
  }
}

• videoTitle: o título do vídeo, mapeado para o campo de título do X Media Studio.
• videoDescription: a descrição do vídeo, mapeada para o campo de descrição do X Media Studio.

​

Monetização de vídeo (Pro Media)

​

Thread

​

Publicando um Thread

{
    "twitterOptions": {
        "thread": true,        // required for TweetStorm
        "threadNumber": true,  // optional to add numbers to each thread
        "mediaUrls": ["https://site.com/image1.png", "https://site.com/image2.png", ...]  // optional one media object is added to a thread in order
    }
}

• thread: true para dividir automaticamente o texto da publicação em threads com base nas quebras de linha.
• threadNumber: true para adicionar automaticamente números ao final dos threads no formato 1/n. Por exemplo, o 2º de 5 threads terá anexado: 2/5
• mediaUrls: [array de urls] para adicionar cada objeto de mídia, uma imagem ou vídeo, a um thread em ordem. Apenas um objeto de mídia será adicionado a cada thread em ordem.

​

Mídia de thread

Pular mídia

Múltiplas mídias

{
  "twitterOptions": {
    "thread": true,
    "threadNumber": true,
    "mediaUrls": [
      "https://img.ayrshare.com/random/photo-1.jpg",
      {
        "1": "https://img.ayrshare.com/random/photo-2.jpg",
        "2": "https://img.ayrshare.com/random/photo-3.jpg"
      },
      "https://img.ayrshare.com/random/photo-4.jpg"
    ]
  }
}

​

Quebras de thread

{
  "post": "This is tweet 1\n\nThis is tweet 2.",
  "platforms": ["twitter"],
  "twitterOptions": {
    "thread": true
  }
}

{
  "post": "This is paragraph 1\u2063\n\u2063\nThis is paragraph 2.",
  "platforms": ["twitter"],
  "twitterOptions": {
    "thread": true
  }
}

​

Excluir um thread

​

Limites de caracteres

​

Compatibilidade de vídeo do X

​

Somente assinantes

{
  "twitterOptions": {
    "subscribersOnly": true
  }
}

​

Configurações de resposta

{
  "twitterOptions": {
    "replySettings": "mentioned"
  }
}

• following: apenas usuários que a conta do X segue podem responder.
• mentioned: apenas usuários mencionados na publicação podem responder.
• subscribers: apenas usuários que são assinantes da conta do X que publicou podem responder.
• verified: apenas usuários verificados no X podem responder à publicação.