Passer au contenu principal

​
Sous-modules

​
Contenu du module

Ce module donne accès aux endpoints de messages privés de la X API et sert de point d’entrée principal pour toutes les fonctionnalités liées aux messages privés.

​
class xdk.direct_messages.DirectMessagesClient

Client pour les opérations sur les messages directs

​
Paramètres

​
path.client
Client

​
__init__

​
Paramètres

​
path.client
Client

​
create_by_conversation_id

Créer un message de DM par id de conversation Envoie un nouveau message privé dans une conversation spécifique à partir de son id.

​
Paramètres

​
path.dm_conversation_id
str
L’ID de conversation de DM.
​
body.body
CreateByConversationIdRequest
Corps de la requête

​
create_by_participant_id

Créer un message de DM à partir de l’identifiant du participant Envoie un nouveau message privé à un participant spécifique en utilisant son identifiant.

​
Paramètres

​
path.participant_id
Any
L’identifiant de l’utilisateur destinataire qui recevra ce DM.
​
body.body
CreateByParticipantIdRequest
Corps de la requête

​
create_conversation

Créer une conversation de messages privés Initie une nouvelle conversation de messages privés avec les participants spécifiés. body: Corps de la requête :returns: Données de la réponse :rtype: CreateConversationResponse

​
Paramètres

​
body.body
CreateConversationRequest

​
delete_events

Supprimer un événement de message privé Supprime un événement de message privé spécifique par son id, s’il appartient à l’utilisateur authentifié.

​
Paramètres

​
path.event_id
Any
L’identifiant de l’événement de message privé à supprimer.

​
Renvoie

DeleteEventsResponse - Données de la réponse

​
get_events

Récupérer les événements de messages privés Récupère une liste des événements de messages privés récents pour l’ensemble des conversations.

​
Paramètres

​
path.max_results
int or None
défaut:"None"
Le nombre maximal de résultats.
​
path.pagination_token
Any or None
défaut:"None"
Ce paramètre est utilisé pour obtenir une « page » donnée de résultats.
​
path.event_types
List or None
défaut:"None"
L’ensemble des event_types à inclure dans les résultats.
​
path.dm_event_fields
List or None
défaut:"None"
Une liste de champs DmEvent, séparés par des virgules, à afficher.
​
path.expansions
List or None
défaut:"None"
Une liste de champs, séparés par des virgules, à étendre.
​
path.media_fields
List or None
défaut:"None"
Une liste de champs Media, séparés par des virgules, à afficher.
​
path.user_fields
List or None
défaut:"None"
Une liste de champs User, séparés par des virgules, à afficher.
​
path.tweet_fields
List or None
défaut:"None"
Une liste de champs Tweet, séparés par des virgules, à afficher.

​
Renvoie

IteratorGetEventsResponse

​
get_events_by_conversation_id

Obtenir les événements de messages privés pour une conversation donnée Récupère les événements de messages privés pour une conversation spécifique.

​
Paramètres

​
path.id
Any
L’ID de la conversation de MD.
​
path.max_results
int or None
défaut:"None"
Le nombre maximal de résultats.
​
path.pagination_token
Any or None
défaut:"None"
Ce paramètre permet d’obtenir une « page » spécifique de résultats.
​
path.event_types
List or None
défaut:"None"
L’ensemble des event_types à inclure dans les résultats.
​
path.dm_event_fields
List or None
défaut:"None"
Une liste de champs DmEvent, séparés par des virgules, à afficher.
​
path.expansions
List or None
défaut:"None"
Une liste de champs, séparés par des virgules, à développer.
​
path.media_fields
List or None
défaut:"None"
Une liste de champs Media, séparés par des virgules, à afficher.
​
path.user_fields
List or None
défaut:"None"
Une liste de champs User, séparés par des virgules, à afficher.
​
path.tweet_fields
List or None
défaut:"None"
Une liste de champs Tweet, séparés par des virgules, à afficher.

​
Renvoie

IteratorGetEventsByConversationIdResponse

​
get_events_by_id

Obtenir un événement de message privé par id Récupère les détails d’un événement de message privé spécifique par son id.

​
Paramètres

​
path.event_id
Any
id d’événement de DM.
​
path.dm_event_fields
List or None
défaut:"None"
Une liste de champs DmEvent séparés par des virgules à afficher.
​
path.expansions
List or None
défaut:"None"
Une liste de champs séparés par des virgules à étendre.
​
path.media_fields
List or None
défaut:"None"
Une liste de champs Media séparés par des virgules à afficher.
​
path.user_fields
List or None
défaut:"None"
Une liste de champs User séparés par des virgules à afficher.
​
path.tweet_fields
List or None
défaut:"None"
Une liste de champs Tweet séparés par des virgules à afficher.

​
Valeur de retour

GetEventsByIdResponse - Données de réponse

​
get_events_by_participant_id

Récupérer les événements de messages directs (DM) pour une conversation Récupère les événements de messages directs pour une conversation spécifique.

​
Paramètres

​
path.participant_id
Any
L’ID de l’utilisateur participant pour la conversation de DM en tête-à-tête.
​
path.max_results
int or None
défaut:"None"
Le nombre maximal de résultats.
​
path.pagination_token
Any or None
défaut:"None"
Ce paramètre est utilisé pour obtenir une « page » spécifique de résultats.
​
path.event_types
List or None
défaut:"None"
L’ensemble des event_types à inclure dans les résultats.
​
path.dm_event_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs DmEvent à afficher.
​
path.expansions
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs à développer.
​
path.media_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs Media à afficher.
​
path.user_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs User à afficher.
​
path.tweet_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs Tweet à afficher.

​
Renvoie

IteratorGetEventsByParticipantIdResponse