Manage Channel Members
Get Channel Members
GET https://api.talkplus.io/v1.4/api/channels/:channelId/members
Path Parameters
Name
Type
Description
channelId*
string
Query Parameters
Name
Type
Description
lastUserId
string
Last member user ID to query from (use for pagination)
limit
integer
default: 50
Headers
Name
Type
Description
app-id*
string
App ID
api-key*
string
App API key
{
"members": [
{
"id": "user123",
"username": "john",
"profileImageUrl": "http://cnd.test.com/123.jpg",
"data": {},
"memberInfo": {},
"lastReadAt": 1583924400,
"lastSentAt": 1583924400,
"updatedAt": 1583924400,
"createdAt": 1583921400
}
],
"hasNext": false
}Get Channel Member
GET https://api.talkplus.io/v1.4/api/channels/:channelId/members/:memberId
Path Parameters
Name
Type
Description
channelId*
string
memberId*
string
Headers
Name
Type
Description
app-id*
string
App ID
api-key*
string
App API key
{
"member": {
"id": "user123",
"username": "john",
"profileImageUrl": "http://cnd.test.com/123.jpg",
"data": {},
"memberInfo": {},
"lastReadAt": 1583924400,
"lastSentAt": 1583924400,
"updatedAt": 1583924400,
"createdAt": 1583921400
}
}Add Channel Members
POST https://api.talkplus.io/v1.4/api/channels/:channelId/members/add
Path Parameters
Name
Type
Description
channelId*
string
Headers
Name
Type
Description
content-type
string
application/json
app-id*
string
App ID
api-key*
string
App API key
Request Body
Name
Type
Description
members*
array
users to add
{
"channel": {
"id": "channel123",
"name": "MyFirstChannel",
"ownerId": "user123",
"type": "private",
"imageUrl": "image url",
"invitationCode": "",
"isFrozen": false,
"hideMessagesBeforeJoin": false,
"category": "",
"subcategory": "",
"privateTag": "",
"privateData": {},
"memberCount": 2,
"maxMemberCount": 100,
"data": {
"someMetaKey1": "someMetaValue1",
"someMetaKey2": "someMetaValue2"
},
"members": [
{
"id": "user123",
"username": "john",
"profileImageUrl": "http://cnd.test.com/123.jpg",
"data": {},
"memberInfo": {},
"lastReadAt": 1583924400,
"lastSentAt": 1583924400,
"updatedAt": 1583924400,
"createdAt": 1583921400
},
{
"id": "user456",
"username": "james",
"profileImageUrl": "http://cnd.test.com/456.jpg",
"data": {},
"memberInfo": {},
"lastReadAt": 1583924400,
"lastSentAt": 1583924400,
"updatedAt": 1583924400,
"createdAt": 1583921400
}
],
"mutedUsers": [],
"bannedUsers": [],
"bots": [],
"updatedAt": 1583924400,
"createdAt": 1583921400,
"unreadCount": 0,
"lastReadAt": 0,
"lastMessage": {
"id": "sdf2l5s9j",
"channelId": "channel123",
"userId": "user456",
"username": "myUsername",
"profileImageUrl": "http://cdn.test.com/123.jpg",
"type": "message",
"text": "Hello world",
"data": {
"customField": "customData"
},
"parentMessage": {},
"reactions": {"happy": 1},
"createdAt": 1583921400
}
}
}Remove Channel Members
POST https://api.talkplus.io/v1.4/api/channels/:channelId/members/remove
Path Parameters
Name
Type
Description
channelId*
string
Headers
Name
Type
Description
content-type
string
application/json
app-id*
string
App ID
api-key*
string
App API key
Request Body
Name
Type
Description
members*
array
users to remove
{
"channel": {
"id": "channel123",
"name": "MyFirstChannel",
"ownerId": "user123",
"type": "private",
"imageUrl": "image url",
"invitationCode": "",
"isFrozen": false,
"hideMessagesBeforeJoin": false,
"category": "",
"subcategory": "",
"privateTag": "",
"privateData": {},
"memberCount": 2,
"maxMemberCount": 100,
"data": {
"someMetaKey1": "someMetaValue1",
"someMetaKey2": "someMetaValue2"
},
"members": [
{
"id": "user123",
"username": "john",
"profileImageUrl": "http://cnd.test.com/123.jpg",
"data": {},
"memberInfo": {},
"lastReadAt": 1583924400,
"lastSentAt": 1583924400,
"updatedAt": 1583924400,
"createdAt": 1583921400
},
{
"id": "user456",
"username": "james",
"profileImageUrl": "http://cnd.test.com/456.jpg",
"data": {},
"memberInfo": {},
"lastReadAt": 1583924400,
"lastSentAt": 1583924400,
"updatedAt": 1583924400,
"createdAt": 1583921400
}
],
"mutedUsers": [],
"bannedUsers": [],
"bots": [],
"updatedAt": 1583924400,
"createdAt": 1583921400,
"unreadCount": 0,
"lastReadAt": 0,
"lastMessage": {
"id": "sdf2l5s9j",
"channelId": "channel123",
"userId": "user456",
"username": "myUsername",
"profileImageUrl": "http://cdn.test.com/123.jpg",
"type": "message",
"text": "Hello world",
"data": {
"customField": "customData"
},
"parentMessage": {},
"reactions": {"happy": 1},
"createdAt": 1583921400
}
}
}Get Users Banned from Channel
GET https://api.talkplus.io/v1.4/api/channels/:channelId/members/banned
Path Parameters
Name
Type
Description
channelId*
string
Query Parameters
Name
Type
Description
lastUserId
string
Last user ID to query from (use for pagination)
limit
integer
default: 50
Headers
Name
Type
Description
app-id*
string
App ID
api-key*
string
App API key
{
"users": [
{
"id": "user123",
"username": "john",
"profileImageUrl": "http://cnd.test.com/123.jpg",
"data": {},
"memberInfo": {},
"lastReadAt": 1583924400,
"lastSentAt": 1583924400,
"updatedAt": 1583924400,
"createdAt": 1583921400
}
],
"hasNext": false
}Ban Channel Members
POST https://api.talkplus.io/v1.4/api/channels/:channelId/members/ban
Path Parameters
Name
Type
Description
channelId*
string
Headers
Name
Type
Description
content-type
string
application/json
app-id*
string
App ID
api-key*
string
App API key
Request Body
Name
Type
Description
members*
array
users to ban
{
"channel": {
"id": "channel123",
"name": "MyFirstChannel",
"ownerId": "user123",
"type": "private",
"imageUrl": "image url",
"invitationCode": "",
"isFrozen": false,
"hideMessagesBeforeJoin": false,
"category": "",
"subcategory": "",
"privateTag": "",
"privateData": {},
"memberCount": 2,
"maxMemberCount": 100,
"data": {
"someMetaKey1": "someMetaValue1",
"someMetaKey2": "someMetaValue2"
},
"members": [
{
"id": "user123",
"username": "john",
"profileImageUrl": "http://cnd.test.com/123.jpg",
"data": {},
"memberInfo": {},
"lastReadAt": 1583924400,
"lastSentAt": 1583924400,
"updatedAt": 1583924400,
"createdAt": 1583921400
}
{
"id": "user456",
"username": "james",
"profileImageUrl": "http://cnd.test.com/456.jpg",
"data": {},
"memberInfo": {},
"lastReadAt": 1583924400,
"lastSentAt": 1583924400,
"updatedAt": 1583924400,
"createdAt": 1583921400
}
],
"mutedUsers": [],
"bannedUsers": [
{
"id": "user456",
"username": "james",
"profileImageUrl": "http://cnd.test.com/456.jpg",
"data": {},
"memberInfo": {},
"lastReadAt": 1583924400,
"lastSentAt": 1583924400,
"updatedAt": 1583924400,
"createdAt": 1583921400
}
],
"bots": [],
"updatedAt": 1583924400,
"createdAt": 1583921400,
"unreadCount": 0,
"lastReadAt": 0,
"lastMessage": {
"id": "sdf2l5s9j",
"channelId": "channel123",
"userId": "user456",
"username": "myUsername",
"profileImageUrl": "http://cdn.test.com/123.jpg",
"type": "message",
"text": "Hello world",
"data": {
"customField": "customData"
},
"parentMessage": {},
"reactions": {"happy": 1},
"createdAt": 1583921400
}
}
}Unban Users from Channel
POST https://api.talkplus.io/v1.4/api/channels/:channelId/members/unban
Path Parameters
Name
Type
Description
channelId*
string
Headers
Name
Type
Description
content-type
string
application/json
app-id*
string
App ID
api-key*
string
App API key
Request Body
Name
Type
Description
members*
array
users to unban
{
"channel": {
"id": "channel123",
"name": "MyFirstChannel",
"ownerId": "user123",
"type": "private",
"imageUrl": "image url",
"invitationCode": "",
"isFrozen": false,
"hideMessagesBeforeJoin": false,
"category": "",
"subcategory": "",
"privateTag": "",
"privateData": {},
"memberCount": 2,
"maxMemberCount": 100,
"data": {
"someMetaKey1": "someMetaValue1",
"someMetaKey2": "someMetaValue2"
},
"members": [
{
"id": "user123",
"username": "john",
"profileImageUrl": "http://cnd.test.com/123.jpg",
"data": {},
"memberInfo": {},
"lastReadAt": 1583924400,
"lastSentAt": 1583924400,
"updatedAt": 1583924400,
"createdAt": 1583921400
},
{
"id": "user456",
"username": "james",
"profileImageUrl": "http://cnd.test.com/456.jpg",
"data": {},
"memberInfo": {},
"lastReadAt": 1583924400,
"lastSentAt": 1583924400,
"updatedAt": 1583924400,
"createdAt": 1583921400
}
],
"mutedUsers": [],
"bannedUsers": [],
"bots": [],
"updatedAt": 1583924400,
"createdAt": 1583921400,
"unreadCount": 0,
"lastReadAt": 0,
"lastMessage": {
"id": "sdf2l5s9j",
"channelId": "channel123",
"userId": "user456",
"username": "myUsername",
"profileImageUrl": "http://cdn.test.com/123.jpg",
"type": "message",
"text": "Hello world",
"data": {
"customField": "customData"
},
"parentMessage": {},
"reactions": {"happy": 1},
"createdAt": 1583921400
}
}
}Get Muted Channel Members
GET /v1.4/api/channels/:channelId/members/muted
Path Parameters
Name
Type
Description
channelId*
string
Query Parameters
Name
Type
Description
lastUserId
string
Last member user ID to query from (use for pagination)
limit
integer
default: 50
Headers
Name
Type
Description
app-id*
string
App ID
api-key*
string
App API key
{
"members": [
{
"id": "user123",
"username": "john",
"profileImageUrl": "http://cnd.test.com/123.jpg",
"data": {},
"memberInfo": {},
"lastReadAt": 1583924400,
"lastSentAt": 1583924400,
"updatedAt": 1583924400,
"createdAt": 1583921400
}
],
"hasNext": false
}Mute Channel Members
POST https://api.talkplus.io/v1.4/api/channels/:channelId/members/mute
Path Parameters
Name
Type
Description
channelId*
string
Headers
Name
Type
Description
content-type
string
application/json
app-id*
string
App ID
api-key*
string
App API key
Request Body
Name
Type
Description
members*
array
users to mute
expireInMinutes
int
expireInMinutes allows you to mute another channel member for a specified number of minutes. Mute status is then cancelled after specified number of minutes. Default value for
expireInMinutesis 0 (no automatic cancellation)
{
"channel": {
"id": "channel123",
"name": "MyFirstChannel",
"ownerId": "user123",
"type": "private",
"imageUrl": "image url",
"invitationCode": "",
"isFrozen": false,
"hideMessagesBeforeJoin": false,
"category": "",
"subcategory": "",
"privateTag": "",
"privateData": {},
"memberCount": 1,
"maxMemberCount": 100,
"data": {
"someMetaKey1": "someMetaValue1",
"someMetaKey2": "someMetaValue2"
},
"members": [
{
"id": "user123",
"username": "john",
"profileImageUrl": "http://cnd.test.com/123.jpg",
"data": {},
"memberInfo": {},
"lastReadAt": 1583924400,
"lastSentAt": 1583924400,
"updatedAt": 1583924400,
"createdAt": 1583921400
},
{
"id": "user456",
"username": "john",
"profileImageUrl": "http://cnd.test.com/456.jpg",
"data": {},
"memberInfo": {},
"lastReadAt": 1583924400,
"lastSentAt": 1583924400,
"updatedAt": 1583924400,
"createdAt": 1583921400
}
],
"mutedUsers": [
"user456"
],
"bannedUsers": [],
"bots": [],
"updatedAt": 1583924400,
"createdAt": 1583921400,
"unreadCount": 0,
"lastReadAt": 0,
"lastMessage": {
"id": "sdf2l5s9j",
"channelId": "channel123",
"userId": "user456",
"username": "myUsername",
"profileImageUrl": "http://cdn.test.com/123.jpg",
"type": "message",
"text": "Hello world",
"data": {
"customField": "customData"
},
"parentMessage": {},
"reactions": {"happy": 1},
"createdAt": 1583921400
}
}
}Unmute Channel Members
POST https://api.talkplus.io/v1.4/api/channels/:channelId/members/unmute
Path Parameters
Name
Type
Description
channelId*
string
Headers
Name
Type
Description
content-type
string
application/json
app-id*
string
App ID
api-key*
string
App API key
Request Body
Name
Type
Description
members*
array
users to unmute
{
"channel": {
"id": "channel123",
"name": "MyFirstChannel",
"ownerId": "user123",
"type": "private",
"imageUrl": "image url",
"invitationCode": "",
"isFrozen": false,
"hideMessagesBeforeJoin": false,
"category": "",
"subcategory": "",
"privateTag": "",
"privateData": {},
"memberCount": 2,
"maxMemberCount": 100,
"data": {
"someMetaKey1": "someMetaValue1",
"someMetaKey2": "someMetaValue2"
},
"members": [
{
"id": "user123",
"username": "john",
"profileImageUrl": "http://cnd.test.com/123.jpg",
"data": {},
"memberInfo": {},
"lastReadAt": 1583924400,
"lastSentAt": 1583924400,
"updatedAt": 1583924400,
"createdAt": 1583921400
},
{
"id": "user456",
"username": "james",
"profileImageUrl": "http://cnd.test.com/456.jpg",
"data": {},
"memberInfo": {},
"lastReadAt": 1583924400,
"lastSentAt": 1583924400,
"updatedAt": 1583924400,
"createdAt": 1583921400
}
],
"mutedUsers": [],
"bannedUsers": [],
"bots": [],
"updatedAt": 1583924400,
"createdAt": 1583921400,
"unreadCount": 0,
"lastReadAt": 0,
"lastMessage": {
"id": "sdf2l5s9j",
"channelId": "channel123",
"userId": "user456",
"username": "myUsername",
"profileImageUrl": "http://cdn.test.com/123.jpg",
"type": "message",
"text": "Hello world",
"data": {
"customField": "customData"
},
"parentMessage": {},
"reactions": {"happy": 1},
"createdAt": 1583921400
}
}
}Mute All Channel Members (except owner)
POST https://api.talkplus.io/v1.4/api/channels/:channelId/members/mute/all
Path Parameters
Name
Type
Description
channelId*
string
Headers
Name
Type
Description
content-type
string
application/json
app-id*
string
App ID
api-key*
string
App API key
{
"channel": {
"id": "channel123",
"name": "MyFirstChannel",
"ownerId": "user123",
"type": "private",
"imageUrl": "image url",
"invitationCode": "",
"isFrozen": false,
"hideMessagesBeforeJoin": false,
"category": "",
"subcategory": "",
"privateTag": "",
"privateData": {},
"memberCount": 1,
"maxMemberCount": 100,
"data": {
"someMetaKey1": "someMetaValue1",
"someMetaKey2": "someMetaValue2"
},
"members": [
{
"id": "user123",
"username": "john",
"profileImageUrl": "http://cnd.test.com/123.jpg",
"data": {},
"memberInfo": {},
"lastReadAt": 1583924400,
"lastSentAt": 1583924400,
"updatedAt": 1583924400,
"createdAt": 1583921400
},
{
"id": "user456",
"username": "john",
"profileImageUrl": "http://cnd.test.com/456.jpg",
"data": {},
"memberInfo": {},
"lastReadAt": 1583924400,
"lastSentAt": 1583924400,
"updatedAt": 1583924400,
"createdAt": 1583921400
}
],
"mutedUsers": [
"user456"
],
"bannedUsers": [],
"bots": [],
"updatedAt": 1583924400,
"createdAt": 1583921400,
"unreadCount": 0,
"lastReadAt": 0,
"lastMessage": {
"id": "sdf2l5s9j",
"channelId": "channel123",
"userId": "user456",
"username": "myUsername",
"profileImageUrl": "http://cdn.test.com/123.jpg",
"type": "message",
"text": "Hello world",
"data": {
"customField": "customData"
},
"parentMessage": {},
"reactions": {"happy": 1},
"createdAt": 1583921400
}
}
}Enable Channel Push Notification for Member
POST https://api.talkplus.io/v1.4/api/channels/:channelId/members/:memberId/push/enable
Path Parameters
Name
Type
Description
channelId*
string
memberId*
string
Headers
Name
Type
Description
content-type
string
application/json
app-id*
string
App ID
api-key*
string
App API key
{}Disable Channel Push Notification for Member
POST https://api.talkplus.io/v1.4/api/channels/:channelId/members/:memberId/push/disable
Path Parameters
Name
Type
Description
channelId*
string
memberId*
string
Headers
Name
Type
Description
content-type
string
application/json
app-id*
string
App ID
api-key*
string
App API key
{}Last updated