POST v3/conversation/createconversation
create new conversation
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| inVO | No documentation available. |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
{
"conversationBasicVO": {
"subject": "sample string 1",
"messageBody": "sample string 2",
"type": 0,
"memberList": [
{
"id": "sample string 1",
"name": "sample string 2",
"image": "sample string 3"
},
{
"id": "sample string 1",
"name": "sample string 2",
"image": "sample string 3"
},
{
"id": "sample string 1",
"name": "sample string 2",
"image": "sample string 3"
}
],
"createdBy": "sample string 3"
},
"needPushNotification": true,
"curUserId": "sample string 2",
"isSSO": true,
"requestHost": "sample string 4",
"applicationPath": "sample string 5",
"secureApplicationPath": "sample string 6",
"absoluteApplicationPath": "sample string 7",
"isHttps": true,
"isMobileDevice": true,
"isFullEmbed": true,
"clientType": 0,
"clientVersion": "sample string 11",
"clientOS": "sample string 12",
"clientBuild": "sample string 13",
"premiumAppId": "sample string 14",
"clientWidth": 15,
"clientHeight": 16,
"timezone": 17
}
application/xml, text/xml
Sample:
<CreateConversationInVO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input.Conversation">
<ClientHeight xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">16</ClientHeight>
<ClientType xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">Site</ClientType>
<ClientWidth xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">15</ClientWidth>
<absoluteApplicationPath xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 7</absoluteApplicationPath>
<applicationPath xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 5</applicationPath>
<cachedKey xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 1</cachedKey>
<clientBuild xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 13</clientBuild>
<clientOS xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 12</clientOS>
<clientVersion xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 11</clientVersion>
<curUserId xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 2</curUserId>
<isFullEmbed xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isFullEmbed>
<isHttps xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isHttps>
<isMobileDevice xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isMobileDevice>
<isSSO xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isSSO>
<premiumAppId xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 14</premiumAppId>
<requestHost xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 4</requestHost>
<secureApplicationPath xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 6</secureApplicationPath>
<timezone xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">17</timezone>
<ConversationBasicVO>
<CreatedBy>sample string 3</CreatedBy>
<MemberList xmlns:d3p1="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input.Member">
<d3p1:SearchSchoolMemberVO>
<d3p1:id>sample string 1</d3p1:id>
<d3p1:image>sample string 3</d3p1:image>
<d3p1:name>sample string 2</d3p1:name>
</d3p1:SearchSchoolMemberVO>
<d3p1:SearchSchoolMemberVO>
<d3p1:id>sample string 1</d3p1:id>
<d3p1:image>sample string 3</d3p1:image>
<d3p1:name>sample string 2</d3p1:name>
</d3p1:SearchSchoolMemberVO>
<d3p1:SearchSchoolMemberVO>
<d3p1:id>sample string 1</d3p1:id>
<d3p1:image>sample string 3</d3p1:image>
<d3p1:name>sample string 2</d3p1:name>
</d3p1:SearchSchoolMemberVO>
</MemberList>
<MessageBody>sample string 2</MessageBody>
<Subject>sample string 1</Subject>
<Type>NormalMessage</Type>
</ConversationBasicVO>
<NeedPushNotification>true</NeedPushNotification>
</CreateConversationInVO>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
No documentation available.
Response body formats
application/json, text/json
Sample:
{
"messageVO": {
"dateStr": "sample string 1",
"conversationList": [
{
"messagesList": [
{
"messageId": "sample string 1",
"message": "sample string 2",
"creatorId": "sample string 3",
"createdOn": {
"dateTime": "2024-11-21T03:46:49.5554582-06:00",
"date": "sample string 2",
"time": "sample string 3"
}
},
{
"messageId": "sample string 1",
"message": "sample string 2",
"creatorId": "sample string 3",
"createdOn": {
"dateTime": "2024-11-21T03:46:49.5554582-06:00",
"date": "sample string 2",
"time": "sample string 3"
}
},
{
"messageId": "sample string 1",
"message": "sample string 2",
"creatorId": "sample string 3",
"createdOn": {
"dateTime": "2024-11-21T03:46:49.5554582-06:00",
"date": "sample string 2",
"time": "sample string 3"
}
}
],
"creatorId": "sample string 1",
"creatorIcon": {
"memberName": "sample string 1",
"memberLogo": "sample string 2",
"isUseAvatar": true,
"avatarBackgroundColor": "sample string 4",
"avatarName": "sample string 5"
},
"creatorLink": "sample string 2",
"createdOn": {
"dateTime": "2024-11-21T03:46:49.5554582-06:00",
"date": "sample string 2",
"time": "sample string 3"
},
"isFromOther": true
},
{
"messagesList": [
{
"messageId": "sample string 1",
"message": "sample string 2",
"creatorId": "sample string 3",
"createdOn": {
"dateTime": "2024-11-21T03:46:49.5554582-06:00",
"date": "sample string 2",
"time": "sample string 3"
}
},
{
"messageId": "sample string 1",
"message": "sample string 2",
"creatorId": "sample string 3",
"createdOn": {
"dateTime": "2024-11-21T03:46:49.5554582-06:00",
"date": "sample string 2",
"time": "sample string 3"
}
},
{
"messageId": "sample string 1",
"message": "sample string 2",
"creatorId": "sample string 3",
"createdOn": {
"dateTime": "2024-11-21T03:46:49.5554582-06:00",
"date": "sample string 2",
"time": "sample string 3"
}
}
],
"creatorId": "sample string 1",
"creatorIcon": {
"memberName": "sample string 1",
"memberLogo": "sample string 2",
"isUseAvatar": true,
"avatarBackgroundColor": "sample string 4",
"avatarName": "sample string 5"
},
"creatorLink": "sample string 2",
"createdOn": {
"dateTime": "2024-11-21T03:46:49.5554582-06:00",
"date": "sample string 2",
"time": "sample string 3"
},
"isFromOther": true
},
{
"messagesList": [
{
"messageId": "sample string 1",
"message": "sample string 2",
"creatorId": "sample string 3",
"createdOn": {
"dateTime": "2024-11-21T03:46:49.5554582-06:00",
"date": "sample string 2",
"time": "sample string 3"
}
},
{
"messageId": "sample string 1",
"message": "sample string 2",
"creatorId": "sample string 3",
"createdOn": {
"dateTime": "2024-11-21T03:46:49.5554582-06:00",
"date": "sample string 2",
"time": "sample string 3"
}
},
{
"messageId": "sample string 1",
"message": "sample string 2",
"creatorId": "sample string 3",
"createdOn": {
"dateTime": "2024-11-21T03:46:49.5554582-06:00",
"date": "sample string 2",
"time": "sample string 3"
}
}
],
"creatorId": "sample string 1",
"creatorIcon": {
"memberName": "sample string 1",
"memberLogo": "sample string 2",
"isUseAvatar": true,
"avatarBackgroundColor": "sample string 4",
"avatarName": "sample string 5"
},
"creatorLink": "sample string 2",
"createdOn": {
"dateTime": "2024-11-21T03:46:49.5554582-06:00",
"date": "sample string 2",
"time": "sample string 3"
},
"isFromOther": true
}
]
},
"conversationId": "sample string 1",
"participantsCount": 2
}
application/xml, text/xml
Sample:
<CreateNewConversationOutVO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Output.Conversation">
<ConversationId>sample string 1</ConversationId>
<MessageVO>
<ConversationList>
<UserConversationVO>
<CreatedOn>
<Date>sample string 2</Date>
<DateTime>2024-11-21T03:46:49.5554582-06:00</DateTime>
<Time>sample string 3</Time>
</CreatedOn>
<CreatorIcon xmlns:d5p1="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Output.Member">
<d5p1:AvatarBackgroundColor>sample string 4</d5p1:AvatarBackgroundColor>
<d5p1:AvatarName>sample string 5</d5p1:AvatarName>
<d5p1:IsUseAvatar>true</d5p1:IsUseAvatar>
<d5p1:MemberLogo>sample string 2</d5p1:MemberLogo>
<d5p1:MemberName>sample string 1</d5p1:MemberName>
</CreatorIcon>
<CreatorId>sample string 1</CreatorId>
<CreatorLink>sample string 2</CreatorLink>
<IsFromOther>true</IsFromOther>
<MessagesList>
<BasicMessageVO>
<CreatedOn>
<Date>sample string 2</Date>
<DateTime>2024-11-21T03:46:49.5554582-06:00</DateTime>
<Time>sample string 3</Time>
</CreatedOn>
<CreatorId>sample string 3</CreatorId>
<Message>sample string 2</Message>
<MessageId>sample string 1</MessageId>
</BasicMessageVO>
<BasicMessageVO>
<CreatedOn>
<Date>sample string 2</Date>
<DateTime>2024-11-21T03:46:49.5554582-06:00</DateTime>
<Time>sample string 3</Time>
</CreatedOn>
<CreatorId>sample string 3</CreatorId>
<Message>sample string 2</Message>
<MessageId>sample string 1</MessageId>
</BasicMessageVO>
<BasicMessageVO>
<CreatedOn>
<Date>sample string 2</Date>
<DateTime>2024-11-21T03:46:49.5554582-06:00</DateTime>
<Time>sample string 3</Time>
</CreatedOn>
<CreatorId>sample string 3</CreatorId>
<Message>sample string 2</Message>
<MessageId>sample string 1</MessageId>
</BasicMessageVO>
</MessagesList>
</UserConversationVO>
<UserConversationVO>
<CreatedOn>
<Date>sample string 2</Date>
<DateTime>2024-11-21T03:46:49.5554582-06:00</DateTime>
<Time>sample string 3</Time>
</CreatedOn>
<CreatorIcon xmlns:d5p1="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Output.Member">
<d5p1:AvatarBackgroundColor>sample string 4</d5p1:AvatarBackgroundColor>
<d5p1:AvatarName>sample string 5</d5p1:AvatarName>
<d5p1:IsUseAvatar>true</d5p1:IsUseAvatar>
<d5p1:MemberLogo>sample string 2</d5p1:MemberLogo>
<d5p1:MemberName>sample string 1</d5p1:MemberName>
</CreatorIcon>
<CreatorId>sample string 1</CreatorId>
<CreatorLink>sample string 2</CreatorLink>
<IsFromOther>true</IsFromOther>
<MessagesList>
<BasicMessageVO>
<CreatedOn>
<Date>sample string 2</Date>
<DateTime>2024-11-21T03:46:49.5554582-06:00</DateTime>
<Time>sample string 3</Time>
</CreatedOn>
<CreatorId>sample string 3</CreatorId>
<Message>sample string 2</Message>
<MessageId>sample string 1</MessageId>
</BasicMessageVO>
<BasicMessageVO>
<CreatedOn>
<Date>sample string 2</Date>
<DateTime>2024-11-21T03:46:49.5554582-06:00</DateTime>
<Time>sample string 3</Time>
</CreatedOn>
<CreatorId>sample string 3</CreatorId>
<Message>sample string 2</Message>
<MessageId>sample string 1</MessageId>
</BasicMessageVO>
<BasicMessageVO>
<CreatedOn>
<Date>sample string 2</Date>
<DateTime>2024-11-21T03:46:49.5554582-06:00</DateTime>
<Time>sample string 3</Time>
</CreatedOn>
<CreatorId>sample string 3</CreatorId>
<Message>sample string 2</Message>
<MessageId>sample string 1</MessageId>
</BasicMessageVO>
</MessagesList>
</UserConversationVO>
<UserConversationVO>
<CreatedOn>
<Date>sample string 2</Date>
<DateTime>2024-11-21T03:46:49.5554582-06:00</DateTime>
<Time>sample string 3</Time>
</CreatedOn>
<CreatorIcon xmlns:d5p1="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Output.Member">
<d5p1:AvatarBackgroundColor>sample string 4</d5p1:AvatarBackgroundColor>
<d5p1:AvatarName>sample string 5</d5p1:AvatarName>
<d5p1:IsUseAvatar>true</d5p1:IsUseAvatar>
<d5p1:MemberLogo>sample string 2</d5p1:MemberLogo>
<d5p1:MemberName>sample string 1</d5p1:MemberName>
</CreatorIcon>
<CreatorId>sample string 1</CreatorId>
<CreatorLink>sample string 2</CreatorLink>
<IsFromOther>true</IsFromOther>
<MessagesList>
<BasicMessageVO>
<CreatedOn>
<Date>sample string 2</Date>
<DateTime>2024-11-21T03:46:49.5554582-06:00</DateTime>
<Time>sample string 3</Time>
</CreatedOn>
<CreatorId>sample string 3</CreatorId>
<Message>sample string 2</Message>
<MessageId>sample string 1</MessageId>
</BasicMessageVO>
<BasicMessageVO>
<CreatedOn>
<Date>sample string 2</Date>
<DateTime>2024-11-21T03:46:49.5554582-06:00</DateTime>
<Time>sample string 3</Time>
</CreatedOn>
<CreatorId>sample string 3</CreatorId>
<Message>sample string 2</Message>
<MessageId>sample string 1</MessageId>
</BasicMessageVO>
<BasicMessageVO>
<CreatedOn>
<Date>sample string 2</Date>
<DateTime>2024-11-21T03:46:49.5554582-06:00</DateTime>
<Time>sample string 3</Time>
</CreatedOn>
<CreatorId>sample string 3</CreatorId>
<Message>sample string 2</Message>
<MessageId>sample string 1</MessageId>
</BasicMessageVO>
</MessagesList>
</UserConversationVO>
</ConversationList>
<DateStr>sample string 1</DateStr>
</MessageVO>
<ParticipantsCount>2</ParticipantsCount>
</CreateNewConversationOutVO>