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/v3/groups/{groupId}/sessions and HTTP GET

📘

This method accepts application/json

Parameter

Example

Required

Description

Parameter type

groupName

1234

Required

Id of Group

Path

Example

GET https://api.channel.io/open/v3/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/v3/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/v3/group/@justgroup/sessions

Response

Response

Returns sessions along with related information.

{
  "sessions": [
    {
      "id": "String",
      "channelId": "String",
      "chatType": "String",
      "chatId": "String",
      "personType": "String",
      "personId": "String",
      "createdAt": 1527207802758,
      "alert": 0,
      "unread": 0,
      "watch": "String",
      "lastReadAt": 1527207802765,
      "updatedAt": 1527207802765,
      "visible": true,
      "bookmark": false
    }
  ]
}