Skip to main content

​
Submodules

​
Module contents

This module provides access to the direct messages endpoints of the X API and serves as the main entry point for all direct messages-related functionality.

​
class xdk.direct_messages.DirectMessagesClient

Client for direct messages operations

​
Parameters

​
path.client
Client

​
__init__

​
Parameters

​
path.client
Client

​
create_by_conversation_id

Create DM message by conversation ID Sends a new direct message to a specific conversation by its ID.

​
Parameters

​
path.dm_conversation_id
str
The DM Conversation ID.
​
body.body
CreateByConversationIdRequest
Request body

​
create_by_participant_id

Create DM message by participant ID Sends a new direct message to a specific participant by their ID.

​
Parameters

​
path.participant_id
Any
The ID of the recipient user that will receive the DM.
​
body.body
CreateByParticipantIdRequest
Request body

​
create_conversation

Create DM conversation Initiates a new direct message conversation with specified participants. body: Request body :returns: Response data :rtype: CreateConversationResponse

​
Parameters

​
body.body
CreateConversationRequest

​
delete_events

Delete DM event Deletes a specific direct message event by its ID, if owned by the authenticated user.

​
Parameters

​
path.event_id
Any
The ID of the direct-message event to delete.

​
Returns

DeleteEventsResponse - Response data

​
get_events

Get DM events Retrieves a list of recent direct message events across all conversations.

​
Parameters

​
path.max_results
int or None
default:"None"
The maximum number of results.
​
path.pagination_token
Any or None
default:"None"
This parameter is used to get a specified ‘page’ of results.
​
path.event_types
List or None
default:"None"
The set of event_types to include in the results.
​
path.dm_event_fields
List or None
default:"None"
A comma separated list of DmEvent fields to display.
​
path.expansions
List or None
default:"None"
A comma separated list of fields to expand.
​
path.media_fields
List or None
default:"None"
A comma separated list of Media fields to display.
​
path.user_fields
List or None
default:"None"
A comma separated list of User fields to display.
​
path.tweet_fields
List or None
default:"None"
A comma separated list of Tweet fields to display.

​
Returns

GetEventsResponse - Response data

​
get_events_by_conversation_id

Get DM events for a DM conversation Retrieves direct message events for a specific conversation.

​
Parameters

​
path.id
Any
The DM conversation ID.
​
path.max_results
int or None
default:"None"
The maximum number of results.
​
path.pagination_token
Any or None
default:"None"
This parameter is used to get a specified ‘page’ of results.
​
path.event_types
List or None
default:"None"
The set of event_types to include in the results.
​
path.dm_event_fields
List or None
default:"None"
A comma separated list of DmEvent fields to display.
​
path.expansions
List or None
default:"None"
A comma separated list of fields to expand.
​
path.media_fields
List or None
default:"None"
A comma separated list of Media fields to display.
​
path.user_fields
List or None
default:"None"
A comma separated list of User fields to display.
​
path.tweet_fields
List or None
default:"None"
A comma separated list of Tweet fields to display.

​
Returns

GetEventsByConversationIdResponse - Response data

​
get_events_by_id

Get DM event by ID Retrieves details of a specific direct message event by its ID.

​
Parameters

​
path.event_id
Any
dm event id.
​
path.dm_event_fields
List or None
default:"None"
A comma separated list of DmEvent fields to display.
​
path.expansions
List or None
default:"None"
A comma separated list of fields to expand.
​
path.media_fields
List or None
default:"None"
A comma separated list of Media fields to display.
​
path.user_fields
List or None
default:"None"
A comma separated list of User fields to display.
​
path.tweet_fields
List or None
default:"None"
A comma separated list of Tweet fields to display.

​
Returns

GetEventsByIdResponse - Response data

​
get_events_by_participant_id

Get DM events for a DM conversation Retrieves direct message events for a specific conversation.

​
Parameters

​
path.participant_id
Any
The ID of the participant user for the One to One DM conversation.
​
path.max_results
int or None
default:"None"
The maximum number of results.
​
path.pagination_token
Any or None
default:"None"
This parameter is used to get a specified ‘page’ of results.
​
path.event_types
List or None
default:"None"
The set of event_types to include in the results.
​
path.dm_event_fields
List or None
default:"None"
A comma separated list of DmEvent fields to display.
​
path.expansions
List or None
default:"None"
A comma separated list of fields to expand.
​
path.media_fields
List or None
default:"None"
A comma separated list of Media fields to display.
​
path.user_fields
List or None
default:"None"
A comma separated list of User fields to display.
​
path.tweet_fields
List or None
default:"None"
A comma separated list of Tweet fields to display.

​
Returns

GetEventsByParticipantIdResponse - Response data