Saltar al contenido principal

​
Submódulos

​
Contenido del módulo

Este módulo proporciona acceso a los endpoints de mensajes directos de X API y sirve como punto de entrada principal para toda la funcionalidad relacionada con los mensajes directos.

​
class xdk.direct_messages.DirectMessagesClient

Cliente para operaciones de mensajes directos

​
Parámetros

​
path.client
Client

​
__init__

​
Parámetros

​
path.client
Client

​
create_by_conversation_id

Crear mensaje directo por id de conversación Envía un nuevo mensaje directo a una conversación específica identificada por su id.

​
Parámetros

​
path.dm_conversation_id
str
El id de la conversación de MD.
​
body.body
CreateByConversationIdRequest
Cuerpo de la solicitud

​
create_by_participant_id

Crear mensaje directo por id de participante Envía un nuevo mensaje directo a un participante específico mediante su id.

​
Parámetros

​
path.participant_id
Any
El id del usuario destinatario que recibirá el mensaje directo (DM).
​
body.body
CreateByParticipantIdRequest
Cuerpo de la solicitud

​
create_conversation

Crear una conversación de mensajes directos Inicia una nueva conversación de mensajes directos con los participantes especificados. body: Cuerpo de la solicitud :returns: Datos de la respuesta :rtype: CreateConversationResponse

​
Parámetros

​
body.body
CreateConversationRequest

​
delete_events

Eliminar evento de MD Elimina un evento de mensaje directo específico por su id, siempre que pertenezca al usuario autenticado.

​
Parámetros

​
path.event_id
Any
El ID del evento de mensaje directo que se debe eliminar.

​
Devuelve

DeleteEventsResponse - Datos de la respuesta

​
get_events

Obtener eventos de MD Devuelve una lista de eventos recientes de mensajes directos (MD) de todas las conversaciones.

​
Parámetros

​
path.max_results
int or None
predeterminado:"None"
El número máximo de resultados.
​
path.pagination_token
Any or None
predeterminado:"None"
Este parámetro se usa para obtener una página específica de resultados.
​
path.event_types
List or None
predeterminado:"None"
El conjunto de event_types que se incluirán en los resultados.
​
path.dm_event_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos DmEvent que se mostrarán.
​
path.expansions
List or None
predeterminado:"None"
Una lista separada por comas de campos que se expandirán.
​
path.media_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos Media que se mostrarán.
​
path.user_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos User que se mostrarán.
​
path.tweet_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos Tweet que se mostrarán.

​
Devuelve

IteratorGetEventsResponse

​
get_events_by_conversation_id

Obtener eventos de mensajes directos para una conversación de mensajes directos Obtiene eventos de mensajes directos para una conversación específica.

​
Parámetros

​
path.id
Any
El ID de la conversación de DM.
​
path.max_results
int or None
predeterminado:"None"
El número máximo de resultados.
​
path.pagination_token
Any or None
predeterminado:"None"
Este parámetro se usa para obtener una “página” específica de resultados.
​
path.event_types
List or None
predeterminado:"None"
El conjunto de event_types que se incluirán en los resultados.
​
path.dm_event_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de DmEvent para mostrar.
​
path.expansions
List or None
predeterminado:"None"
Una lista separada por comas de campos para expandir.
​
path.media_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Media para mostrar.
​
path.user_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de User para mostrar.
​
path.tweet_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Tweet para mostrar.

​
Devuelve

IteratorGetEventsByConversationIdResponse

​
get_events_by_id

Obtener evento de mensaje directo por id Obtiene los detalles de un evento de mensaje directo específico por su identificador (id).

​
Parámetros

​
path.event_id
Any
id del evento de MD.
​
path.dm_event_fields
List or None
predeterminado:"None"
Una lista de campos DmEvent separados por comas para mostrar.
​
path.expansions
List or None
predeterminado:"None"
Una lista de campos separados por comas para expandir.
​
path.media_fields
List or None
predeterminado:"None"
Una lista de campos Media separados por comas para mostrar.
​
path.user_fields
List or None
predeterminado:"None"
Una lista de campos User separados por comas para mostrar.
​
path.tweet_fields
List or None
predeterminado:"None"
Una lista de campos Tweet separados por comas para mostrar.

​
Devuelve

GetEventsByIdResponse - Datos de la respuesta

​
get_events_by_participant_id

Obtén eventos de mensajes directos para una conversación de MD Recupera eventos de mensajes directos para una conversación de MD específica.

​
Parámetros

​
path.participant_id
Any
El ID del usuario participante para la conversación de DM uno a uno.
​
path.max_results
int or None
predeterminado:"None"
El número máximo de resultados.
​
path.pagination_token
Any or None
predeterminado:"None"
Este parámetro se usa para obtener una página específica de resultados.
​
path.event_types
List or None
predeterminado:"None"
El conjunto de event_types que se incluirán en los resultados.
​
path.dm_event_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos DmEvent para mostrar.
​
path.expansions
List or None
predeterminado:"None"
Una lista separada por comas de campos para expandir.
​
path.media_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos Media para mostrar.
​
path.user_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos User para mostrar.
​
path.tweet_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos Tweet para mostrar.

​
Devuelve

IteratorGetEventsByParticipantIdResponse