POST v3/conversation/createembedchat

No documentation available.

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:

{
  "entityId": "sample string 1",
  "entityType": "sample string 2",
  "messageBody": "sample string 3",
  "curUserId": "sample string 4",
  "isSSO": true,
  "requestHost": "sample string 6",
  "applicationPath": "sample string 7",
  "secureApplicationPath": "sample string 8",
  "absoluteApplicationPath": "sample string 9",
  "isHttps": true,
  "isMobileDevice": true,
  "isFullEmbed": true,
  "clientType": 0,
  "clientVersion": "sample string 13",
  "clientOS": "sample string 14",
  "clientBuild": "sample string 15",
  "premiumAppId": "sample string 16",
  "clientWidth": 17,
  "clientHeight": 18,
  "timezone": 19
}

application/xml, text/xml

Sample:

<CreateEmbedChatInVO 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">18</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">17</ClientWidth>
  <absoluteApplicationPath xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 9</absoluteApplicationPath>
  <applicationPath xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 7</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 15</clientBuild>
  <clientOS xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 14</clientOS>
  <clientVersion xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 13</clientVersion>
  <curUserId xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 4</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 16</premiumAppId>
  <requestHost xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 6</requestHost>
  <secureApplicationPath xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 8</secureApplicationPath>
  <timezone xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">19</timezone>
  <EntityId>sample string 1</EntityId>
  <EntityType>sample string 2</EntityType>
  <MessageBody>sample string 3</MessageBody>
</CreateEmbedChatInVO>

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-12-03T10:47:45.1757558-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-12-03T10:47:45.1757558-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-12-03T10:47:45.1757558-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-12-03T10:47:45.1757558-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-12-03T10:47:45.1757558-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-12-03T10:47:45.1757558-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-12-03T10:47:45.1757558-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-12-03T10:47:45.1757558-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-12-03T10:47:45.1757558-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-12-03T10:47:45.1757558-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-12-03T10:47:45.1757558-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-12-03T10:47:45.1757558-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-12-03T10:47:45.1757558-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-12-03T10:47:45.1757558-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-12-03T10:47:45.1757558-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-12-03T10:47:45.1757558-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-12-03T10:47:45.1757558-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-12-03T10:47:45.1757558-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-12-03T10:47:45.1757558-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-12-03T10:47:45.1757558-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-12-03T10:47:45.1757558-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-12-03T10:47:45.1757558-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-12-03T10:47:45.1757558-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-12-03T10:47:45.1757558-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>