Get DM Events for a DM Conversation
Returns DM Events for a DM Conversation
Path parameters
Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.
The ID of the participant user for the One to One DM conversation.
Query parameters
The maximum number of results.
A base32 pagination token.
This parameter is used to get a specified 'page' of results.
The set of event_types to include in the results.
[ "MessageCreate", "ParticipantsLeave" ]
The fields available for a DmEvent object.
A comma separated list of DmEvent fields to display.
[ "attachments", "created_at", "dm_conversation_id", "event_type", "id", "participant_ids", "referenced_tweets", "sender_id", "text" ]
The list of fields you can expand for a DmEvent object. If the field has an ID, it can be expanded into a full object.
A comma separated list of fields to expand.
[ "attachments.media_keys", "participant_ids", "referenced_tweets.id", "sender_id" ]
The fields available for a Media object.
A comma separated list of Media fields to display.
[ "alt_text", "duration_ms", "height", "media_key", "non_public_metrics", "organic_metrics", "preview_image_url", "promoted_metrics", "public_metrics", "type", "url", "variants", "width" ]
The fields available for a User object.
A comma separated list of User fields to display.
[ "created_at", "description", "entities", "id", "location", "name", "pinned_tweet_id", "profile_image_url", "protected", "public_metrics", "url", "username", "verified", "verified_type", "withheld" ]
The fields available for a Tweet object.
A comma separated list of Tweet fields to display.
[ "attachments", "author_id", "context_annotations", "conversation_id", "created_at", "edit_controls", "edit_history_tweet_ids", "entities", "geo", "id", "in_reply_to_user_id", "lang", "non_public_metrics", "organic_metrics", "possibly_sensitive", "promoted_metrics", "public_metrics", "referenced_tweets", "reply_settings", "source", "text", "withheld" ]
Response
The request has succeeded.
Example response
{
"data": [
{
"dm_conversation_id": "123123123-456456456",
"event_type": "MessageCreate",
"id": "1146654567674912769",
"participant_ids": [
"2244994945"
],
"referenced_tweets": [
{
"id": "1346889436626259968"
}
],
"sender_id": "2244994945"
}
],
"includes": {
"places": [
{
"contained_within": [
"f7eb2fa2fea288b1"
],
"country": "United States",
"country_code": "US",
"full_name": "Lakewood, CO",
"geo": {
"bbox": [
-105.193475,
39.60973,
-105.053164,
39.761974
],
"geometry": {
"coordinates": [
-105.18816086351444,
40.247749999999996
],
"type": "Point"
}
},
"id": "f7eb2fa2fea288b1",
"name": "Lakewood",
"place_type": "city"
}
],
"polls": [
{
"id": "1365059861688410112"
}
],
"topics": [
{
"description": "All about technology",
"name": "Technology"
}
],
"tweets": [
{
"author_id": "2244994945",
"created_at": "Wed Jan 06 18:40:40 +0000 2021",
"id": "1346889436626259968",
"text": "Learn how to use the user Tweet timeline and user mention timeline endpoints in the Twitter API v2 to explore Tweet\\u2026 https:\\/\\/t.co\\/56a0vZUx7i"
}
],
"users": [
{
"created_at": "2013-12-14T04:35:55Z",
"id": "2244994945",
"name": "Twitter Dev",
"protected": false,
"username": "TwitterDev"
}
]
}
}