Room
Create Room
Parameters:
Name | Type | Description | Required |
---|---|---|---|
name | string | room name | true |
topic | string | room topic | false |
invitations | string array | array of user ids to invite | false |
Returns:
Name | Type | Description | Required |
---|---|---|---|
roomId | string | id of the new room | true |
Invite User
Parameters:
Name | Type | Description | Required |
---|---|---|---|
roomId | string | room id | true |
userId | string | user id | true |
reason | string | invite reason | false |
Returns: none
Kick User
Parameters:
Name | Type | Description | Required |
---|---|---|---|
roomId | string | room id | true |
userId | string | user id | true |
reason | string | invite reason | false |
Returns: none
Join Room
Parameters:
Name | Type | Description | Required |
---|---|---|---|
roomId | string | room id | true |
Returns: none
Leave Room
Parameters:
Name | Type | Description | Required |
---|---|---|---|
roomId | string | room id | true |
Returns: none
Get Room Memebers
Parameters:
Name | Type | Description | Required |
---|---|---|---|
roomId | string | room id | true |
Returns:
Name | Type | Description | Required |
---|---|---|---|
Member.id | string | member user id | true |
Member.display_name | string | member display name | true |
Member.avatar_url | string | member avatar url | true |
Last updated