Skip to main content

Manage group overview

This section covers all APIs related to managing groups including adding / removing members or admins, updating group info or fetching group info.

Get group info API

// userAlice.chat.group.info(chatid)
const groupInfo = await userAlice.chat.group.info(chatid);

Get group info parameters

ParamTypeDefaultRemarks
chatIdstring-The chatid related to that specific group. chatid are unique identifiers of the group

Note: Parameters in this style are mandatory.

Expected response
{
members: [
{
wallet: 'eip155:0x34E8E400BE58476977EB37c18d3C005878AB6d0C',
publicKey: '-----BEGIN PGP PUBLIC KEY BLOCK-----\n...\n-----END PGP PUBLIC KEY BLOCK-----\n',
isAdmin: false,
image: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAA3UlEQVR4AcXBwWnDMBiG4TdfPYEhHaUHQTcQ+OwptEQW0BDFZ4Nm0LlzJOAV0uufHASGwvc8l4/frydBaoWo50q0HCsj+7wRpVaIeq5EwkyYCbOJN9d0Z2SfN864pjsjwkyYCbPL9+3nyQk9V0ZSK5whzISZMJt6rkTLsRLt88YZPVei5ViJ9nkjEmbCTJhNqRWiB28yL1IrjPRciR79kyhRiISZMBNmU8+VkdQKUc+VEWEmzITZxEmpFf6TMBNmwmxajpWRB696roykVoiWY2VEmAkzYfYH3Hw19cO7Z2gAAAAASUVORK5CYII='
},
// ... other members
],
pendingMembers: [
{
wallet: 'eip155:0xa708408C8a7329686D2fa3878d89c5506BCFc208',
publicKey: '-----BEGIN PGP PUBLIC KEY BLOCK-----\n...\n-----END PGP PUBLIC KEY BLOCK-----\n',
isAdmin: false,
image: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAv0lEQVR4AcXBsW3DMBCG0U8HbSBWqrRFuAOXUKU5bghV2YM7UIu4YmZQ2oMLBobh/O9N+7ndDHhqvMN7ZsQQM8QMsdlTI/r++iHymonWUhl51EK0lkp0XAuRIWaIGWIzT45rIXLec1wLI4aYIWaITfu53QSeGp/kPRMZYoaYITbzxHvmPxlihpghNq+lEj1q4ZPWUokMMUPMEJv2c7t5gafGiPfMKwwxQ8wQm/mDp0bkPTPiqRF5z4wYYoaYIfYLX7goJhSWdjIAAAAASUVORK5CYII='
},
{
wallet: 'eip155:0x057fcD7BD66e0b0e7CBF387D12b2A49A20d30922',
publicKey: '-----BEGIN PGP PUBLIC KEY BLOCK-----\n...\n-----END PGP PUBLIC KEY BLOCK-----\n',
isAdmin: false,
image: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAA0UlEQVR4AcXBoXWEQBiF0Y93ONQSAxXQQRQWRQ+jUgQiHaDGRFBCDBVAN2sm9t+I2cNZ8e5tPn+/ChXLuRNtw0TNcu5E2zBRI8yEmTBrfr4/CkbCTJgJs5abcr9SM1+JO4SZMBNmLS/kfiWar0RN7lei+UrUCDNhJsza3K9Ej+YgWs7EHfOViLZhIurKSCTMhJkwa/mnKyPPdt7RlZEaYSbMhFk7X4loGyaibZiIujJS82gOnh1Ey7kTCTNhJsza3K9Ey5mo23lH7lciYSbMhNkfIf8uvOtcjvQAAAAASUVORK5CYII='
}
],
contractAddressERC20: null,
numberOfERC20: 0,
contractAddressNFT: null,
numberOfNFTTokens: 0,
verificationProof: 'pgp:-----BEGIN PGP SIGNATURE-----\n' +
'\n' +
'wsBzBAEBCAAnBQJk6On3CRAtcVo/Zi9rvxYhBIrLzeZNLt+Uy3klWy1xWj9m\n' +
'L2u/AAAtBQgAku//IjUJkU1VTEJkW0t3U1yAgQNfTtkCrlIN9a627YI5f+yW\n' +
'tuv09s6WcJyiY1re05OiMMi/aRVs+zXSEwOJ2vb5q/DyEg/sSqMIxBo1YSAA\n' +
'LyH2BcvGiuHgaNoIVd37UQ5PcZPZ9NZBSDANwKS27+3Ze9fIcap/Fsdq1sRb\n' +
'CkE0U905jCAqJppRsY7sCcauf8dcDcL6CD5zsXCK6aRZtHVPMe4b4pq3+aCU\n' +
'inlMO2CN6gkB6sKDkJ/BoQspwEVvIsKzlgc40g3EFgpiw0PbcuGO78aNVzkJ\n' +
'2diQItfLLJr5Ptr9cgUJZYvI1edFytHUJMU3v+jCMMLTyuJxtEULEQ==\n' +
'=Ij/9\n' +
'-----END PGP SIGNATURE-----\n',
groupImage: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAeAA'... 174406 more characters,
groupName: 'BRB Chat',
groupDescription: 'Learn, Build, Chat, and stay updated about everything BRB with this exclusive Token-gated group',
isPublic: true,
groupCreator: 'eip155:0x0d73BfA82E7C4f8997b989bB44C4566FA4553776',
chatId: '4ac5ab85c9c3d57adbdf2dba79357e56b2f9ef0256befe750d9f93af78d2ca68',
meta: null,
scheduleAt: null,
scheduleEnd: null,
groupType: 'default',
status: null,
encryptedSecret: null,
sessionKey: null,
rules: { chat: { conditions: [Array] } }
}
ParamTypeRemarks
entrybooleanRefers if the Profile has access to enter the group
chatbooleanRefers if the Profile has access to chat in the group
rulesobjectModeration rules of the group

Update group API

To update a group you created.

// userAlice.chat.group.update(chatid, {options?})
const updatedGroup = await userAlice.chat.group.update(chatid, options);

Update group parameters

ParamTypeSubtypeDefaultRemarks
chatIdstring-The chatid related to that specific group. chatid are unique identifiers of the group
optionsobject--Optional Configuration for creating group.
-options.descriptionstring-A description of the group.
-options.imagestring-Image for the group in Base64 format
-options.privatebooleanfalseIndicates if the group is private.
-options.rulesany[]-Define conditions such as token gating, nft gating, custom endpoint for joining or sending message in a group. See conditional group gating to understand rule engine and how to fine tune conditional rules of your group

Note: Parameters in this style are mandatory.

Expected response
{
members: [
{
wallet: 'eip155:0x140BE62b2177A975Bbef398DF8934b883E7d13f9',
publicKey: '-----BEGIN PGP PUBLIC KEY BLOCK-----\n' +
'\n' +
'xsBNBGTvNZgBCADeYpZfxgn1HoMUuWM42v8ZWfLPwglQYmzz5rY3PdPPoRFU\n' +
'v0AyPjYKpmLh2ZNfXjPaS9GuMdpXaomYSEwsV02hXZOQelo9cLop0Fc2i+l7\n' +
'70rYhePuOuQ+XD/xYzhngAgNJ9rX96YnSodldb8uJfxYmgoF0E9Z2o2fgZGj\n' +
'll2CPnOaLXZaBQlPS3x/461TmZ1n2ZePS/fwiC7taLz3PtyGtKaC0vo4isvI\n' +
'yf04fkjudG0XIns5CWjdR2HeDC8BzSl8OVj8AQAc5uVU8Abk+ejWVr4zfoox\n' +
'eaziDPgGdkckFiQ6Tdsg0tPwwOpSrCCtJocTmc/fWaBb0YlnyAAL88fJABEB\n' +
'AAHNAMLAigQQAQgAPgWCZO81mAQLCQcICZBMYqhmfI2WQQMVCAoEFgACAQIZ\n' +
'AQKbAwIeARYhBC9DyzhpX3ACb/yTq0xiqGZ8jZZBAACxNQf/UrM/whR7vCs+\n' +
'ez8Y8Hz4WqIuXtfMh4l2nKVv5UUuAfQkBxEY5j6Ga2+JgKU3neQ34x/v6fm9\n' +
'CLcY38Tc4AWyEx8KC78J+xOs7RMfyNBeiaf8KdaFfQrP0nMmufE6TxkfV1Y5\n' +
'LJZZ8350rZVtYJppWtlH+gbyUmMObyWDWbL3aWtqa3xjv0kLsf7TnugiFwzB\n' +
'gHHtk8tlDSOxRt0VdNNd19+/zrBYNl07Ig24WD2ETaJiaqa651z24/6/MkGT\n' +
'MBoQh+679tuWWcTrNi4jIA8jhSQ5BOgbAapl3qXk0m9/Aexpe2s6ISLXe8YJ\n' +
'j4cObDLv/ZKKeLZYTq9lVCydLAQUbs7ATQRk7zWYAQgAmx36uefgUF4cCSYH\n' +
'WMWAOTyc8Awo+hxn6FktOLU1+9hfGrX2jwGLOoOwjNgbYJbiSvRglAX2b57/\n' +
'qkkltAg1ZYCLSUzfBUbbWYlJNBwpv7+52zHaLUZ3gmI5aE48ad+uzaadgpVT\n' +
'VqLbhdgkN6jkemPTlfMehyS49AAbmqeKfo2U72tm9ZqT2cPVCASMjN/Ux2qG\n' +
'3W8HTo0KIVFSbkTthl1zAlwAFksp0q437+pxbdJIecJ9mO6N4OQMnv+hVBDc\n' +
'WrPqBDJ0nas4JNgLxmLv0pheGg/TEfwS/p6xGRW5m08bj2l0cgqmEaM27jbi\n' +
'DEpOykRWsDMhheEfI2zV/Qam8QARAQABwsB2BBgBCAAqBYJk7zWYCZBMYqhm\n' +
'fI2WQQKbDBYhBC9DyzhpX3ACb/yTq0xiqGZ8jZZBAAAnBggA1gkIopr9HJFP\n' +
'fO5SebcbowH4AG9M0qBqF4h1JIKbqvOnxLSsC5QmmzFcjS9ihyHBvzbRVGkC\n' +
'zEHYpLRedQ2AmQQfsf/VOoZJEOlb7tTk4+SpYtsGte5X/yLT5Bkls7Rp8ubK\n' +
'/V99muj1nA/OkasllXQUSGEweVz6ejzJ0oMm3Vewmw8PelsdAnfS7Ud1MnXQ\n' +
'h+O8TCR56F5gAMWxZmxFpZMZyUFOH6KM+vL7HJUBztUS2g0ELsHKy9ep2yhv\n' +
'iABIwx/gEuPr0NDAH9x9XFKg5m3rO64KTY4BRWBISwmQ25dM1s1bwDPLi5XI\n' +
'6Daw1glFxpPRrxgQGlVLzJOu5b8swQ==\n' +
'=9hCc\n' +
'-----END PGP PUBLIC KEY BLOCK-----\n',
isAdmin: true,
image: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAzUlEQVR4AcXBsWlDMRiF0c8XTeAJPIAgoFbgQew1PIbXyKsyhUGtCqM6ZAJX6Z32fykM4hnuObv71++TYJRKlHtji1EqUe6NSJgJM2G2W74/nkzIvfHKKJUZwkyYCbOUe+Odcm/MEGbCTJil2/VMdLx8Eo1S2SL3RnS7nomEmTATZmm//BANKlHujS1GqUT7hRVhJsyEWWLSKJVXcm/MEGbCTJgl/sm9EY1SmTFKJcq9EY1SiYSZMBNm6XE6sHJhJffGOz1OByJhJsyE2R/3lDA4e9QQhAAAAABJRU5ErkJggg=='
}
],
pendingMembers: [
{
wallet: 'eip155:0x119bb8ad40B1f94e2b30ae5f59eeaEB67cD0Bd6C',
publicKey: null,
isAdmin: false,
image: null
},
{
wallet: 'eip155:0x6e0C509d14EbF26A529bf6DC5CC9bee7F5b8DBa4',
publicKey: null,
isAdmin: false,
image: null
},
{
wallet: 'eip155:0xE3FDD0527a9F8418f9a7D9e970452827FbE202FF',
publicKey: '-----BEGIN PGP PUBLIC KEY BLOCK-----\n' +
'\n' +
'xsBNBGTvNZgBCADouo4S2kPqA//+I7nDAk15/LcJ2TGvDhOYuPNUNMiNGOb4\n' +
'txusuKz6HOaG+K9hiUBpHjKrYEmCT2FEXxt8bfS3SpWb74RHSkWUNUkxk25y\n' +
'gE5gaCKyAdcnOUyVLmobVFFYtH6naK9bULaUtkVik1P0iuEevWHxtTpsjbyH\n' +
'bZtNpVTdprdLib4Wx6bb7VogsvjlvNJcVJ4sfPE0XgsQgAGIev7yJyU0DGzt\n' +
'/EbvFX4sv51Kb1dX9ctBcvzVbs9+qT6LTivsrQp+TNHUN4zEeMhnWFFP5K1d\n' +
'H445S6FWk53XvBudcOkFPtltU1MPCS6hmhevArBfYzy5eSlaKA/fH+kFABEB\n' +
'AAHNAMLAigQQAQgAPgWCZO81mAQLCQcICZCrD2gy8Zu4awMVCAoEFgACAQIZ\n' +
'AQKbAwIeARYhBKru9/u8wPcTeHibkasPaDLxm7hrAADa/Af+PbamVg/Ig2S2\n' +
'HgIy4w5x7ulSk1/49+AmuiUMiVUwJSVBhROsyDbLET56w4+1TIMYZFJaczW3\n' +
'8tCvAOUSauzc52I3zwGmaCupBJokIWp7ncPh0B8TFYrgThgXV7sLf3xy4roy\n' +
'y8oFz1Zla88krwtPe4Az7TF+WNdXoDsLNJ3GXRmNqs1GITmDqAXFWncl12NM\n' +
'ajUKWIKc/Gi1oKfz22mabJTtWBimDpA12LaGK3GjEK5CiWXT3Tzlqn6R14EZ\n' +
'6ohpKZldSJiMPL0Bu9iT52iHOsw1wTZNC1L5lKhOCi3c+/fLRcJZt3hdCjqy\n' +
'd/FSCa8/Ny/GrHBWoL49rSF4pDEA+s7ATQRk7zWYAQgAtNOoHCL7BCnjwp8O\n' +
'htTxEI5r7Q/1zKKHiz6QKjjrGBYyR6gcmPM3JNEcvzY4OsCFnKBv2suOgrqH\n' +
'8kXJzfpIQ7u7uJs+O3p/cn86RMANiEnO8NbB/0scpfZ7Vg3eOfoiWYE4I/1o\n' +
'FVDCyZ1YVqtbcmuW6D8i1djjeoUmkUDZyPo7Qs6hUsJeYA/Rfl8mH5sjy2cN\n' +
'WXf8cEtOUqJtwERXt5aRB/nBZiC0bsP6hf0HtAoNA8/96TkqrcQpODW/RckD\n' +
'fo4wkpEONHRH+LGX7GV0pwymHu42TUnULmED6BrMgMYG2sKpxMThxtAxRaiP\n' +
'nZ3DKXr8GCjTYnbEZpoi2zKCOQARAQABwsB2BBgBCAAqBYJk7zWYCZCrD2gy\n' +
'8Zu4awKbDBYhBKru9/u8wPcTeHibkasPaDLxm7hrAADGyQgA5NMUkoyDTPZa\n' +
'Znj1dB+17xBXCZ/u7pPQc1DukBefVke7/qYIicdnnEGIX3Zd7TckFRsDljR/\n' +
'3418Bne4WyL57fAF/GgYsegpJ9n1KT7oPxWzibIaYdj7R6bkDt5r61EDWC3N\n' +
'VBbnZu9cO15TYkObJIiyNvwbQyd6Dm313b39GnEE8sM709TWsI6Es6rRZAfC\n' +
'+sI8ezYxqVUbP7sW3jJZYzdPOhZPHvFd5iJ2EfygEOuk5tb7AimfNwF/CNcB\n' +
'weQGEU7feOSB9lXXA+Ag1duLM4B9bLbbHEQIPhKlBF1ED64e/W/5HNfoAkS4\n' +
'qhzOD5XWs6xs45nnYqUbBFLG9Xk+Jg==\n' +
'=qtAv\n' +
'-----END PGP PUBLIC KEY BLOCK-----\n',
isAdmin: false,
image: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAw0lEQVR4AcXBsXECMRRF0csbdbAZBagHKlJMSOL90IUq2h5UABktLE6/HcizY4/fOafrcntzQB/BTKvBEcJMmAmz0keQtRpk67bzRQ1m1m0nu19E1keQCTNhJsxO1+X2JukjmHm+Ppg5Lw9mWg0yYSbMhFnhoPPy4C8JM2EmzArftBr8J2EmzIRZ6SPIWg2yPoKs1WCmjyBrNcj6CDJhJsyEWWk1OKKP4DdaDTJhJsyEWeEHrQbZuu3M3C/iCGEmzITZJ/s7LOkKUABjAAAAAElFTkSuQmCC'
}
],
contractAddressERC20: null,
numberOfERC20: 0,
contractAddressNFT: null,
numberOfNFTTokens: 0,
verificationProof: 'pgp:-----BEGIN PGP SIGNATURE-----\n' +
'\n' +
'wsBzBAEBCAAnBYJk7zWZCZBMYqhmfI2WQRYhBC9DyzhpX3ACb/yTq0xiqGZ8\n' +
'jZZBAADwAwgAq/6WjtwRt1aPTLWwtSx80Ng/Wxf97dkpebMXSj9T7f5ia1rM\n' +
'8wqsuNUDMEMPB9LM34f6Q5pD994oeN2YT7z34u20mskiNphZdx/DNvu8w9UZ\n' +
'rI3tyjfZULhARNVM34sSABnHtExbl4ZArhNDsT86ku0sZNjr9frn2mtgmlKN\n' +
'nQdGcLJSxbci0hFg3nE5mYNpwZNs2S/2uk11WHKxzMhII6AdePE77BKPqedu\n' +
'PiXDODO2dIvV8glLQoJPRPgc2ap+/xYIBUFljqHGPU/62VSLlHxBJv72p5s/\n' +
'kOxiqD42TmpaaMtfudqgsZsGoYpZDHcMKYGNZs+9qVRHPRD+s0QhEA==\n' +
'=c6IF\n' +
'-----END PGP SIGNATURE-----\n',
groupImage: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAvklEQVR4AcXBsW2FMBiF0Y8r3GQb6jeBxRauYRpo4yGQkMd4A7kg7Z/GUfSKe8703fKDkTATZsJsrr0RlZSJ9r4RLayMvLmJjnQS1d6IhJkwE2bT13U/DBzp5BN73xgRZsJMmM1HOolqb/yWiWpvjJSUiRZWopIykTATZsJs5g+1N6KSMiO1N/5DmAkzYTa9Lh6MhJkwE2ZzSZlo7xvRwson3txERzqJhJkwE2bT6+JhoKTMJ2pvjAgzYSbMfgDlXixqjH6gRgAAAABJRU5ErkJggg==',
groupName: 'influential_maroon_gamefowl',
groupDescription: 'urgent_brown_butterfly',
isPublic: false,
groupCreator: 'eip155:0x140BE62b2177A975Bbef398DF8934b883E7d13f9',
chatId: '5f769c881ffe328117dea3d3acd0b97ce7f4c163e440f75a96be3e33f7d2a000',
meta: null,
scheduleAt: null,
scheduleEnd: null,
groupType: 'default',
status: null,
rules: {},
eventType: 'update'
}

Add participants to group API

// await userAlice.chat.group.add(chatid, {options?})
const addAdminToGroup = await userAlice.chat.group.add(groupChatId, {
role: 'ADMIN', // 'ADMIN' or 'MEMBER'
accounts: [account1, account2],
});

Add participants to group parameters

ParamTypeSubtypeDefaultRemarks
chatIdstring--The chatid related to that specific group. chatid are unique identifiers of the group
optionsobject--Configuration for adding participants to group.
-roleADMIN or MEMBER-Role of added participant
-accountsstring[]-Added participant addresses

Note: Parameters in this style are mandatory.

Expected response
{
members: [
{
wallet: 'eip155:0x140BE62b2177A975Bbef398DF8934b883E7d13f9',
publicKey: '-----BEGIN PGP PUBLIC KEY BLOCK-----\n' +
'\n' +
'xsBNBGTvNZgBCADeYpZfxgn1HoMUuWM42v8ZWfLPwglQYmzz5rY3PdPPoRFU\n' +
'v0AyPjYKpmLh2ZNfXjPaS9GuMdpXaomYSEwsV02hXZOQelo9cLop0Fc2i+l7\n' +
'70rYhePuOuQ+XD/xYzhngAgNJ9rX96YnSodldb8uJfxYmgoF0E9Z2o2fgZGj\n' +
'll2CPnOaLXZaBQlPS3x/461TmZ1n2ZePS/fwiC7taLz3PtyGtKaC0vo4isvI\n' +
'yf04fkjudG0XIns5CWjdR2HeDC8BzSl8OVj8AQAc5uVU8Abk+ejWVr4zfoox\n' +
'eaziDPgGdkckFiQ6Tdsg0tPwwOpSrCCtJocTmc/fWaBb0YlnyAAL88fJABEB\n' +
'AAHNAMLAigQQAQgAPgWCZO81mAQLCQcICZBMYqhmfI2WQQMVCAoEFgACAQIZ\n' +
'AQKbAwIeARYhBC9DyzhpX3ACb/yTq0xiqGZ8jZZBAACxNQf/UrM/whR7vCs+\n' +
'ez8Y8Hz4WqIuXtfMh4l2nKVv5UUuAfQkBxEY5j6Ga2+JgKU3neQ34x/v6fm9\n' +
'CLcY38Tc4AWyEx8KC78J+xOs7RMfyNBeiaf8KdaFfQrP0nMmufE6TxkfV1Y5\n' +
'LJZZ8350rZVtYJppWtlH+gbyUmMObyWDWbL3aWtqa3xjv0kLsf7TnugiFwzB\n' +
'gHHtk8tlDSOxRt0VdNNd19+/zrBYNl07Ig24WD2ETaJiaqa651z24/6/MkGT\n' +
'MBoQh+679tuWWcTrNi4jIA8jhSQ5BOgbAapl3qXk0m9/Aexpe2s6ISLXe8YJ\n' +
'j4cObDLv/ZKKeLZYTq9lVCydLAQUbs7ATQRk7zWYAQgAmx36uefgUF4cCSYH\n' +
'WMWAOTyc8Awo+hxn6FktOLU1+9hfGrX2jwGLOoOwjNgbYJbiSvRglAX2b57/\n' +
'qkkltAg1ZYCLSUzfBUbbWYlJNBwpv7+52zHaLUZ3gmI5aE48ad+uzaadgpVT\n' +
'VqLbhdgkN6jkemPTlfMehyS49AAbmqeKfo2U72tm9ZqT2cPVCASMjN/Ux2qG\n' +
'3W8HTo0KIVFSbkTthl1zAlwAFksp0q437+pxbdJIecJ9mO6N4OQMnv+hVBDc\n' +
'WrPqBDJ0nas4JNgLxmLv0pheGg/TEfwS/p6xGRW5m08bj2l0cgqmEaM27jbi\n' +
'DEpOykRWsDMhheEfI2zV/Qam8QARAQABwsB2BBgBCAAqBYJk7zWYCZBMYqhm\n' +
'fI2WQQKbDBYhBC9DyzhpX3ACb/yTq0xiqGZ8jZZBAAAnBggA1gkIopr9HJFP\n' +
'fO5SebcbowH4AG9M0qBqF4h1JIKbqvOnxLSsC5QmmzFcjS9ihyHBvzbRVGkC\n' +
'zEHYpLRedQ2AmQQfsf/VOoZJEOlb7tTk4+SpYtsGte5X/yLT5Bkls7Rp8ubK\n' +
'/V99muj1nA/OkasllXQUSGEweVz6ejzJ0oMm3Vewmw8PelsdAnfS7Ud1MnXQ\n' +
'h+O8TCR56F5gAMWxZmxFpZMZyUFOH6KM+vL7HJUBztUS2g0ELsHKy9ep2yhv\n' +
'iABIwx/gEuPr0NDAH9x9XFKg5m3rO64KTY4BRWBISwmQ25dM1s1bwDPLi5XI\n' +
'6Daw1glFxpPRrxgQGlVLzJOu5b8swQ==\n' +
'=9hCc\n' +
'-----END PGP PUBLIC KEY BLOCK-----\n',
isAdmin: true,
image: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAzUlEQVR4AcXBsWlDMRiF0c8XTeAJPIAgoFbgQew1PIbXyKsyhUGtCqM6ZAJX6Z32fykM4hnuObv71++TYJRKlHtji1EqUe6NSJgJM2G2W74/nkzIvfHKKJUZwkyYCbOUe+Odcm/MEGbCTJil2/VMdLx8Eo1S2SL3RnS7nomEmTATZmm//BANKlHujS1GqUT7hRVhJsyEWWLSKJVXcm/MEGbCTJgl/sm9EY1SmTFKJcq9EY1SiYSZMBNm6XE6sHJhJffGOz1OByJhJsyE2R/3lDA4e9QQhAAAAABJRU5ErkJggg=='
}
],
pendingMembers: [
{
wallet: 'eip155:0x119bb8ad40B1f94e2b30ae5f59eeaEB67cD0Bd6C',
publicKey: null,
isAdmin: false,
image: null
},
{
wallet: 'eip155:0x6e0C509d14EbF26A529bf6DC5CC9bee7F5b8DBa4',
publicKey: null,
isAdmin: false,
image: null
},
{
wallet: 'eip155:0xE3FDD0527a9F8418f9a7D9e970452827FbE202FF',
publicKey: '-----BEGIN PGP PUBLIC KEY BLOCK-----\n' +
'\n' +
'xsBNBGTvNZgBCADouo4S2kPqA//+I7nDAk15/LcJ2TGvDhOYuPNUNMiNGOb4\n' +
'txusuKz6HOaG+K9hiUBpHjKrYEmCT2FEXxt8bfS3SpWb74RHSkWUNUkxk25y\n' +
'gE5gaCKyAdcnOUyVLmobVFFYtH6naK9bULaUtkVik1P0iuEevWHxtTpsjbyH\n' +
'bZtNpVTdprdLib4Wx6bb7VogsvjlvNJcVJ4sfPE0XgsQgAGIev7yJyU0DGzt\n' +
'/EbvFX4sv51Kb1dX9ctBcvzVbs9+qT6LTivsrQp+TNHUN4zEeMhnWFFP5K1d\n' +
'H445S6FWk53XvBudcOkFPtltU1MPCS6hmhevArBfYzy5eSlaKA/fH+kFABEB\n' +
'AAHNAMLAigQQAQgAPgWCZO81mAQLCQcICZCrD2gy8Zu4awMVCAoEFgACAQIZ\n' +
'AQKbAwIeARYhBKru9/u8wPcTeHibkasPaDLxm7hrAADa/Af+PbamVg/Ig2S2\n' +
'HgIy4w5x7ulSk1/49+AmuiUMiVUwJSVBhROsyDbLET56w4+1TIMYZFJaczW3\n' +
'8tCvAOUSauzc52I3zwGmaCupBJokIWp7ncPh0B8TFYrgThgXV7sLf3xy4roy\n' +
'y8oFz1Zla88krwtPe4Az7TF+WNdXoDsLNJ3GXRmNqs1GITmDqAXFWncl12NM\n' +
'ajUKWIKc/Gi1oKfz22mabJTtWBimDpA12LaGK3GjEK5CiWXT3Tzlqn6R14EZ\n' +
'6ohpKZldSJiMPL0Bu9iT52iHOsw1wTZNC1L5lKhOCi3c+/fLRcJZt3hdCjqy\n' +
'd/FSCa8/Ny/GrHBWoL49rSF4pDEA+s7ATQRk7zWYAQgAtNOoHCL7BCnjwp8O\n' +
'htTxEI5r7Q/1zKKHiz6QKjjrGBYyR6gcmPM3JNEcvzY4OsCFnKBv2suOgrqH\n' +
'8kXJzfpIQ7u7uJs+O3p/cn86RMANiEnO8NbB/0scpfZ7Vg3eOfoiWYE4I/1o\n' +
'FVDCyZ1YVqtbcmuW6D8i1djjeoUmkUDZyPo7Qs6hUsJeYA/Rfl8mH5sjy2cN\n' +
'WXf8cEtOUqJtwERXt5aRB/nBZiC0bsP6hf0HtAoNA8/96TkqrcQpODW/RckD\n' +
'fo4wkpEONHRH+LGX7GV0pwymHu42TUnULmED6BrMgMYG2sKpxMThxtAxRaiP\n' +
'nZ3DKXr8GCjTYnbEZpoi2zKCOQARAQABwsB2BBgBCAAqBYJk7zWYCZCrD2gy\n' +
'8Zu4awKbDBYhBKru9/u8wPcTeHibkasPaDLxm7hrAADGyQgA5NMUkoyDTPZa\n' +
'Znj1dB+17xBXCZ/u7pPQc1DukBefVke7/qYIicdnnEGIX3Zd7TckFRsDljR/\n' +
'3418Bne4WyL57fAF/GgYsegpJ9n1KT7oPxWzibIaYdj7R6bkDt5r61EDWC3N\n' +
'VBbnZu9cO15TYkObJIiyNvwbQyd6Dm313b39GnEE8sM709TWsI6Es6rRZAfC\n' +
'+sI8ezYxqVUbP7sW3jJZYzdPOhZPHvFd5iJ2EfygEOuk5tb7AimfNwF/CNcB\n' +
'weQGEU7feOSB9lXXA+Ag1duLM4B9bLbbHEQIPhKlBF1ED64e/W/5HNfoAkS4\n' +
'qhzOD5XWs6xs45nnYqUbBFLG9Xk+Jg==\n' +
'=qtAv\n' +
'-----END PGP PUBLIC KEY BLOCK-----\n',
isAdmin: false,
image: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAw0lEQVR4AcXBsXECMRRF0csbdbAZBagHKlJMSOL90IUq2h5UABktLE6/HcizY4/fOafrcntzQB/BTKvBEcJMmAmz0keQtRpk67bzRQ1m1m0nu19E1keQCTNhJsxO1+X2JukjmHm+Ppg5Lw9mWg0yYSbMhFnhoPPy4C8JM2EmzArftBr8J2EmzIRZ6SPIWg2yPoKs1WCmjyBrNcj6CDJhJsyEWWk1OKKP4DdaDTJhJsyEWeEHrQbZuu3M3C/iCGEmzITZJ/s7LOkKUABjAAAAAElFTkSuQmCC'
}
],
contractAddressERC20: null,
numberOfERC20: 0,
contractAddressNFT: null,
numberOfNFTTokens: 0,
verificationProof: 'pgp:-----BEGIN PGP SIGNATURE-----\n' +
'\n' +
'wsBzBAEBCAAnBYJk7zWZCZBMYqhmfI2WQRYhBC9DyzhpX3ACb/yTq0xiqGZ8\n' +
'jZZBAADwAwgAq/6WjtwRt1aPTLWwtSx80Ng/Wxf97dkpebMXSj9T7f5ia1rM\n' +
'8wqsuNUDMEMPB9LM34f6Q5pD994oeN2YT7z34u20mskiNphZdx/DNvu8w9UZ\n' +
'rI3tyjfZULhARNVM34sSABnHtExbl4ZArhNDsT86ku0sZNjr9frn2mtgmlKN\n' +
'nQdGcLJSxbci0hFg3nE5mYNpwZNs2S/2uk11WHKxzMhII6AdePE77BKPqedu\n' +
'PiXDODO2dIvV8glLQoJPRPgc2ap+/xYIBUFljqHGPU/62VSLlHxBJv72p5s/\n' +
'kOxiqD42TmpaaMtfudqgsZsGoYpZDHcMKYGNZs+9qVRHPRD+s0QhEA==\n' +
'=c6IF\n' +
'-----END PGP SIGNATURE-----\n',
groupImage: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAvklEQVR4AcXBsW2FMBiF0Y8r3GQb6jeBxRauYRpo4yGQkMd4A7kg7Z/GUfSKe8703fKDkTATZsJsrr0RlZSJ9r4RLayMvLmJjnQS1d6IhJkwE2bT13U/DBzp5BN73xgRZsJMmM1HOolqb/yWiWpvjJSUiRZWopIykTATZsJs5g+1N6KSMiO1N/5DmAkzYTa9Lh6MhJkwE2ZzSZlo7xvRwson3txERzqJhJkwE2bT6+JhoKTMJ2pvjAgzYSbMfgDlXixqjH6gRgAAAABJRU5ErkJggg==',
groupName: 'influential_maroon_gamefowl',
groupDescription: 'urgent_brown_butterfly',
isPublic: false,
groupCreator: 'eip155:0x140BE62b2177A975Bbef398DF8934b883E7d13f9',
chatId: '5f769c881ffe328117dea3d3acd0b97ce7f4c163e440f75a96be3e33f7d2a000',
meta: null,
scheduleAt: null,
scheduleEnd: null,
groupType: 'default',
status: null,
rules: {},
eventType: 'update'
}
ParameterTypeRemarks
membersArray<Object>An array containing member objects.
members.walletstringThe wallet address of the member.
members.publicKeystringThe member's public PGP key (if available).
members.isAdminbooleanIndicates whether the member is an admin.
members.imagestringImage associated with the member.
pendingMembersArray<Object>An array containing pending member objects.
pendingMembers.walletstringThe wallet address of the pending member.
pendingMembers.publicKeystringThe pending member's public PGP key (if available).
pendingMembers.isAdminbooleanIndicates whether the pending member is an admin.
pendingMembers.imagestringImage associated with the pending member.
contractAddressERC20string or nullContract address for ERC20 tokens (Used for tokenGating).
numberOfERC20numberThe number of ERC20 tokens associated. (Used for tokenGating).
contractAddressNFTstring or nullContract address for NFT tokens (Used for tokenGating)
numberOfNFTTokensnumberThe number of NFT tokens associated. (Used for tokenGating)
verificationProofstringVerification proof associated with group data.
groupImagestringGroup's image.
groupNamestringThe name of the group.
groupDescriptionstringDescription of the group.
isPublicbooleanIndicates whether the group is public or private.
groupCreatorstringPush Profile DID of the group creator.
chatIdstringUnique chat ID associated with the group.
metaobject or nullAdditional metadata (if available).
scheduleAttimestamp or nullScheduled start time (if available).
scheduleEndtimestamp or nullScheduled end time (if available).
groupTypestringType of the group (default, spaces, live etc).
statusstring or nullStatus information ( active, expired etc)
rulesObjectGroup-specific moderation rules
eventTypestringThe type of event (create, update etc)

Remove participants from group API

// await userAlice.chat.group.remove(chatid, {options?})
const removeAdminFromGroup = await userAlice.chat.group.remove(groupChatId, {
role: 'ADMIN', // 'ADMIN' or 'MEMBER'
accounts: [account1, account2],
});

Remove participants from group parameters

ParamTypeSubtypeDefaultRemarks
chatIdstring--The chatid related to that specific group. chatid are unique identifiers of the group
optionsobject--Configuration for adding participants to group.
-roleADMIN or MEMBER-Role of added participant
-accountsstring[]-Added participant addresses

Note: Parameters in this style are mandatory.

Expected response
Expected response
{
members: [
{
wallet: 'eip155:0x140BE62b2177A975Bbef398DF8934b883E7d13f9',
publicKey: '-----BEGIN PGP PUBLIC KEY BLOCK-----\n' +
'\n' +
'xsBNBGTvNZgBCADeYpZfxgn1HoMUuWM42v8ZWfLPwglQYmzz5rY3PdPPoRFU\n' +
'v0AyPjYKpmLh2ZNfXjPaS9GuMdpXaomYSEwsV02hXZOQelo9cLop0Fc2i+l7\n' +
'70rYhePuOuQ+XD/xYzhngAgNJ9rX96YnSodldb8uJfxYmgoF0E9Z2o2fgZGj\n' +
'll2CPnOaLXZaBQlPS3x/461TmZ1n2ZePS/fwiC7taLz3PtyGtKaC0vo4isvI\n' +
'yf04fkjudG0XIns5CWjdR2HeDC8BzSl8OVj8AQAc5uVU8Abk+ejWVr4zfoox\n' +
'eaziDPgGdkckFiQ6Tdsg0tPwwOpSrCCtJocTmc/fWaBb0YlnyAAL88fJABEB\n' +
'AAHNAMLAigQQAQgAPgWCZO81mAQLCQcICZBMYqhmfI2WQQMVCAoEFgACAQIZ\n' +
'AQKbAwIeARYhBC9DyzhpX3ACb/yTq0xiqGZ8jZZBAACxNQf/UrM/whR7vCs+\n' +
'ez8Y8Hz4WqIuXtfMh4l2nKVv5UUuAfQkBxEY5j6Ga2+JgKU3neQ34x/v6fm9\n' +
'CLcY38Tc4AWyEx8KC78J+xOs7RMfyNBeiaf8KdaFfQrP0nMmufE6TxkfV1Y5\n' +
'LJZZ8350rZVtYJppWtlH+gbyUmMObyWDWbL3aWtqa3xjv0kLsf7TnugiFwzB\n' +
'gHHtk8tlDSOxRt0VdNNd19+/zrBYNl07Ig24WD2ETaJiaqa651z24/6/MkGT\n' +
'MBoQh+679tuWWcTrNi4jIA8jhSQ5BOgbAapl3qXk0m9/Aexpe2s6ISLXe8YJ\n' +
'j4cObDLv/ZKKeLZYTq9lVCydLAQUbs7ATQRk7zWYAQgAmx36uefgUF4cCSYH\n' +
'WMWAOTyc8Awo+hxn6FktOLU1+9hfGrX2jwGLOoOwjNgbYJbiSvRglAX2b57/\n' +
'qkkltAg1ZYCLSUzfBUbbWYlJNBwpv7+52zHaLUZ3gmI5aE48ad+uzaadgpVT\n' +
'VqLbhdgkN6jkemPTlfMehyS49AAbmqeKfo2U72tm9ZqT2cPVCASMjN/Ux2qG\n' +
'3W8HTo0KIVFSbkTthl1zAlwAFksp0q437+pxbdJIecJ9mO6N4OQMnv+hVBDc\n' +
'WrPqBDJ0nas4JNgLxmLv0pheGg/TEfwS/p6xGRW5m08bj2l0cgqmEaM27jbi\n' +
'DEpOykRWsDMhheEfI2zV/Qam8QARAQABwsB2BBgBCAAqBYJk7zWYCZBMYqhm\n' +
'fI2WQQKbDBYhBC9DyzhpX3ACb/yTq0xiqGZ8jZZBAAAnBggA1gkIopr9HJFP\n' +
'fO5SebcbowH4AG9M0qBqF4h1JIKbqvOnxLSsC5QmmzFcjS9ihyHBvzbRVGkC\n' +
'zEHYpLRedQ2AmQQfsf/VOoZJEOlb7tTk4+SpYtsGte5X/yLT5Bkls7Rp8ubK\n' +
'/V99muj1nA/OkasllXQUSGEweVz6ejzJ0oMm3Vewmw8PelsdAnfS7Ud1MnXQ\n' +
'h+O8TCR56F5gAMWxZmxFpZMZyUFOH6KM+vL7HJUBztUS2g0ELsHKy9ep2yhv\n' +
'iABIwx/gEuPr0NDAH9x9XFKg5m3rO64KTY4BRWBISwmQ25dM1s1bwDPLi5XI\n' +
'6Daw1glFxpPRrxgQGlVLzJOu5b8swQ==\n' +
'=9hCc\n' +
'-----END PGP PUBLIC KEY BLOCK-----\n',
isAdmin: true,
image: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAzUlEQVR4AcXBsWlDMRiF0c8XTeAJPIAgoFbgQew1PIbXyKsyhUGtCqM6ZAJX6Z32fykM4hnuObv71++TYJRKlHtji1EqUe6NSJgJM2G2W74/nkzIvfHKKJUZwkyYCbOUe+Odcm/MEGbCTJil2/VMdLx8Eo1S2SL3RnS7nomEmTATZmm//BANKlHujS1GqUT7hRVhJsyEWWLSKJVXcm/MEGbCTJgl/sm9EY1SmTFKJcq9EY1SiYSZMBNm6XE6sHJhJffGOz1OByJhJsyE2R/3lDA4e9QQhAAAAABJRU5ErkJggg=='
}
],
pendingMembers: [
{
wallet: 'eip155:0x119bb8ad40B1f94e2b30ae5f59eeaEB67cD0Bd6C',
publicKey: null,
isAdmin: false,
image: null
},
{
wallet: 'eip155:0x6e0C509d14EbF26A529bf6DC5CC9bee7F5b8DBa4',
publicKey: null,
isAdmin: false,
image: null
},
{
wallet: 'eip155:0xE3FDD0527a9F8418f9a7D9e970452827FbE202FF',
publicKey: '-----BEGIN PGP PUBLIC KEY BLOCK-----\n' +
'\n' +
'xsBNBGTvNZgBCADouo4S2kPqA//+I7nDAk15/LcJ2TGvDhOYuPNUNMiNGOb4\n' +
'txusuKz6HOaG+K9hiUBpHjKrYEmCT2FEXxt8bfS3SpWb74RHSkWUNUkxk25y\n' +
'gE5gaCKyAdcnOUyVLmobVFFYtH6naK9bULaUtkVik1P0iuEevWHxtTpsjbyH\n' +
'bZtNpVTdprdLib4Wx6bb7VogsvjlvNJcVJ4sfPE0XgsQgAGIev7yJyU0DGzt\n' +
'/EbvFX4sv51Kb1dX9ctBcvzVbs9+qT6LTivsrQp+TNHUN4zEeMhnWFFP5K1d\n' +
'H445S6FWk53XvBudcOkFPtltU1MPCS6hmhevArBfYzy5eSlaKA/fH+kFABEB\n' +
'AAHNAMLAigQQAQgAPgWCZO81mAQLCQcICZCrD2gy8Zu4awMVCAoEFgACAQIZ\n' +
'AQKbAwIeARYhBKru9/u8wPcTeHibkasPaDLxm7hrAADa/Af+PbamVg/Ig2S2\n' +
'HgIy4w5x7ulSk1/49+AmuiUMiVUwJSVBhROsyDbLET56w4+1TIMYZFJaczW3\n' +
'8tCvAOUSauzc52I3zwGmaCupBJokIWp7ncPh0B8TFYrgThgXV7sLf3xy4roy\n' +
'y8oFz1Zla88krwtPe4Az7TF+WNdXoDsLNJ3GXRmNqs1GITmDqAXFWncl12NM\n' +
'ajUKWIKc/Gi1oKfz22mabJTtWBimDpA12LaGK3GjEK5CiWXT3Tzlqn6R14EZ\n' +
'6ohpKZldSJiMPL0Bu9iT52iHOsw1wTZNC1L5lKhOCi3c+/fLRcJZt3hdCjqy\n' +
'd/FSCa8/Ny/GrHBWoL49rSF4pDEA+s7ATQRk7zWYAQgAtNOoHCL7BCnjwp8O\n' +
'htTxEI5r7Q/1zKKHiz6QKjjrGBYyR6gcmPM3JNEcvzY4OsCFnKBv2suOgrqH\n' +
'8kXJzfpIQ7u7uJs+O3p/cn86RMANiEnO8NbB/0scpfZ7Vg3eOfoiWYE4I/1o\n' +
'FVDCyZ1YVqtbcmuW6D8i1djjeoUmkUDZyPo7Qs6hUsJeYA/Rfl8mH5sjy2cN\n' +
'WXf8cEtOUqJtwERXt5aRB/nBZiC0bsP6hf0HtAoNA8/96TkqrcQpODW/RckD\n' +
'fo4wkpEONHRH+LGX7GV0pwymHu42TUnULmED6BrMgMYG2sKpxMThxtAxRaiP\n' +
'nZ3DKXr8GCjTYnbEZpoi2zKCOQARAQABwsB2BBgBCAAqBYJk7zWYCZCrD2gy\n' +
'8Zu4awKbDBYhBKru9/u8wPcTeHibkasPaDLxm7hrAADGyQgA5NMUkoyDTPZa\n' +
'Znj1dB+17xBXCZ/u7pPQc1DukBefVke7/qYIicdnnEGIX3Zd7TckFRsDljR/\n' +
'3418Bne4WyL57fAF/GgYsegpJ9n1KT7oPxWzibIaYdj7R6bkDt5r61EDWC3N\n' +
'VBbnZu9cO15TYkObJIiyNvwbQyd6Dm313b39GnEE8sM709TWsI6Es6rRZAfC\n' +
'+sI8ezYxqVUbP7sW3jJZYzdPOhZPHvFd5iJ2EfygEOuk5tb7AimfNwF/CNcB\n' +
'weQGEU7feOSB9lXXA+Ag1duLM4B9bLbbHEQIPhKlBF1ED64e/W/5HNfoAkS4\n' +
'qhzOD5XWs6xs45nnYqUbBFLG9Xk+Jg==\n' +
'=qtAv\n' +
'-----END PGP PUBLIC KEY BLOCK-----\n',
isAdmin: false,
image: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAw0lEQVR4AcXBsXECMRRF0csbdbAZBagHKlJMSOL90IUq2h5UABktLE6/HcizY4/fOafrcntzQB/BTKvBEcJMmAmz0keQtRpk67bzRQ1m1m0nu19E1keQCTNhJsxO1+X2JukjmHm+Ppg5Lw9mWg0yYSbMhFnhoPPy4C8JM2EmzArftBr8J2EmzIRZ6SPIWg2yPoKs1WCmjyBrNcj6CDJhJsyEWWk1OKKP4DdaDTJhJsyEWeEHrQbZuu3M3C/iCGEmzITZJ/s7LOkKUABjAAAAAElFTkSuQmCC'
}
],
contractAddressERC20: null,
numberOfERC20: 0,
contractAddressNFT: null,
numberOfNFTTokens: 0,
verificationProof: 'pgp:-----BEGIN PGP SIGNATURE-----\n' +
'\n' +
'wsBzBAEBCAAnBYJk7zWZCZBMYqhmfI2WQRYhBC9DyzhpX3ACb/yTq0xiqGZ8\n' +
'jZZBAADwAwgAq/6WjtwRt1aPTLWwtSx80Ng/Wxf97dkpebMXSj9T7f5ia1rM\n' +
'8wqsuNUDMEMPB9LM34f6Q5pD994oeN2YT7z34u20mskiNphZdx/DNvu8w9UZ\n' +
'rI3tyjfZULhARNVM34sSABnHtExbl4ZArhNDsT86ku0sZNjr9frn2mtgmlKN\n' +
'nQdGcLJSxbci0hFg3nE5mYNpwZNs2S/2uk11WHKxzMhII6AdePE77BKPqedu\n' +
'PiXDODO2dIvV8glLQoJPRPgc2ap+/xYIBUFljqHGPU/62VSLlHxBJv72p5s/\n' +
'kOxiqD42TmpaaMtfudqgsZsGoYpZDHcMKYGNZs+9qVRHPRD+s0QhEA==\n' +
'=c6IF\n' +
'-----END PGP SIGNATURE-----\n',
groupImage: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAvklEQVR4AcXBsW2FMBiF0Y8r3GQb6jeBxRauYRpo4yGQkMd4A7kg7Z/GUfSKe8703fKDkTATZsJsrr0RlZSJ9r4RLayMvLmJjnQS1d6IhJkwE2bT13U/DBzp5BN73xgRZsJMmM1HOolqb/yWiWpvjJSUiRZWopIykTATZsJs5g+1N6KSMiO1N/5DmAkzYTa9Lh6MhJkwE2ZzSZlo7xvRwson3txERzqJhJkwE2bT6+JhoKTMJ2pvjAgzYSbMfgDlXixqjH6gRgAAAABJRU5ErkJggg==',
groupName: 'influential_maroon_gamefowl',
groupDescription: 'urgent_brown_butterfly',
isPublic: false,
groupCreator: 'eip155:0x140BE62b2177A975Bbef398DF8934b883E7d13f9',
chatId: '5f769c881ffe328117dea3d3acd0b97ce7f4c163e440f75a96be3e33f7d2a000',
meta: null,
scheduleAt: null,
scheduleEnd: null,
groupType: 'default',
status: null,
rules: {},
eventType: 'update'
}
ParameterTypeRemarks
membersArray<Object>An array containing member objects.
members.walletstringThe wallet address of the member.
members.publicKeystringThe member's public PGP key (if available).
members.isAdminbooleanIndicates whether the member is an admin.
members.imagestringImage associated with the member.
pendingMembersArray<Object>An array containing pending member objects.
pendingMembers.walletstringThe wallet address of the pending member.
pendingMembers.publicKeystringThe pending member's public PGP key (if available).
pendingMembers.isAdminbooleanIndicates whether the pending member is an admin.
pendingMembers.imagestringImage associated with the pending member.
contractAddressERC20string or nullContract address for ERC20 tokens (Used for tokenGating).
numberOfERC20numberThe number of ERC20 tokens associated. (Used for tokenGating).
contractAddressNFTstring or nullContract address for NFT tokens (Used for tokenGating)
numberOfNFTTokensnumberThe number of NFT tokens associated. (Used for tokenGating)
verificationProofstringVerification proof associated with group data.
groupImagestringGroup's image.
groupNamestringThe name of the group.
groupDescriptionstringDescription of the group.
isPublicbooleanIndicates whether the group is public or private.
groupCreatorstringPush Profile DID of the group creator.
chatIdstringUnique chat ID associated with the group.
metaobject or nullAdditional metadata (if available).
scheduleAttimestamp or nullScheduled start time (if available).
scheduleEndtimestamp or nullScheduled end time (if available).
groupTypestringType of the group (default, spaces, live etc).
statusstring or nullStatus information ( active, expired etc)
rulesObjectGroup-specific moderation rules
eventTypestringThe type of event (create, update etc)

Fetch Participants of a Group

// await userAlice.chat.group.participants.list(chatid, {options?})
const getAllParticipants = await userAlice.chat.group.participants.list(
groupChatId,
{
page: 1,
limit: 20,
filter: {
role: 'admin', // or member or depending on what you're filtering fo
pending: false, // true or false
},
}
);

Fetch Participants of a Group parameters

ParamTypeSubtypeDefaultRemarks
chatIdstring--The chatid related to that specific group. chatid are unique identifiers of the group
optionsobject--Optional Configuration for fetching participants of a group.
-options.pagenumber1The page number for pagination.
-options.limitnumber10The maximum number of items to retrieve per page.
-options.filter.roleadmin or member-Filters participants based on their role within the group. Use admin to fetch only admins, or member for regular members of the group.
-options.filter.pendingboolean-Set to true to include participants who have been invited but haven't joined yet. false returns only current members.

Note: Parameters in this style are mandatory.

Expected response
Expected response
{
members: [
{
address: 'eip155:0xb44a29524433dBC639C35124459c741bC241d4f4',
intent: true,
role: 'admin',
userInfo: {
did: 'eip155:0xb44a29524433dBC639C35124459c741bC241d4f4',
wallets: 'eip155:0xb44a29524433dBC639C35124459c741bC241d4f4',
publicKey:
'-----BEGIN PGP PUBLIC KEY BLOCK-----\n\nxsBNBGQX78kBCAC5qhWJ2ZytwBxVa5AQLxgxzcNiS29DV820sYKyeN2vaFc5\nqznkM4V/teJ3xKjEtFdfZaQjZJ6ybd1pQX6h6MjlFWXvzgEQbaWsaIzGWz43\nrwNCiR18Y2Hp2zce1BRlDLSW0jaiNTXeuMjE/Q7fLr1RtxMvAmjxt49NXUTg\n+xvZZdwHpdvt1ihDUtUdrQSxzn8IsgE2LoCzMv9kjFkAltfHD9T7r3Rk4D2M\nvGzXM6QOzAkYNs3nZb0WRDjPpJKtCn0Et0Tq/oGayRnu/r/GHTdXqLLoQ6Zu\nc6m+rrCHwm11/ngrBwC5bnaZBjDLL9ooYzpxOS5WMMKsQ4+cC7wIEA75ABEB\nAAHNAMLAigQQAQgAPgWCZBfvyQQLCQcICZAHUaFDocEjzwMVCAoEFgACAQIZ\nAQKbAwIeARYhBKi8PuksO7F6gelIrAdRoUOhwSPPAACPAQgAguR5QcGH/Vos\nXGDgoDpjR2okfW12U6Cbwa+K4Ns/BoQdgpAi4bkMzyKvbVzyoz5BaNMhQKWv\nUzha7SsrhbZKkZdblOvuercAGYt4sx2H1ih1T/oIZHIugDWWzn8OpE7f40wL\nCVI+qfREQM0ZCBSbEF3dWvcJKFm2YCdK+gHK6D6TCwEw1hukJdEzEpZ/aH4r\nDBWZe3ph7H8jiMqxj3OhTS8sc88Z7HeG7sO+UpLOYHKNANj0YlyGvV1Tgukm\nSZHS0reJrCg597bMnqUV683JxitFRnF2PASMWqFaj3QtPCOuQsRwV6PPV144\nzQk3lF/ojJ1+8GxVdBUMHqCTyyAEPc7ATQRkF+/JAQgAuQPAuY1V+xsNsT8C\n9eBn7p8Vy2vrGXDEaxAOy7e6V9KEBgEJNW5F748SMCkob2YIaKVXMF/TOAde\neP0HBn8wsuVnmDF2o1kD2qcIiPj0G1M0G4plTTmEBtezXQD15fPAajWlMXS0\nqTjUjuCs2x8ogMXZjGMt2kZZpxP3v2EWmOpcAwTe/0dX8GALOl9MX5eXKiau\nuJde3jLOrYdTDt9NduLGd/UVr3BOu5KJWFOulL5G0s6LsWnY98Jq8wkTyrTJ\n9GQ8VKp104WTfY1+YBI/GwyQEhZ7+3psTO7nCeWTEwSOe8aIQOqcky9MMLp9\nlZF1d0nVriEyuh2mQrab3IpyZQARAQABwsB2BBgBCAAqBYJkF+/JCZAHUaFD\nocEjzwKbDBYhBKi8PuksO7F6gelIrAdRoUOhwSPPAADoIggAsuvY5AGzNXTt\nJkxKvEZX0Ch1U6n8QkLiqhN+QUPhB9Gi+8IWiA+G5kfCD7ClYn/VaGEmpY1W\n3AKcNZQWSuCZSrCGIfk83LoSMt2/ODEvmpaLkdYjByoPYHEuEp31ZBOFjUyQ\nJpQEUy64Ycffo+MRDDVY10phYGqeoElR3ROmlIuobbqufU4VLXmu2CJoBdDJ\nGpLOTUcBp2VAEVMocIk0mojgyHwMTbegU24AD7IOn52jpwyAhUnP826Ux0VV\nVes1QaKHzcdrusCR1ebdUNNM+d+vVfhD6/uVLpYiSLbSJ8iVVf2NJGMFittk\nrmLd4sbgjmxy3d21SqL/B+pqQyfqkA==\n=p+iN\n-----END PGP PUBLIC KEY BLOCK-----\n',
encryptedPrivateKey:
'{"ciphertext":"840c20a56848c4e8179f6da2893f3551bd271babf8642eb64a75f24388838d9eaadaebc4ccab17dc634716e666f0b975431fed70bbc71c146df02e966f1b342b6c91300c14044edf02ed5f77f668c48d540bd184cab55783bd7be2e52298b367446eb21bf9e1b4ae004b6077681e33a808650a34b775453140ea720f4696addf5bfec3d552704c0e0456bc943cad18bc7e934081e9a81e62bc0525e378db6af3d4fa9ae22c205a4caa5e47fb49f4832b67d25961b9ee1fd9bfaf49baa2ca1f39dc44046aa78e79014055420c5fb614c01875f9da59e25feeb39e6bad12d5522d18e656a0c213be6771730354b01ae170dcd646e81d13984acec13472e57268cd40458b1fdda863876bcdb716160e2eb895ddac34d0462db92539caf8587d2381a3bb6080d116ce477fea55ead71cd0dfd1cf8cb2e3e2ef18b809f4a5947f380c78fac57a3948cce26f51f7bc17b0df1fea78096402c9054e5b3a6a80010224e1014e58b6515cb260baaaffdd8b4102952a9040d532f3b058799b68b90a47442b258ac33d84ab1bf0c792af4ae1bc601cc6dc9d735448d2b91f12574f2312b55a3b303f91e16c3dce6e1357c4f59612f0a3d7f737e583ddbc44ed7306ebe132be4197d2c3fae7099f4bd0d51e38c8fadf18d561559d8ce5b72b6ffd27b13b92e37ca7bc5ddd380df001c5456b76e70502c5f046902cd6d404df3ce80871984237f54a1257f89e9d5d203a70094580e4473bb360a9e412933f784d4b90fab415b84bb63e1354657d18ca1f035dc14d52d2e118ab3d8bd75157216d3b85a928bcf6dbb183e46e74a42d7e87a0d5e84893059542f9e64b1a77b03424e661338a75da3bd67f485124fbfdcc6b7d56dd98d8dbdd253d77fbdcc4a87bf01cac26dc527b3002d0f28616b74dbe11b71d4648da208c5f245beb7a715f68dd62ce627e7ec825fac0480325eeca5e02a1f917f0afce1a442a26fd6020fa5bc996ce430480d021c036707f62c82442cb0fd1be1fcd23db929ebbd985edf8ba724747c6390bcc2ddc6f5a4327b298ede0c2fbb682c561f65f443ea9d5afaea0c4cf8d099fe06f4a231fcc0aa0475e1e851c1cda053c07e106ad50684a881335ff75affd62a119bb0ec6f750db1e6bf64739eac73f66dcf0196bdab4158868f4ecce790d3b7529253b02ec75ff72f93a6929986aa4b6c36e84b23d202ffb37aa59fb56a56b7c717653e8df45b1c8f3fa67340ffee3b1fa1fbf32564671440ba1eed22518f0971dafa781a5d030cfcc5832790a6ba1a4efb9eab9fb5cbfdbb6ba8abe4861f909fe3cb4758b0ee1a8786e3d89e37dc9c79763e361cb58c090c2a8c02bbb4a8b65d017c368b4d32294c70d56eed843f60e0926def662de8d8de011f00469ca56c5295a82cc2da136831f5e7a5d86c6e80176a40c73ff8c74a7c16af293721d7af1641d781f6e87e9fd511d7d772d2f719c6e6f79ac99c76d5eb66e1816c6b54d0e675232a18edcc15234a9992d99877f2c6ee8a9063a8e6e12cacd1c20172e88ef2fd4d942767aaef57edd48dca4c4321709ec8adcb97f7fc5a11d16052d23c3390c72eeb64d9819dbc952d4c6242374ed56e708f18ffa1fab1acca69ac111f52a4883a334900beefe39432eb3df4dac5dd59eddd97a32c48a4cabb32da215280c0ffdd130ee4e692272a92ded8775a13ce4268227fcd6eb252c641149f7ef9753b75b09abbb4eb252a6e6079a02e075af64c9312aabcba5d44031abb81776849a5a305bce21979ecf5b75be1767ce9c15d6f1276d35058315ebc0537802bd6c24bcb813dc5748747f69332ca6bacfa975775048daf8ffcac54229141d7d87fa08428c6905b876d7f42ebc37e761f9d0cdd207d45c4ad6ee55b70a14336c87221ff9a1feebc2ed97530bb39397094ec5572dd75f0d011bbded0343f97b8137cd491e736aabb3e832d0a61a277bbc83d32b5f9df1b975632212a22c596e2417b5a8700c09d7dfe27a3adf72e692b1193279a58673988792e5ed96f5bcce00c876aedc699f7f5a900fb225f5e5ffbb4cb137182f78e8ca77628c2883650a2504f99d8f894bc92bfd74f72d5bcdced81b6ed711c20ddc3b46114d3f687c64048c0230feed459f9aabebd7e5da2cfb0d6e4d53e5396c50e276d5059dc6d50f3930cf3a5cbf6340febfb7e1eccfed57e9666f4e58847b5a47126f09297f4b35ddb2e38a64c691f402f01554f1316e2b86368d1868228b981774a0d2a6f3b24ec2ae92ea425fd86a325dc0dd0d4173cc56cc1977651694eabdb8bf8b457c6f349debe58306c5afa50ad28cc5f4ba425b9df18c4ec3febb5e251ae6785a1b782a202c225dbee33cdd10e7005ae1715f23acc46e5134bbf3f54c11cfddb7f6df59b82b9ddd5122031facdc1a4df2db0733905f8156d2592be7255a37824fccb0cde5e7d29bb0f9ffa0d1fe6877e68e3e7c1afc9199a2110ad65a9f36a10ddf0375a3fd484d2b2bae18b982c3821e917f51669d30e1bdb3f96f2dd87a699eb6c2c50f32a105114d674f5bd1dc359d4309c0f2ea6aec5d1f52302b3308d3c00554cbec3515c2f459720dc2ea09467b9a3177c6268b89bb791a91745465fcb56ef4fd0b187ddbf4743b8d527374303d73df303ad17fe104371daa7d89b1d48030875b9471889667f70ddde1e45a7a4164e433f5af4f1a0e8f8e3645ced45fc1a4a5637b2ae1435b37b3c496fc4b11a661dc31fa504850f00f9551ba370187177b2eff767c0a438271c747fa5bf32e3b9fdb7bf82bc299000aa1f84fc4ddf341fdb6e8b93aad82c8f1537d567535ac29ce4e0626188008deb7aec4b28d79bc2bafaecb24dfc1d74ee3b5c99416ded16710df235bb4a36608ded4cd98464f30208752818fe02332dbd3c745a61b704132d348129cbc974e6fefd6bdcbfd1931251f57c15f53104b68b8e3efbff32b86bea3e57b3b64308109a1c2e0d8ee775b439e295018d19202bf4f614c74304dbb5505ccac446ab08ea52d44141bd285d76cf4f26a9bb81e42e6856e02d04538e45dcd4adbe582bc14a7d4ce52e791986a9ce1edd2d845cd9d505bb704e1cdb16bbcccd19ab4f4e66b885d8e6f51272e57bb27c49ece675fb64406eb13af77c2cfc170490bb1ced51580f488bf3b1b89562244b81f7a30538ea0a942f414c7ca3dab6105ca71e54afa196885b8ee59754bdcaeb8f02f8b24dd434697e7b3e7e12e2f1767d7f03cdf630fe109bea57ea587fb0c9b2e8218f70c721d359d18b6c1ba0828530a9f0446d582a6f7f58cf4f777b851785d3f92d2bdff96d2e8555cec169a8165166b2b610d9cf8be2a380963d4d0fbd638c15181e413780d7f248fe995d2ff94e1da24e5a583b006ebb5eaf5ba09b79150f12abbdf4bf71eaab5db06b6891eb35e23c3bf2929b70bebca59671f0c983e621da2f76299a3a588a11adf27f47d5ea4829c681dfabafe73d1038da5892b6ddb068ea564de7c951e1bd356f16f83dcb383978a905036c4492e37a98eece11764d2eb93ce879ca8e1f97429d57dae6bcda06aaef6d82beaaa50080886c2d005ea5fd712c1a133892e8645f410a160cf19300984b2f76bcaabc4c6026ee3a98901bf44940e89514b757a9a37775e5fce4c3ed009a3f2a461ccce1efdfa7c6b59c00563761b907f41bf6f1062f63bc0208bd86c55db3da24b9586df67a7b9c8b9ccea87aa79027da1df64f16ac382c52a0ebc6f952b6dc440e497e518d53b1050b52869823837100756a979dd96595f8e345d092848e5426494c5ec0844ea547970fe9bf5607d0facb1b9218c472c75df136c5ae54c2a0de32c7379abeb37e4b03191a6f25dd7a723d031e5c2c5b77c313b3b665252adb2bd52f370471247ca7ac79412c39acb92cb21290d145c62810128773189712a9280f3d6e21e78d24445928eaa3b30bca68507079c6a40deb09bc17ce45fd32c361f445a28b7e3a1f956ddd755f9569373586c3354b356e7f6de73c1c2b4be1d387897987cd5fc5fca71f9dcaec9be7d261b070e143e42815fe0e6180075c0a5abdd5bfab213f6c27d5abf82e80701d9086573eada357c78e4b87f8bf19958de1363f0864a8af72029e5522340d9b8a9176439153427b8641917a3f33a9f6f570acc90199ac3214386dfcb7d468311c05bc31fe7ffdd8a02f4ac723b2b4ada9cbf3be319fc780903dc73745ca21c49c7c9eb13939a5cf104436a52647994fffc3cc86f1f5a9c1c200a4f77b47b1b6b7edb55a783690bb42d71ab426ae4028bbea3bd5f602dd5f1aa5d56ffdc1a0ad29b9e954667ccae879c4af2f615edd2db1fb98871318ec6eed598f38fd34d181c878fd9dc9f219c36b2c99231538d9b17456b6776da8f7f003b8ef7a328ce24f05fc9ae649b1f89d8d564ff50763e3c91a753c691ee55fba45e40303cea2e7006decee504c56dc052e5a0425fab17d3e894635487b3c68ad7174b51c7ae543e1c5f6a165ac022f06f5a373514c5e3e81b9099ec97dfb31a58a786822db25f42ea1443030b2ab9d36aabea2031186f570382db348a734ec0c2631b348f0baeb6795b8520838523c68ec735f4d047d443c77ba9cae7583688e2e406f5bf59312b2bb3083e9c0b81ef08c0be36716e88fa91967d2d5adc3b88115222c0a651481134ee9d5f6fb42f3403020753042c9fe8b832f8a4b4711a1cf3ce536e99aa0e2d21ffddde2b059db9afd6e094c3f659428a62d77590a8b6795017cd510b06de4bcb839ae71eded36532c773fa554d888a0b824a62fa6e7411b81acbd5e0a64eefcf2c587d2153fe039fb2fe5a1fbd16f1b17f16ab757adb404581b13e2efb48ae0a1dc75fb9beaa2401b4569c924d40ec8f59b76674e4feac53327cdfb8d59a9ab46e848c6d163899befd508ab57557a844a3ac80a77f8cb3ff905b","version":"eip191-aes256-gcm-hkdf-sha256","salt":"078c53bc6f1945b3317516e5a5ecfa87ee6a5825b1bf829b4f4c727e265ec819","nonce":"6699c2dcc81f2f105d83336b","preKey":"0f8f03852f0ad3f6f0bc4385c6efb12774ff9631b7f4dadd1f85577197621922"}',
verificationProof:
'eip191:0x4d0715e3c887bc553e3b2c0315bb9e9c0bf04ca43b21194f713bc3cdda2012126d18303814842b76e36aeb2ca543f071e806aafaba40124728301e661821b0b11b',
msgSent: 17,
maxMsgPersisted: 100,
profile: {
name: 'siddesh.blockchain',
desc: null,
picture:
'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAy0lEQVR4AcXBoW0DQRCG0c+TJabu4soxWnrS8qAtY1sY6eigK8ctBJkaJnR8YKVTEv3vXT6/Pr5Jwgf/qbZOZogZYoZYCR9ktXWy8MFv1NbJwgeZIWaIGWKFg21fyNbWycIHM7V1sm1fyK68M8QMMUOscLDeH2Thg+x1c2bCB9naOlk4bwwxQ8wQK5y03h/MhHOKIWaIGWKFg/DBXwofzBhihpghVmrrnBE+mKmtc4YhZogZYmXbF7LrszFTW2cmfDDzujmZIWaIGWI/VjkwD8EMoAoAAAAASUVORK5CYII=',
blockedUsersList: [],
profileVerificationProof:
'pgpv2:-----BEGIN PGP SIGNATURE-----\n\nwsBzBAEBCAAnBYJlqWBACZAHUaFDocEjzxYhBKi8PuksO7F6gelIrAdRoUOh\nwSPPAAD7rQf9H2pluOBvzXTxHUl/LZQzT4QriV4xXR0AbQyXTssQmxhsFXES\ncW2X0UX82HifFoaxbrxoLPyL8+BsFOmoSnhHWdJONqTKTHRWFMBQR7mX+LCZ\nrr/XE5KwBODi+8789f4AbhlEunaDXUQNgIoNQJfMO6127PhUwhLAcSQhWZai\nNZEduOWD8SenU1nDHPxdFTA93koSe1l31/oz+Da4hwbQAdGvfql8p3FrJdrp\nVAG/IEVxOHfSta1w74m8LLQ2aKOFAPMIzPtAgKfRQxCmpqjIZT2OofAPO9+A\ngS147kRY1kFYiZr70vTQtB5klfyKLiVpE8GqwP01fpI0zypSAsWfvQ==\n=5hHv\n-----END PGP SIGNATURE-----\n',
},
origin: null,
},
},
{
address: 'eip155:0x1A3cDE21e27CA9a2670C2c647550D39a72d9637C',
intent: true,
role: 'admin',
userInfo: {
did: 'eip155:0x1A3cDE21e27CA9a2670C2c647550D39a72d9637C',
wallets: 'eip155:0x1A3cDE21e27CA9a2670C2c647550D39a72d9637C',
publicKey:
'-----BEGIN PGP PUBLIC KEY BLOCK-----\n\nxsBNBGNjVOUBCACJiL3Ujyngs2WED2trgkwIvg5pfksN2hDcnHI/u5VWCJC9\ntM6Eu1KPuspD5LgTmMKPg8qjyGPzai8FS1udwPGCC1K9ZbnvcqzHUrCg1T9z\nGd938mlzBVb3asDmrZgXYpwnZeqRFMTh1UuLmUztEeoVafi3iElF/nRE6m2G\nz6K6Xqd31ixVYkBqPkrBQwNBQg6K97da1XLBrCGyPeqqQ/AgRAqJXrjWRiPO\nXvluWuWcnJGR1tRe1rxe2hR3pD4SdiFnYgPknLBEpTBLAoTY8mhwof6RLXcE\nmnW0r1g4vuxhr2jEA6H0fFOHyFt8NAYQ/MX/JxFQPbctSe1RKgWqG1bhABEB\nAAHNAMLAigQQAQgAPgUCY2NU5QQLCQcICRAQ+CT44JXXewMVCAoEFgACAQIZ\nAQIbAwIeARYhBLkckYLs32NvtQ3xnxD4JPjgldd7AABLzggAhe8nkuIrBB5Z\n1xQ0+4gvwUp81OU1GAxmO/TTDJlR2M1csHhxi802NCqV5lJc9Y242KFxrVJJ\nuiTVjE42cJZof4QdTuMjR/6ryi6vc2N19iE2wqcnEYrfpbdeSRqSkRYpiCNZ\nFAgTgcmajsi/m+VO3ydk6/xVajwy5e4k3c9dgNPv7CMwvv0UI11BsYRODiQQ\n8DabqZjFbPmfcVFchU89IRLOsGfZugrt145jLa5P5rtRviu/JjmtNmPNPxp2\nHBSsWEit1cScj4dnOOhbzQ9mr8PrfGogDlTVjYzR6si5dHcsvQdUIXb0ABNs\n4qz7N5ARgs7E4CzTwSMtruBfq+NQ5M7ATQRjY1TlAQgAzoiWfiufIZmm6w8V\n1X9Sjb7cBpAzA2U+nEiar7JxzAEmoMpq4AZ82JxA/2et8kecmWfaO+iz6C66\nWAa93z9OdBknJxDxciHxKEd4WjIwwcXjEEAk4MAzG+J/ZCyb5qYL+fRXaq24\n7tDUBtzND2uFqEqVRc1vfh90aRuO7GX4Zu1SX5YTztuXUlYEoV6HXE9F7xPe\nF9+RqudLFPnM0nSzJ6TwLfTP918KXCajRCbG4Qiz3X+NEM0k20wneg+D+PQG\nL9Z2uyLOOEIv38RLCfvBuPyqxZs/gPdxMOXP0xEUC1eOgi5CK7rG3zWnVR9W\netLS8RoZX2FzNnpOMKRz4VKLMQARAQABwsB2BBgBCAAqBQJjY1TlCRAQ+CT4\n4JXXewIbDBYhBLkckYLs32NvtQ3xnxD4JPjgldd7AABGTAf/Xi//wrNbZy+g\nF+trW1ZGm42HE/RLNuFa2QAzbr5e2tGacTM9AM6eScFLLsLOKRzFj3OO4FHY\nUnN0/wPAxTaidJvS74cX+49kYKFUekESo6MmiTI+CeyNYNHV3QkmA1aCaCpg\n8yH3eaPzSwzXpky7Nxs9Bf4ljz08Z4ZLc/bHcw9riBB/LGRL2rWihLAVxCF0\nFmu/dEri/QnyQuqRE7p7B+VNgghxvMI11sFdsdCysl+1kgbW9GH2fd+TuCqb\nv4hJZ8m9LP5XoVF0jbYzCZ9TKwVoAiSewzUWMrwlLNa82QDwve4wB4c5whok\ndw7nYxycnMhwuyjiT+XuLVh1s5tTbg==\n=2YFx\n-----END PGP PUBLIC KEY BLOCK-----\n',
encryptedPrivateKey:
'{"ciphertext":"d4d20369b584e95fcf88f05ee65ba42240b7d50b92db2c0a72fe9af8af595cbeaf47057cf95483bf50aa50cdd06a9f645deeae9e8384632d7dadb07fd23948d9efc35cfe7129fabe968cc756a18411829244401cbcf7fe4be1779a610d322dc1d6871c84a4e1b553e9d10a035c9f31d60c478faee06b669f3e9d37d9284968d6129a5e623aa02d4c422f54302d72fc66ae384606570ed31a61ffbab4599db19a3bffcc1ed595d3ed9fe2518e2e8872e09d3dd99a0578948f36817257f31a1114c73326f32db19f688c9791520649644d366d34f5c5d673a134044cc3f7a87189c9dfa635b12b6378f57d817f397517687dc13315979174abe967f1060d5becd1dd7a3af61b4d73a0032e9bcd72acc2d82b0a9311740c159522d496ee558ae6582172c54b3b145df30d9a23958ae29395126f51e7e2e2da9b401a53e015b9f3e0c0411b84a40df729a743f8cd2dc3a35c87fa9f02d5f5b92c9d02b4ef6044b6e75130723a541843d45d1b92b2f2283e651672f69fec5a3ac034d3cb5b2ffd748075388eccc31ea28f0b2ae02e96c86781620356d294ad5fcf28de296c2e70ff239eb70565d746f350609b662df6cb00e8c9e46b1c3807c0e23aa67d45973b12fbf088eb8497d5e2b7bad82e92beafdb4a09f95b53a323693217d5c9724ad9d26f45d616c078a73b9831b5478192c99cc42f160eb364706a739282296a9c2ec4ac95fd932a50053c64c02ec1f710205609e202cf5f10a0a68d943aae10b1316028fbf00302174a656f77317a51b7fa147cca815e9282926c5660d2c65a54fd6cf530c6bde673c5fdb48d0e008e2339d0c77a91b349376240ced5c9726b073f4d0a7b60fa0510b514aed3a5d508afeede79d3d20aff7794ec207c79d6581e28d8cc8c5a6f692034ee5f23646ee1d8f8e49f0c86fb30572f61d4de2cf840d06eb0c71376d11d022862a55090182953cd9ef75ae3874b76b2137cd7b6b72d372523557b3203cace09740824326aadb24602ead7f3f2d9481acac049bc4d8e6572330b8a1c503c26503dbdf8d5d233c3cb1f8f4f8bf70943dcce3f83f5ce417bfbcc1ae663c3bf3ea50b2212b4906715e0ab19a7e83083ceed87fc02261847255274effbc475ad548dd8d45bf163b90270dce341a5b8cb6dcfdf9b09f475f30df9a9cea6bf4d3d4ee193fa223cd9f159334418f85c821cec78a252e7aa0f7104061f2a329f6ccb07be4072ca1789c1688760571d4d4232d2679a7d783885edee6d6eeb53add6068b4461f229dc34c8f402a666a7caf99ad3a36a75e57b2049b0d4454fca9a516a610aebbd1bc70d8d5201dc5a037e46158485751b2c3aa161292759b95476655269137e3b8d16046cbeea9af3e79f44cb48e904c9c7a598defef3b409f401c6a9c7521c06d0c31a5d2d9ed49c7828f52930dcb568e5210eafee47f5d428baab607fdc0dec955ef78c3e5c2c6813b761eab28df76f4463bb6ae90009a0678123a9be5588d88464ffef69585c10da01d7925a6cf85bac0a6938323084ecf1d4d80f4114eb12821b5c786bd2999c4b99b7dd6b1e462f45b988158b8d48be9959f6b25986bf8960e6616ceac7132a5bf56ac9bb6f7c2f0b6a948edceb28ea6ab9d85e5dd93b672e8e95438a1c5b1c5ab4ddb691040e2799af66d5bd6ac2fba551fdf2ab0ad5e72742e053513f73d98abfeed3358aff120fd1cfa5dfd286d9a43ca0b5b8b0d1e3b90613909e2a4dd2727f8c68f9fee1d55958284b59912e493d17b3d4595f2c576b93811e5285ca0bde40ce7a0ab3f2e16b6ba162cc348f153877e31cf7cdfb0b4e900af2827c6ddf728588043807e7ce9b5975b7de49cbd53c2c581b17243b034d9eeaee33206ed5d688dfcf27e527bd33b77d66158975277a62f94b2236dbd41e762a6fbcdde9a49086ce6f58748c88dff09e6fdddc940734770f3b273d067cab0eb933b3193d6d51c5837fa00d4ed6446b362ff312dd8e008c47387c19e284e2ef3230f811a775159778aa8f80be027cf11fad85ad00a9d7400db6b87ecbd4e1b1adb0670e9c82457e962254fbbca8159071824dad65d8f9e8eb7eb916fde7279ce4321a59b92a0be11afc0df8c7c8b67b2c73dbc9e45cd70137d0decfe91e2dcb6e9d5cbaf5a450e69ffe9abcf969be1efbae586a48e30c3a1bafdf8d6e4de5a5d0a96c60794898f0d93e7f4e1738cecc2791834f9124a59340959e4820a705547342d1d188d94a1104dfe4618d761f903f7a4e08d815437a78208b1ef3b232bab4e385e50d12c82165920816c2bb5697f9eaf7e96d7cb7bc44494660714ac756a088ca9d3132083ee97e54c852faaf00e2e0bebd99e96552c027b5ccc4f0ea65167cd33c57cd6526658db35bc62d206094ab964a8f1335391a9ceb2137a209d17530037ec73bb261ca4ffdf9495211b01b685816c997afa6acdf53cf983cacdff743d299a25fb2c8233d8880e4bfd24162a42e29da9596bcab8609526e3aa4a414089ff8a40c38cf79ae351ca64a510e432f6f9bd4868888e277d7417e2f2704697b44e0e9728dc70953fbe8e1e00f30a9a2d02828a427015c41f6fbe263be25e26a4d6ae7ca2919c330474d245f9b786fa0819cd96770397792e99057b00262ab397622526a337b1ed375931d9f0bc073b8f28759f181e7c6a3827032f648b4cad19be66ed4a52508d9537e51cf70c78c68c2121c7c876d9987449d521e1db76bf3f658f54e24a558e224d44006bbc4bbe2a072912f9746ed2ab8c4aa65cd5ce80b88072194f2d41aafbd5e1c4629dc22fba2f039809843bfea9c0143bc8aebe65b1f41a5e3e4a6fedb1040c8f057cd3d27be62706d8a3f84ccf0e7187d273b1adf92626034d7f09a9a8fad43c92808f5f2ceb031f2356f2bd02b52b245acde4d8d4949277f8d865e89d7a67fd2d910fd9c01f91db18f8aadae42880904858e6c08d72693aa77bf735430095979b6df30c77732efb31f36eec12f93f4fda0abede73a1b6948ef861c7f97b2936c7b7307e1d1581b14e9efa22743eae13f2996861f6c493e07e7a4c456e2426ea6c2347c660f89c4c8f5909248b94c695d53e69d3117c55564997083647b86a467835a1fe20f34abb0ada2d18cacb6742a9b29532a9295efa86c38140c2f9902133ccbd970ff44c7cd352a267ac5f95c9ed189d94746a57ed650e3c1747c099a25b1fa6186fbc65089809f8b21b11678f9cb24eb86d0a30e1507ef4cd48ed422504acd9ee0b23d70811b79f7d95943ec79ce701d8fb33819206df5b0ab10154003c84899d882b7378a6402d488c389c2fee80b6a9dd519545f848816655a9a00c90ec287bc4fd79aca024fcdf951821e85a3bc252e333822946b73a8d467828d89466e5b116357f9d82e5107f36e2b5690f6e4af6c3a2881749d4582c4a5ffafc4eab59fa59399f7cd527a160ad476ad56fdd1fecf06bf499152f2190073fd6f786e503c049e3b03a3fcbd1c08400e66cd48ceb30c1d352007247bb00c39fc2532c502a3e13f79cb35be778712403cbe0898f0c57cc1fa83692d80ed365c226697d561b1a74584c27945a965f2b867f2d4b0246bc21e26ef5b6739087f03fae6fd2a0fffa143a1eef988483f24b12490b8ad50599ac0aa120fbf75106198b3ac63a0a44add176a8c35b8b713453ef061c9fe5e3d08fcd72376b2367e02325c8cb8d9e9e3ddc22863dfac63b2b96a3758eb745810b3b9353332f0a036eeb391a159ba7259c8522c0b0b5ae203b1d06d259b6b64612c6737743761f98032725a3ecf8cb710880dc3ce063b5db8be96272cd7116c6726ba5a32d1dd7bc4013a9a1367cf582511748972b4831c825584e280f885566d0e54e332a36ba22d3fdb59ec15b82baab06273d412ff2cff39f3410ddb3444d8e4a9ccba84cf572253a1925348addd533c5684f7ef1157bfb0659aa9f400389348b2a568a73f67895936dcb35d35a28b6f2413cd0998fed80a8e51bc6a71c175ca544340b5a87634ca8370642079346d70841451b47a35972ae9846b6dcf5567790240f2de7e5ad3307ea314aff5d56de633eafc8afe35e2b321847aa68fc44a3cf3e77a3f9abb0a10ed1a9fc59aed2d74f970ac570718d2a664924a56984cf09747348c79ec7595f9c5635fdfc62435bd3abcd8d80454fa194e6137ef67bfd2b6fa6c6aa7ddceb2e51dfc7b3d3c4356921214a2a5713d8bf957649cd41a199c0651cd9427cfb874568fda99b81ed25a59023ff882ecc9f08bb85b5212fc594a09bd604f149d79139711e1233f8075e1867b907d80dbebedda045c3fdade588c0faa0b6677d6e829a3428614f093129556cc7afc34c43e84e1ba4372e8aba65a167c983012fc12e5062df705c3585bc520725105ba125b7dc4b410a471ac9c1186d1fc6221db4202002104235a981f6574cdffd943c8b07e5853416f0f249bb9c160e54b88f738ff5fe28cbd371f7978cc945eea13a3d07f7e385f87418782675eac05f284b6255a4a3c8b596813140d389c11e64b48ac7a548b89c57770b6462bbc1ec0f94c54d897f5dcc279cb95ee0e9ae78b9c6c37c176ad67d230db0ef6b4c63cef252b13e3bba7bc2a555314939529b8b6d86cd741decceb12f6d20920df1bf62d240f34e9e64d2219eb2238b42359f9c3b2985feebc0bd01ef113a06a988b770d1e54428dc88a265ff4c62a667f610c4e04c96fba8cdf576b50332669cb562bc2d05041d72d673ea2316cd0a245b7703cecfde1e4d38d09c3ea97e0eb48b8095852e39ec8950e63c7310ff4c942d46167498bae9d2cec116a0bd1f9d58b2797de66561ddc721a09d01ca529028c2572dd62afd81064521c5719bc445030f8c309f4eff05c4a38adf1217c11013b08a59c93e17a7e6bfcfc6c6f1a664e36e1bcfe6ae04e4a84493ee5aa76","version":"eip191-aes256-gcm-hkdf-sha256","salt":"5ac175d14345bbf55e670ac52a0b5959e1a8cf9c952ff636618eea90885cfcaf","nonce":"590a95e459bd3ec45beef960","preKey":"2730c16a51f55b5bb3da3e5ce13181b688e4dbc8a0625446d791fb6187c2a1e4"}',
verificationProof:
'eip191:0x6a244928fc15aea138701dfef49e0123902c38f5bc036dfe1f149e01b0191ef330f71082548b5b28ae49b89440a8e8be5259042d05d823b9279bb7f6e3a0c8821c',
msgSent: 23,
maxMsgPersisted: 100,
profile: {
name: 'coral-sophisticated-smelt',
desc: null,
picture:
'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAy0lEQVR4AcXBsW2EQBRF0bsPCsAlINEPtEBOB8YZHXhyWhgkd+EWkKYFGlit0y8Hs8Haeufc3t8+HwTHdSfa14Fo3k5q9nUgmreTaOwaImEmzITZ7fvj64GRMBNmwqzNqRBNS89/yqkQCTNhJsxansip8Ipp6akRZsJMmLX8klMhmpaeV+RUqBFmwkyYtcd1Jxq7hiinwl86rjuRMBNmwqwdu4ZoWnpq5u2kZl8HqlIhEmbCTJi1PJFTIdrXgZqcCtG09NQIM2EmzH4AC5cvf1h+9KkAAAAASUVORK5CYII=',
blockedUsersList: [],
profileVerificationProof: null,
},
origin: null,
},
},
];
}

Fetch Participants Count of a Group

// await userAlice.chat.group.participants.count(chatid)
const getCount = await userAlice.chat.group.participants.count(groupChatId);

Fetch Participants Count of a Group parameters

ParamTypeSubtypeDefaultRemarks
chatIdstring--The chatid related to that specific group. chatid are unique identifiers of the group

Note: Parameters in this style are mandatory.

Expected response
Expected response
{
"overallCount": 3,
"adminsCount": 2,
"membersCount": 0,
"pendingCount": 1,
"approvedCount": 2,
"roles": {
"ADMIN": {
"total": 2,
"pending": 0
},
"MEMBER": {
"total": 0,
"pending": 1
}
}
}

Fetch Participant Status in a Group

// await userAlice.chat.group.participants.status(chatid, accountId)
const getParticipantStatus = await userAlice.chat.group.participants.status(
groupChatId,
BobAddress
);

Fetch Participants of a Group parameters

ParamTypeSubtypeDefaultRemarks
chatIdstring--The chatid related to that specific group. chatid are unique identifiers of the group.
accountIdstring--The wallet address of the user whose participation status you wish to check within the group.

Note: Parameters in this style are mandatory.

Expected response
Expected response
{ 
pending: false,
role: 'admin',
participant: true
}