Groups

Catalog


POST Create group conversation

Request path:

https://staging.server.kahla.app/Groups/CreateGroupConversation

Request example:

https://staging.server.kahla.app/Groups/CreateGroupConversation?GroupName=yourGroupName&JoinPassword=yourJoinPassword

Request content type:

application/x-www-form-urlencoded

Form content example:

GroupName=yourGroupName&JoinPassword=yourJoinPassword 

Request form:

Name Required Type
GroupName Required Text
JoinPassword Not required Text

Possible Response:

{
  "value": 0,
  "code": 0,
  "message": "an example string."
}

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

GET Group summary

Request path:

https://staging.server.kahla.app/Groups/GroupSummary

Request example:

https://staging.server.kahla.app/Groups/GroupSummary?id=0

Try

Request arguments:

Name Required Type
id Required Number

Possible Response:

{
  "value": {
    "imagePath": "an example string.",
    "name": "an example string.",
    "hasPassword": true,
    "ownerId": "an example string.",
    "id": 0,
    "hasTimer": true,
    "conversationCreateTime": "2020-09-26T00:31:27.8052586Z"
  },
  "code": 0,
  "message": "an example string."
}

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Join group

Request path:

https://staging.server.kahla.app/Groups/JoinGroup

Request example:

https://staging.server.kahla.app/Groups/JoinGroup?groupName=yourgroupName&joinPassword=yourjoinPassword

Request content type:

application/x-www-form-urlencoded

Form content example:

groupName=yourgroupName&joinPassword=yourjoinPassword 

Request form:

Name Required Type
groupName Required Text
joinPassword Not required Text

Possible Response:

{
  "value": 0,
  "code": 0,
  "message": "an example string."
}

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Transfer group owner

Request path:

https://staging.server.kahla.app/Groups/TransferGroupOwner

Request example:

https://staging.server.kahla.app/Groups/TransferGroupOwner?groupName=yourgroupName&targetUserId=yourtargetUserId

Request content type:

application/x-www-form-urlencoded

Form content example:

groupName=yourgroupName&targetUserId=yourtargetUserId 

Request form:

Name Required Type
groupName Required Text
targetUserId Required Text

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Kick member

Request path:

https://staging.server.kahla.app/Groups/KickMember

Request example:

https://staging.server.kahla.app/Groups/KickMember?groupName=yourgroupName&targetUserId=yourtargetUserId

Request content type:

application/x-www-form-urlencoded

Form content example:

groupName=yourgroupName&targetUserId=yourtargetUserId 

Request form:

Name Required Type
groupName Required Text
targetUserId Required Text

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Dissolve group

Request path:

https://staging.server.kahla.app/Groups/DissolveGroup

Request example:

https://staging.server.kahla.app/Groups/DissolveGroup?groupName=yourgroupName

Request content type:

application/x-www-form-urlencoded

Form content example:

groupName=yourgroupName 

Request form:

Name Required Type
groupName Required Text

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Leave group

Request path:

https://staging.server.kahla.app/Groups/LeaveGroup

Request example:

https://staging.server.kahla.app/Groups/LeaveGroup?groupName=yourgroupName

Request content type:

application/x-www-form-urlencoded

Form content example:

groupName=yourgroupName 

Request form:

Name Required Type
groupName Required Text

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Set group muted

Request path:

https://staging.server.kahla.app/Groups/SetGroupMuted

Request example:

https://staging.server.kahla.app/Groups/SetGroupMuted?groupName=yourgroupName&setMuted=false

Request content type:

application/x-www-form-urlencoded

Form content example:

groupName=yourgroupName&setMuted=false 

Request form:

Name Required Type
groupName Required Text
setMuted Required Boolean

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Update group info

Request path:

https://staging.server.kahla.app/Groups/UpdateGroupInfo

Request example:

https://staging.server.kahla.app/Groups/UpdateGroupInfo?GroupName=yourGroupName&NewName=yourNewName&AvatarPath=yourAvatarPath&ListInSearchResult=false

Request content type:

application/x-www-form-urlencoded

Form content example:

GroupName=yourGroupName&NewName=yourNewName&AvatarPath=yourAvatarPath&ListInSearchResult=false 

Request form:

Name Required Type
GroupName Required Text
NewName Not required Text
AvatarPath Not required Text
ListInSearchResult Required Boolean

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Update group password

Request path:

https://staging.server.kahla.app/Groups/UpdateGroupPassword

Request example:

https://staging.server.kahla.app/Groups/UpdateGroupPassword?GroupName=yourGroupName&NewJoinPassword=yourNewJoinPassword

Request content type:

application/x-www-form-urlencoded

Form content example:

GroupName=yourGroupName&NewJoinPassword=yourNewJoinPassword 

Request form:

Name Required Type
GroupName Required Text
NewJoinPassword Not required Text

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}