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/v4/groups/{groupId}/messages and HTTP GET
Example
GET https://api.channel.io/open/v4/groups/1234/messages?since=1401231818&limit=25&sortOrder=asc
This method accepts
application/json
| Parameter | Example | Required | Description | Parameter Type |
|---|---|---|---|---|
| groupId | 1234 | Required | Id of Group | Path |
| since | 1401231818 | Optional | Epoch time in microseconds of the first message to be retrieved | Query |
| limit | 25 | Optional | Restrict the maximum number of results - min : 1 - max : 500 - default : 25 | Query |
| sortOrder | desc | Required | Order of messages (descending order means latest message first) - Available values : asc, desc, both - Default value : desc | Query |
GET messages via groupName
Retrieve a list of messages in a Group by groupName
Parameter
Accessible via URL https://api.channel.io/open/v4/groups/@{groupName}/messages and HTTP GET
Example
GET https://api.channel.io/open/v3/groups/@justGroup/messages?since=1401231818&limit=25&sortOrder=asc
This method accepts
application/json
| Parameter | Example | Required | Description | Parameter Type |
|---|---|---|---|---|
| groupName | justGroup | Required | Name of Group | Path |
| since | 1401231818 | Optional | Epoch time in microseconds of the first message to be retrieved | Query |
| limit | 25 | Optional | Restrict the maximum number of results (range[1, 500]) Default value : 25 | Query |
| sortOrder | desc | Required | Order of messages (descending order means latest message first) Available values : asc, desc, both Default value : desc | Query |
Response
Response
Returns messages within a group along with related information.
{
"prev": "string",
"next": "string",
"messages": [
{
"chatKey": "string",
"id": "string",
"mainKey": "string",
"threadKey": "string",
"root": true,
"channelId": "string",
"chatType": "string",
"chatId": "string",
"personType": "string",
"personId": "string",
"requestId": "string",
"language": "string",
"createdAt": 1624422361866,
"version": 0,
"blocks": [
{
"type": "bullets",
"language": "string",
"value": "string",
"blocks": [
null
]
}
],
"plainText": "string",
"updatedAt": 1624422361868,
"buttons": [
{
"title": "string",
"colorVariant": "cobalt",
"url": "string"
}
],
"files": [
{
"id": "string",
"type": "string",
"name": "string",
"size": 0,
"contentType": "string",
"duration": 0,
"width": 0,
"height": 0,
"orientation": 0,
"animated": true,
"bucket": "string",
"key": "string",
"previewKey": "string",
"channelId": "string",
"chatId": "string",
"chatType": "string"
}
],
"webPage": {
"id": "string",
"url": "string",
"title": "string",
"description": "string",
"imageUrl": "string",
"videoUrl": "string",
"publisher": "string",
"author": "string",
"width": 0,
"height": 0,
"bucket": "string",
"previewKey": "string",
"logo": "string",
"name": "string"
},
"log": {
"action": "changeName",
"values": [
"string"
],
"triggerType": "string",
"triggerId": "string"
},
"reactions": [
{
"emojiName": "string",
"personKeys": [
"string"
]
}
],
"profileBot": [
{
"id": "string",
"key": "string",
"type": "string",
"name": "string",
"value": {
"s": "string",
"n": "string",
"b": {
"short": 0,
"char": "string",
"int": 0,
"long": 0,
"float": 0,
"double": 0,
"direct": true,
"readOnly": true
},
"m": {},
"l": [
null
],
"ss": [
"string"
],
"ns": [
"string"
],
"bs": [
{
"short": 0,
"char": "string",
"int": 0,
"long": 0,
"float": 0,
"double": 0,
"direct": true,
"readOnly": true
}
],
"null": true,
"bool": true
}
}
],
"state": "sending",
"options": [
"actAsManager"
],
"marketing": {
"type": "string",
"id": "string",
"advertising": true,
"exposureType": "fullScreen"
},
"supportBot": {
"id": "string",
"revisionId": "string",
"sectionId": "string",
"stepIndex": 0,
"buttons": [
{
"text": "string",
"nextSectionId": "string"
}
],
"submitButtonIndex": 0
},
"threadMsg": true,
"broadcastedMsg": true,
"rootMessageId": "string"
}
],
"bots": [
{
"id": "string",
"channelId": "string",
"name": "string",
"createdAt": 1624422361892,
"avatar": {
"bucket": "string",
"key": "string",
"width": 0,
"height": 0
},
"color": "string",
"avatarUrl": "string"
}
],
"users": [
{
"id": "string",
"channelId": "string",
"memberId": "string",
"veilId": "string",
"unifiedId": "string",
"name": "string",
"profile": {
"name": "string",
"empty": true,
"email": "string",
"avatarUrl": "string",
"mobileNumber": "string",
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"profileOnce": {
"name": "string",
"empty": true,
"email": "string",
"avatarUrl": "string",
"mobileNumber": "string",
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"tags": [
"string"
],
"alert": 0,
"unread": 0,
"popUpChatId": "string",
"blocked": true,
"unsubscribed": true,
"hasChat": true,
"hasPushToken": true,
"language": "string",
"country": "string",
"city": "string",
"latitude": 0,
"longitude": 0,
"web": {
"device": "string",
"os": "string",
"osName": "string",
"browser": "string",
"browserName": "string",
"sessionsCount": 0,
"lastSeenAt": 1624422372181
},
"mobile": {
"device": "string",
"os": "string",
"osName": "string",
"appName": "string",
"appVersion": "string",
"sessionsCount": 0,
"lastSeenAt": 1624422372181
},
"sessionsCount": 0,
"lastSeenAt": 1624422361664,
"createdAt": 1624422361767,
"updatedAt": 1624422361664,
"version": 0,
"managedKey": 0,
"member": true,
"email": "string",
"avatarUrl": "string",
"mobileNumber": "string",
"systemLanguage": "string"
}
],
"supportBots": [
{
"id": "string",
"channelId": "string",
"pluginId": "string",
"botName": "string",
"name": "string",
"order": 0,
"pageQuery": {
"key": "string",
"type": "boolean",
"operator": {},
"values": [
{}
],
"and": [
null
],
"or": [
null
]
},
"userQuery": {
"key": "string",
"type": "boolean",
"operator": {},
"values": [
{}
],
"and": [
null
],
"or": [
null
]
},
"draft": {
"supportBot": {},
"sections": [
{
"name": "string",
"actions": [
{
"type": "string"
}
],
"id": "string",
"steps": [
{
"message": {
"blocks": [
{
"type": "bullets",
"language": "string",
"value": "string",
"blocks": [
null
]
}
],
"buttons": [
{
"title": "string",
"colorVariant": "cobalt",
"url": "string"
}
],
"files": [
{
"id": "string",
"type": "string",
"name": "string",
"size": 0,
"contentType": "string",
"duration": 0,
"width": 0,
"height": 0,
"orientation": 0,
"animated": true,
"bucket": "string",
"key": "string",
"previewKey": "string",
"channelId": "string",
"chatId": "string",
"chatType": "string"
}
],
"webPage": {
"id": "string",
"url": "string",
"title": "string",
"description": "string",
"imageUrl": "string",
"videoUrl": "string",
"publisher": "string",
"author": "string",
"width": 0,
"height": 0,
"bucket": "string",
"previewKey": "string",
"logo": "string",
"name": "string"
}
}
}
],
"type": "string"
}
]
},
"revisionId": "string",
"state": "draft",
"runMode": "always",
"start": 0,
"stop": 0,
"chatOpen": 0,
"createdAt": 1624422361689,
"updatedAt": 1624422361689,
"userChatExpireDuration": {
"seconds": 0,
"nano": 0,
"units": [
{
"dateBased": true,
"timeBased": true,
"duration": {
"seconds": 0,
"nano": 0,
"zero": true,
"negative": true
},
"durationEstimated": true
}
],
"zero": true,
"negative": true
}
}
],
"automationRules": [
{
"id": "string",
"channelId": "string",
"name": "string",
"run": true,
"rank": 0,
"executionCount": 0,
"triggers": [
{
"type": "string"
}
],
"filter": {
"key": "string",
"type": "boolean",
"operator": {},
"values": [
{}
],
"and": [
null
],
"or": [
null
]
},
"staticActions": [
{
"type": "string"
}
],
"stateAction": {
"type": "string"
},
"createdAt": 1624422361857,
"updatedAt": 1624422361689
}
]
}
Implementation Notes
The number of messages retrieved in this endpoint is restricted by the limit query parameter, and is capped to values in the closed interval [1, 500].
Pagination is supported through the since query parameter along with the next value contained in the root object of the JSON response. Successive queries to this endpoint using the previous next value as the since parameter will ultimately retrieve all messages in the chat.
If the since parameter is left empty, the list retrieved will start with the first message (as specified by the order parameter).
Updated about 1 year ago