Category
Group
Group
Get a single Group
GET via groupId Get a single Group object by id Parameter Accessible via URL https://api.channel.io/open/v5/groups/{groupId} and HTTP GET This method accepts application/json Parameter Example Required Description Parameter Type groupId 1234 Required Id of Group object Path Example GET https://api.channel.io/open/v5/group/1234 Get via groupName Get a single Group object by name Parameter Accessible via URL https://api.channel.io/open/v5/group/@{groupName} and HTTP GET Example GET https://api.cha
List of Groups
Retrieve a list of Groups Parameter Accessible via URL https://api.channel.io/open/v5/groups and HTTP GET This method accepts application/json Parameter Example Required Description Parameter type since 123124122 Optional Name of the first group to be retrieved in ascending order Query limit 25 Optional Restrict the maximum number of results - min : 1 - max : 500 - default : 25 Query Example GET https://api.channel.io/open/v5/groups Response Returns a list of Group objects. { "next": "string", "
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/ope
Get messages in a Group
GET messages via groupId Retrieve a list of messages in a Group by groupId Parameter Accessible via URL https://api.channel.io/open/v5/groups/{groupId}/messages and HTTP GET This method accepts application/json Parameter Example Required Description Parameter Type groupId 1234 Required Id of Group Path since 1401231818 Optional Unix timestamp value of the first message to be retrieved Query limit 25 Optional Restrict the maximum number of results - min : 1 - max : 500 - default : 25 Query sortOr
Send a message to a Group
POST message via groupId Send a message to a Group by groupId Parameter Accessible via URL https://api.channel.io/open/v5/groups/{groupId}/messages and HTTP POST The POST request body should be a Message object. This method accepts application/json Parameter Example Required Description Parameter type groupId 1234 Required Id of Group Path botName channelBot Optional Name of the Bot that sends the message Query Example POST https://api.channel.io/open/v5/groups/1234/messages?botName=channelBot P
Get a file url in a Group
Get a signed file url via groupId Get a signed file url that expires after 15 minutes Parameter Accessible via URL https://api.channel.io/open/v5/groups/{groupId}/messages/file and HTTP GET This method does currently accept application/json only. Parameter Example Required Description Parameter Type groupId 1234 Required Id of Group Path key pub-file/12345/0a1b2c3d4e5f6g7h8i9j/example.txt Required Key of File Query Example GET https://api.channel.io/open/v5/groups/1234/messages/file?key=pub-file
Update a Group
Update via groupId Update a Group object by id Parameter Accessible via URL https://api.channel.io/open/v5/group/{groupId} and HTTP PATCH This method accepts application/json Parameter Example Required Description Parameter Type groupId 1234 Required Id of Group object Path botName channelBot Optional Name of the Bot that sends the message Query Example PATCH https://api.channel.io/open/v5/group/1234?botName=channelBot Update via groupName Update a Group object by name Parameter Accessible via U