Get sessions in a Group
GET sessions via groupId
Retrieve a list of sessions within a Group by id
Parameter
Accessible via URL https://api.channel.io/open/v5/groups/{groupId}/sessions
and HTTP GET
This method accepts
application/json
Parameter | Example | Required | Description | Parameter type |
---|---|---|---|---|
groupId | 1234 | Required | Id of Group | Path |
Example
GET https://api.channel.io/open/v5/group/1234/sessions
GET sessions via groupName
Retrieve a list of sessions within a Group by name.
Parameter
Accessible via URL https://api.channel.io/open/v5/groups/@{groupName}/sessions
and HTTP GET
This method accepts
application/json
Parameter | Example | Required | Description | Parameter type |
---|---|---|---|---|
groupName | justgroup | Required | Name of Group | Path |
Example
GET https://api.channel.io/open/v5/group/@justgroup/sessions
Response
Response
Returns sessions along with related information.
{
"sessions": [
{
"key": "string",
"chatId": "string",
"chatKey": "string",
"updatedKey": "string",
"unreadKey": "string",
"channelId": "string",
"alert": 0,
"unread": 0,
"watch": "all",
"allMentionImportant": true,
"readAt": 1656032152418,
"receivedAt": 1656032152418,
"postedAt": 1656032152418,
"updatedAt": 1656032152427,
"createdAt": 1656032152427,
"version": 0,
"id": "string",
"personType": "string",
"personId": "string",
"chatType": "string"
}
]
}
Updated about 1 year ago