getDirectMessageEvents
Retrieve detailed direct message events from Twitter, including message content, sender info, and attachments. Customize results with specific fields, expansions, and pagination for efficient data handling.
Instructions
Get specific direct message events with detailed information
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dmEventFields | No | Fields to include in the DM event objects | |
| expansions | No | Additional fields to expand in the response | |
| maxResults | No | Maximum number of results to return (default: 100, max: 100) | |
| paginationToken | No | Pagination token for retrieving next page of results | |
| userFields | No | User fields to include when expanding sender information |
Input Schema (JSON Schema)
{
"properties": {
"dmEventFields": {
"description": "Fields to include in the DM event objects",
"items": {
"enum": [
"id",
"text",
"created_at",
"sender_id",
"dm_conversation_id",
"referenced_tweet",
"attachments"
],
"type": "string"
},
"type": "array"
},
"expansions": {
"description": "Additional fields to expand in the response",
"items": {
"enum": [
"sender_id",
"referenced_tweet.id",
"attachments.media_keys"
],
"type": "string"
},
"type": "array"
},
"maxResults": {
"description": "Maximum number of results to return (default: 100, max: 100)",
"maximum": 100,
"minimum": 1,
"type": "number"
},
"paginationToken": {
"description": "Pagination token for retrieving next page of results",
"type": "string"
},
"userFields": {
"description": "User fields to include when expanding sender information",
"items": {
"enum": [
"username",
"name",
"profile_image_url",
"verified"
],
"type": "string"
},
"type": "array"
}
},
"required": [],
"type": "object"
}