Skip to content

Latest commit

 

History

History
56 lines (46 loc) · 1.44 KB

info.md

File metadata and controls

56 lines (46 loc) · 1.44 KB
Raw

Group Info

Retrieves the information about the private group, only if you're part of the group.

URL Requires Auth HTTP Method
/api/v1/groups.info yes GET

Query Parameters

Argument Example Required Description
roomId ByehQjC44FwMeiLbX Required (if no roomName) The private group's id
roomName Exclusive.Chat Required (if no roomId) The private group's name

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     http://localhost:3000/api/v1/groups.info?roomId=ByehQjC44FwMeiLbX

Example Result

{
  "group": {
    "_id": "ByehQjC44FwMeiLbX",
    "name": "testing",
    "fname": "testing",
    "t": "p",
    "msgs": 0,
    "usersCount": 2,
    "u": {
      "_id": "HKKPmF8rZh45GMHWH",
      "username": "marcos.defendi"
    },
    "customFields": {},
    "broadcast": false,
    "encrypted": false,
    "ts": "2020-05-21T13:16:24.749Z",
    "ro": false,
    "default": false,
    "sysMes": true,
    "_updatedAt": "2020-05-21T13:16:24.772Z"
  },
  "success": true
}

Change Log

Version Description
0.48.0 Added