R: Get direct messages sent to and received by the...

direct_messages {rtweet} | R Documentation

## Get direct messages sent to and received by the authenticating user from the past 30 days

### Description

Returns all Direct Message events (both sent and received) within the last 30 days. Sorted in reverse-chronological order.

### Usage

    direct_messages(n = 50, next_cursor = NULL, parse = TRUE, token = NULL)

    direct_messages_sent(
      since_id = NULL,
      max_id = NULL,
      n = 200,
      parse = TRUE,
      token = NULL
    )

### Arguments

`n` | optional Specifies the number of direct messages to try and retrieve, up to a maximum of 50.
`next_cursor` | If there are more than 200 DMs in the last 30 days, responses will include a next_cursor value, which can be supplied in additional requests to scroll through pages of results.
`parse` | Logical indicating whether to convert response object into nested list. Defaults to true.
`token` | Every user should have their own Oauth (Twitter API) token. By default `token = NULL` this function looks for the path to a saved Twitter token via environment variables (which is what 'create_token()' sets up by default during initial token creation). For instruction on how to create a Twitter token see the tokens vignette, i.e., 'vignettes("auth", "rtweet")' or see `?tokens`.
`since_id` | optional Returns results with an ID greater than (that is, more recent than) the specified ID. There are limits to the number of Tweets which can be accessed through the API. If the limit of Tweets has occurred since the since_id, the since_id will be forced to the oldest ID available.
`max_id` | Character, returns results with an ID less than (that is, older than) or equal to 'max_id'.

### Details

Includes detailed information about the sender and recipient user. You can request up to 50 direct messages per call, and only direct messages from the last 30 days will be available using this endpoint.

Important: This method requires an access token with read, write, and direct message permissions. If you own the Twitter application, you can change permissions through Twitter's developer portal. Once you have made changes to the application permission settings, you will need to regenerate your token before those effect of those changes can take effect.

### Value

Return parsed or non-parsed response object.

### Examples

    ## Not run:

    ## get my direct messages
    dms <- direct_messages()

    ## inspect data structure
    str(dms)

    ## End(Not run)

[Package rtweet version 0.7.0 Index]