GET direct_messages/welcome_messages/rules/list

Returns a list of Welcome Message Rules.

Resource URL

https://api.twitter.com/1.1/direct_messages/welcome_messages/rules/list.json

Resource Information

Response formats JSON
Requires authentication? Yes (user context only)
Rate limited? Yes
Requests / 15-min window (user auth) 15

Parameters

count (optional) Number of welcome message rules to be returned. Max of 50. Default is 20.
cursor (optional) For paging through result sets greater than 1 page, use the “next_cursor” property from the previous request.

Example request using Twurl

twurl -X GET "/1.1/direct_messages/welcome_messages/rules/list.json?count=2&cursor=MTIzNDU2Nzg"

Example Responses

Welcome message rules are returned in the welcome_message_rules array. A next_cursor property will be returned if there are more welcome message rules to be retrieved.

Note

To determine if there are more welcome message rules to retrieve, always look for the presence of a next_cursor. In rare cases the welcome_message_rules array may be empty.

{
  "welcome_message_rules": [
    {
      "id": "9910934913490319",
      "created_timestamp": "1470182394258",
      "welcome_message_id": "844385345234"
    },
    {
      "id": "9910934913490431",
      "created_timestamp": "1470182394265",
      "welcome_message_id": "844385345238"
    }
  ],
  "next_cursor": "NDUzNDUzNDY3Nzc3"
}

Was this document helpful?

Thank you for the feedback. We’re really glad we could help!

Thank you for the feedback. How could we improve this document?

Thank you for the feedback. Your comments will help us improve our documents in the future.