跳到主要内容

群消息订阅和取消订阅- IM即时通讯REST API

群消息订阅​

为用户动态订阅群消息,一次可以为多个用户订阅多个群,订阅关系仅有效于本次连接,客户端下次建立连接后,仍需执行订阅。

调用说明​

URL:​

Post http://{rest-host}/v2/im/subscribe-groups

参数说明​

参数类型必须描述
rest-hostString是杭州:rest-hz.goeasy.io
新加坡:rest-singapore.goeasy.io
appkeyString是common key 或者 rest key
userIdsArray是用户id列表,每次最多不超过10个
groupIdsArray是群id列表,每次最多不超过10个

调用示例​


//macOS/Linux
curl -X POST https://rest-hz.goeasy.io/v2/im/subscribe-groups \
-H "Content-Type: application/json" \
-d "{
'appkey':'您的appkey',
'userIds':['user001','user002','user003'],
'groupIds':['group001','group002','group003']
}"

//Windows
curl -X POST https://rest-hz.goeasy.io/v2/im/subscribe-groups ^
-H "Content-Type: application/json" ^
-d "{ appkey:'您的appkey', 'userIds':['user001','user002','user003'], 'groupIds':['group001','group002','group003'] }"

返回说明​

成功返回值示例​
{
"code":200,
"content": "ok"
}
失败返回值示例​
{
"code":401,
"content":"Unauthorized"
}

取消订阅群消息​

动态取消用户的群消息订阅,一次可以为多个用户取消订阅多个群

调用说明​

URL:​

Post http://{rest-host}/v2/im/unsubscribe-groups

参数说明​

参数类型必须描述
rest-hostString是杭州:rest-hz.goeasy.io
新加坡:rest-singapore.goeasy.io
appkeyString是common key 或者 rest key
userIdsArray是用户id列表,每次最多不超过10个
groupIdsArray是群id列表,每次最多不超过10个

调用示例​


//macOS/Linux
curl -X POST https://rest-hz.goeasy.io/v2/im/unsubscribe-groups \
-H "Content-Type: application/json" \
-d "{
'appkey':'您的appkey',
'userIds':['user001','user002','user003'],
'groupIds':['group001','group002','group003']
}"

//Windows
curl -X POST https://rest-hz.goeasy.io/v2/im/unsubscribe-groups ^
-H "Content-Type: application/json" ^
-d "{ appkey:'您的appkey', 'userIds':['user001','user002','user003'], 'groupIds':['group001','group002','group003'] }"

返回说明​

成功返回值示例​
{
"code":200,
"content": "ok"
}
失败返回值示例​
{
"code":401,
"content":"Unauthorized"
}