List

Lists all of the direct messages the calling user has joined. It supports the Offset, Count, and Sort Query Parameters.

URL

Requires Auth

HTTP Method

/api/v1/im.list

yes

GET

Example Call

curl -H "X-Auth-Token: 8h2mKAwxB3AQrFSjLVKMooJyjdCFaA7W45sWlHP8IzO" \
-H "X-User-Id: ew28FnZqipDpvKw3R" \
http://localhost:3000/api/v1/im.list

Example Result

{
"ims": [
{
"_id":"ew28FnZqipDpvKw3Rrocket.cat",
"_updatedAt":"2018-02-23T17:58:56.147Z",
"t":"d",
"msgs":22,
"ts":"2018-02-18T19:51:52.557Z",
"lm":"2018-02-23T17:58:56.136Z",
"topic":"a direct message with rocket.cat"
},
{
"_id":"RtycPC29hqLJfT9xjew28FnZqipDpvKw3R",
"_updatedAt":"2018-02-23T18:14:03.510Z",
"t":"d",
"msgs":2,
"ts":"2018-02-21T21:08:51.026Z",
"lm":"2018-02-23T18:14:03.490Z",
"username":"rocketchat.internal.admin.test"
},
{
"_id":"ew28FnZqipDpvKw3Rf2CAhYGtjS9iNZ7nd",
"_updatedAt":"2018-02-23T17:45:56.496Z",
"t":"d",
"msgs":1,
"ts":"2018-02-23T17:32:28.016Z",
"lm":"2018-02-23T17:45:56.475Z"
}
],
"offset":0,
"count":3,
"total":3,
"success":true
}

Change Log

Version

Description

0.67.0

Remove 'query' parameter support.

0.62.0

Add 'query' parameter support.

0.49.0

Count and offset query parameters supported.

0.48.0

Added