API X

​

Clés d’API X BYO

​

Publier sur 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"]
}

• X prévisualisera automatiquement le lien dans le Tweet sauf si une image ou une vidéo est incluse. Dans l’exemple ci-dessus, c’est l’image qui s’affichera. Retirer l’image affichera l’aperçu du lien.
• Si votre vidéo ne se termine pas par une extension vidéo connue telle que mp4, utilisez le paramètre isVideo. Consultez le point de terminaison /post pour plus de détails.
• X prend également en charge l’envoi de médias sans texte de publication. Si vous ne souhaitez pas inclure de texte, envoyez une chaîne vide post: "".
• Vous pouvez téléverser jusqu’à 4 images ou vidéos dans un seul Tweet. Consultez les recommandations et restrictions importantes concernant la publication de vidéos Twitter.
• Consultez X Media Guidelines et X Authorization pour plus d’informations.

​

Options 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"],
  }
}

​

Alt Text

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

​

Restrictions géographiques

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

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

• blockCountries : un tableau de codes pays à bloquer. Voir les codes pays.
• allowCountries : un tableau de codes pays à autoriser. Voir les codes pays.

​

Long Post

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

​

Long Video

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

​

Mentions

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

​

Sondages

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

• duration : un nombre de minutes spécifiant la durée du sondage.
• options : un tableau de chaînes contenant les options du sondage.

​

Quote Tweet

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

​

Paramètres de réponse

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

• following : seuls les utilisateurs que le compte X suit peuvent répondre.
• mentioned : seuls les utilisateurs mentionnés dans la publication peuvent répondre.
• subscribers : seuls les utilisateurs abonnés au compte X qui a publié le post peuvent répondre.
• verified : seuls les utilisateurs vérifiés sur X peuvent répondre au post.

​

Abonnés uniquement

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

​

Sous-titres / Légendes pour vidéos

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

• subTitleUrl : un fichier SRT valide. L’URL doit commencer par https://, se terminer par .srt et être un fichier SRT valide.
• subTitleLanguage : facultatif. La langue des sous-titres. Doit être un code de langue valide. Valeur par défaut : « en ».
• subTitleName : facultatif. Le nom de la piste de légendes. Le nom est destiné à être visible par l’utilisateur comme option pendant la lecture. La longueur maximale prise en charge est de 150 caractères. Valeur par défaut : « English ».

​

Miniature vidéo

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

• « thumbNail » : une URL vers l’image de miniature. Les formats d’image pris en charge sont JPEG, PNG, BMP et WebP.
• L’image de miniature doit représenter le contenu vidéo et être visuellement attractive pour encourager l’engagement.
• Consultez X Media Guidelines pour les exigences d’image.

​

Métadonnées vidéo

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

• videoTitle : le titre de la vidéo, mappé au champ titre de X Media Studio.
• videoDescription : la description de la vidéo, mappée au champ description de X Media Studio.

​

Monétisation vidéo (Pro Media)

​

Thread

​

Publier un 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 pour diviser automatiquement le texte de la publication en threads sur la base des sauts de ligne.
• threadNumber: true pour ajouter automatiquement des numéros à la fin des threads au format 1/n. Par exemple, le 2e des 5 threads aura la mention : 2/5
• mediaUrls: [array of urls] pour ajouter chaque objet média, image ou vidéo, à un thread dans l’ordre. Un seul objet média est ajouté à un thread dans l’ordre.

​

Média de thread

Ignorer un média

Plusieurs 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"
    ]
  }
}

​

Ruptures 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
  }
}

​

Supprimer un Thread

​

Limites de caractères

​

Compatibilité vidéo X

​

Abonnés uniquement

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

​

Paramètres de réponse

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

• following : seuls les utilisateurs que le compte X suit peuvent répondre.
• mentioned : seuls les utilisateurs mentionnés dans la publication peuvent répondre.
• subscribers : seuls les utilisateurs abonnés au compte X qui a publié le post peuvent répondre.
• verified : seuls les utilisateurs vérifiés sur X peuvent répondre au post.