GetDirectMessages

Created by Aparna Tayi
Last updated: Jan 27, 2020 by Chandna Mitra
min read

On this page

Snap type:

Read


Description:

This Snap retrieves the direct messages of the authenticated twitter user.

  • Expected upstream Snaps: No upstream Snap is expected.
  • Expected downstream Snaps: Any file Formatter followed by File Writer.
  • Expected input: No input is required.
  • Expected output: Provides the direct messages data for the authenticated user.


Prerequisites:

[None]


Support and limitations:Works in Ultra Task Pipelines.
Account: 

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Configuring Twitter Accounts for information on setting up this type of account.


Views:
InputThis Snap has at most one document input view.
OutputThis Snap has exactly one document output view.
ErrorThis Snap has at most one document error view and produces zero or more documents in the view.

Settings

Label


Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Direct message ID


The ID of the direct message.
This field is required only if the Direct message type is Direct message by message ID.


Direct message typeRequired. The read types of Direct messages. The options available include:
  • Direct message by message ID — gets a direct message by its message ID that belongs to the authenticated twitter user.
  • All of my direct messages received — gets all of the direct messages that are received by the authenticated twitter user.
  • All of my direct messages sent — gets all of the direct messages that are sent by the authenticated twitter user.

Snap Execution

Select one of the three modes in which the Snap executes. Available options are:

  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.
  • Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.

  • Disabled: Disables the Snap and all Snaps that are downstream from it.


Example

The example assumes that you have configured & authorized a valid Twitter account (see Configuring Twitter Accounts) to be used with this Snap. The following GetDirectMessages Snap is set to retrieve direct messages from a message thread with a message ID, 240136858829479936:

 

Similarly, you can retrieve direct messages that you received in or sent to a message thread on Twitter by specifying Direct message type as All of my direct messages received or All of my direct messages sent respectively.   

After successful validation of the Snap, you will see a data preview that lists all the direct messages in the authenticated Twitter account as shown below:

Snap Pack History

 Click to view/expand
ReleaseSnap Pack VersionDateTypeUpdates
4.27main12883 StableUpgraded with the latest SnapLogic Platform release.
4.26main11181 StableUpgraded with the latest SnapLogic Platform release.
4.25main9554 StableUpgraded with the latest SnapLogic Platform release.
4.24424patches8617 Latest

Fixes the error handling issue in the PostTweet Snap, where data and error are now routed to the error view.

4.24main8556
 
Stable

Upgraded with the latest SnapLogic Platform release.

4.23main7430
 
StableUpgraded with the latest SnapLogic Platform release.
4.22main6403
 
StableUpgraded with the latest SnapLogic Platform release.
4.21snapsmrc542
 
StableUpgraded with the latest SnapLogic Platform release.
4.20snapsmrc535
 
StableUpgraded with the latest SnapLogic Platform release.
4.19snapsmrc8338 Latest

Fixed the broken doc link for the PostDirectMessage Snap.

4.19snaprsmrc528
 
StableUpgraded with the latest SnapLogic Platform release.
4.18snapsmrc523
 
StableUpgraded with the latest SnapLogic Platform release.
4.17ALL7402
 
Latest

Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.

4.17snapsmrc515
 
Stable

Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview check box.

4.16snapsmrc508
 
StableUpgraded with the latest SnapLogic Platform release.
4.15snapsmrc500
 
StableUpgraded with the latest SnapLogic Platform release.
4.14snapsmrc490
 
StableUpgraded with the latest SnapLogic Platform release.
4.13

snapsmrc486

 
Stable

Upgraded with the latest SnapLogic Platform release.

4.12

snapsmrc480

 
StableUpgraded with the latest SnapLogic Platform release.
4.11snapsmrc465
 
StableUpgraded with the latest SnapLogic Platform release.
4.10

snapsmrc414

 
StableUpgraded with the latest SnapLogic Platform release.
4.9

snapsmrc405

 
Stable

Upgraded with the latest SnapLogic Platform release.

4.8

snapsmrc398

 
StableUpgraded with the latest SnapLogic Platform release.
4.7

snapsmrc382

 
StableUpgraded with the latest SnapLogic Platform release.
4.6

rcmsf233

 
StableUpgraded with the latest SnapLogic Platform release.
4.5.1

twitter1579

 
StableUpdated the Twitter Streaming Search Snap with a timeout of 10 seconds for preview if the original value provided is zero or more than 30 seconds. For more information, see Twitter Streaming Search.
4.5rcmsf231 StableDoc Enhancement: Examples added to Twitter Snap documentation.
4.2.2NA

Updated messages within the Snap Pack.
July/Summer 2014NA

Twitter Query enhanced to support until, since_id, and max_id.
June 30, 2014NA

  • NEW! Twitter Streaming Search Snap. This Snap streams tweets based on a keyword.
  • Addressed the following issues:
    • Twitter Lookup Snap errors out if an expression was used for the screen-name or user-id
    • Twitter Query null pointer exception
March 2014NA

The Twitter Snap Pack was expanded with the addition of Get Direct Messages, Get Tweets, Lookup, Post Direct Message, and Post Tweet.
January 2014NA

Twitter Query updated.

June 2013NA

Introduced in this release.