1. Aiursoft Wiki Center
  2. Kahla
  3. Conversation

Conversation

Catalog

GET All

Request path:

https://staging.server.kahla.app/Conversation/All

Request example:

https://staging.server.kahla.app/Conversation/All

Try

Possible Response:

{
  "items": [
    {
      "displayName": "an example string.",
      "displayImagePath": "an example string.",
      "latestMessage": {
        "id": "c8ddd017-4732-48b0-a402-1a1f7686ffe0",
        "conversationId": 0,
        "ats": [
          {
            "targetUserId": "an example string."
          }
        ],
        "senderId": "an example string.",
        "sender": {
          "markEmailPublic": true,
          "themeId": 0,
          "email": "an example string.",
          "enableEmailNotification": true,
          "enableEnterToSendMessage": true,
          "enableInvisiable": true,
          "listInSearchResult": true,
          "isOnline": true,
          "id": "an example string.",
          "bio": "an example string.",
          "nickName": "an example string.",
          "sex": "an example string.",
          "iconFilePath": "an example string.",
          "preferedLanguage": "an example string.",
          "accountCreateTime": "2021-06-17T23:06:51.1726521Z",
          "emailConfirmed": true
        },
        "sendTime": "2021-06-17T23:06:51.1727718Z",
        "content": "an example string.",
        "read": true,
        "groupWithPrevious": true
      },
      "unReadAmount": 0,
      "conversationId": 0,
      "discriminator": "an example string.",
      "userId": "an example string.",
      "aesKey": "an example string.",
      "muted": true,
      "someoneAtMe": true,
      "online": true
    }
  ],
  "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 Get message

Request path:

https://staging.server.kahla.app/Conversation/GetMessage

Request example:

https://staging.server.kahla.app/Conversation/GetMessage?id=0&take=0&skipFrom=yourskipFrom

Try

Request arguments:

Name Required Type
id Required Number
take Not required Number
skipFrom Not required Text

Possible Response:

{
  "items": [
    {
      "id": "e2503601-0c87-43f9-b92f-9f8321a3244f",
      "conversationId": 0,
      "ats": [
        {
          "targetUserId": "an example string."
        }
      ],
      "senderId": "an example string.",
      "sender": {
        "markEmailPublic": true,
        "themeId": 0,
        "email": "an example string.",
        "enableEmailNotification": true,
        "enableEnterToSendMessage": true,
        "enableInvisiable": true,
        "listInSearchResult": true,
        "isOnline": true,
        "id": "an example string.",
        "bio": "an example string.",
        "nickName": "an example string.",
        "sex": "an example string.",
        "iconFilePath": "an example string.",
        "preferedLanguage": "an example string.",
        "accountCreateTime": "2021-06-17T23:06:51.19491Z",
        "emailConfirmed": true
      },
      "sendTime": "2021-06-17T23:06:51.1950149Z",
      "content": "an example string.",
      "read": true,
      "groupWithPrevious": true
    }
  ],
  "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 Send message

Request path:

https://staging.server.kahla.app/Conversation/SendMessage

Request example:

https://staging.server.kahla.app/Conversation/SendMessage?Id=0&Content=yourContent&At[0]=yourAt&At[1]=yourAt&At[2]=yourAt&MessageId=yourMessageId

Request content type:

application/x-www-form-urlencoded

Form content example:

Id=0&Content=yourContent&At[0]=yourAt&At[1]=yourAt&At[2]=yourAt&MessageId=yourMessageId

Request form:

Name Required Type
Id Required Number
Content Required Text
At Not required Text Collection
MessageId Required Text

Possible Response:

{
  "value": {
    "id": "ce257388-c881-4d93-8e6a-3df16b330291",
    "conversationId": 0,
    "ats": [
      {
        "targetUserId": "an example string."
      }
    ],
    "senderId": "an example string.",
    "sender": {
      "markEmailPublic": true,
      "themeId": 0,
      "email": "an example string.",
      "enableEmailNotification": true,
      "enableEnterToSendMessage": true,
      "enableInvisiable": true,
      "listInSearchResult": true,
      "isOnline": true,
      "id": "an example string.",
      "bio": "an example string.",
      "nickName": "an example string.",
      "sex": "an example string.",
      "iconFilePath": "an example string.",
      "preferedLanguage": "an example string.",
      "accountCreateTime": "2021-06-17T23:06:51.2223155Z",
      "emailConfirmed": true
    },
    "sendTime": "2021-06-17T23:06:51.2224155Z",
    "content": "an example string.",
    "read": true,
    "groupWithPrevious": true
  },
  "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 Conversation detail

Request path:

https://staging.server.kahla.app/Conversation/ConversationDetail

Request example:

https://staging.server.kahla.app/Conversation/ConversationDetail?id=0

Try

Request arguments:

Name Required Type
id Required Number

Possible Response:

{
  "value": {
    "requesterId": "an example string.",
    "requestUser": {
      "markEmailPublic": true,
      "themeId": 0,
      "email": "an example string.",
      "enableEmailNotification": true,
      "enableEnterToSendMessage": true,
      "enableInvisiable": true,
      "listInSearchResult": true,
      "isOnline": true,
      "id": "an example string.",
      "bio": "an example string.",
      "nickName": "an example string.",
      "sex": "an example string.",
      "iconFilePath": "an example string.",
      "preferedLanguage": "an example string.",
      "accountCreateTime": "2021-06-17T23:06:51.2428644Z",
      "emailConfirmed": true
    },
    "targetId": "an example string.",
    "targetUser": {
      "markEmailPublic": true,
      "themeId": 0,
      "email": "an example string.",
      "enableEmailNotification": true,
      "enableEnterToSendMessage": true,
      "enableInvisiable": true,
      "listInSearchResult": true,
      "isOnline": true,
      "id": "an example string.",
      "bio": "an example string.",
      "nickName": "an example string.",
      "sex": "an example string.",
      "iconFilePath": "an example string.",
      "preferedLanguage": "an example string.",
      "accountCreateTime": "2021-06-17T23:06:51.244069Z",
      "emailConfirmed": true
    },
    "anotherUserId": "an example string.",
    "id": 0,
    "discriminator": "an example string.",
    "aesKey": "an example string.",
    "maxLiveSeconds": 0,
    "conversationCreateTime": "2021-06-17T23:06:51.2441961Z",
    "displayName": "an example string.",
    "displayImagePath": "an example string."
  },
  "code": 0,
  "message": "an example string."
}

Possible Response:

{
  "value": {
    "users": [
      {
        "id": 0,
        "joinTime": "2021-06-17T23:06:51.2608307Z",
        "muted": true,
        "userId": "an example string.",
        "user": {
          "markEmailPublic": true,
          "themeId": 0,
          "email": "an example string.",
          "enableEmailNotification": true,
          "enableEnterToSendMessage": true,
          "enableInvisiable": true,
          "listInSearchResult": true,
          "isOnline": true,
          "id": "an example string.",
          "bio": "an example string.",
          "nickName": "an example string.",
          "sex": "an example string.",
          "iconFilePath": "an example string.",
          "preferedLanguage": "an example string.",
          "accountCreateTime": "2021-06-17T23:06:51.2619411Z",
          "emailConfirmed": true
        },
        "groupId": 0,
        "readTimeStamp": "2021-06-17T23:06:51.2620593Z"
      }
    ],
    "groupImagePath": "an example string.",
    "groupName": "an example string.",
    "listInSearchResult": true,
    "hasPassword": false,
    "ownerId": "an example string.",
    "id": 0,
    "discriminator": "an example string.",
    "aesKey": "an example string.",
    "maxLiveSeconds": 0,
    "conversationCreateTime": "2021-06-17T23:06:51.2621963Z",
    "displayName": "an example string.",
    "displayImagePath": "an example string."
  },
  "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 File history

Request path:

https://staging.server.kahla.app/Conversation/FileHistory

Request example:

https://staging.server.kahla.app/Conversation/FileHistory?id=0&skipDates=0

Try

Request arguments:

Name Required Type
id Required Number
skipDates Required Number

Possible Response:

{
  "showingDateUTC": "an example string.",
  "siteName": "an example string.",
  "rootPath": "an example string.",
  "items": [
    {
      "fileName": "an example string.",
      "fileSize": 0,
      "uploadTime": "2021-06-17T23:06:51.3048501Z"
    }
  ],
  "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 Update message life time

Request path:

https://staging.server.kahla.app/Conversation/UpdateMessageLifeTime

Request example:

https://staging.server.kahla.app/Conversation/UpdateMessageLifeTime?Id=0&NewLifeTime=0

Request content type:

application/x-www-form-urlencoded

Form content example:

Id=0&NewLifeTime=0

Request form:

Name Required Type
Id Required Number
NewLifeTime Required Number

Possible Response:

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

Possible Response:

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