POST api/meet/room/join/{RoomKey}

Request Information

URI Parameters

Name	Description	Type	Additional information
RoomKey		globally unique identifier	Required

Body Parameters

JoinMeetRequest

Name	Type	Additional information
CampaignKey	globally unique identifier	None.
CampaignIdentity	string	None.
Name	string	None.
Email	string	None.
CompanyName	string	None.
Mobile	string	None.
MobileCode	string	None.
GeoLocation	string	None.
UserEnvironment	string	None.
ProfileImageUrl	string	None.
SipConnectionId	string	None.
PublisherId	string	None.
VoiceUUId	string	None.
AdsParams	string	None.
ReferralUrl	string	None.

Request Formats

application/json, text/json

Sample:

{
  "CampaignKey": "74c7477f-6b5c-4575-a121-e83f6e79b9b1",
  "CampaignIdentity": "sample string 2",
  "Name": "sample string 3",
  "Email": "sample string 4",
  "CompanyName": "sample string 5",
  "Mobile": "sample string 6",
  "MobileCode": "sample string 7",
  "GeoLocation": "sample string 8",
  "UserEnvironment": "sample string 9",
  "ProfileImageUrl": "sample string 10",
  "SipConnectionId": "sample string 11",
  "PublisherId": "sample string 12",
  "VoiceUUId": "sample string 13",
  "AdsParams": "sample string 14",
  "ReferralUrl": "sample string 15"
}

application/xml, text/xml

Sample:

<JoinMeetRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SeeTheProWebAPI.App_Code">
  <AdsParams>sample string 14</AdsParams>
  <CampaignIdentity>sample string 2</CampaignIdentity>
  <CampaignKey>74c7477f-6b5c-4575-a121-e83f6e79b9b1</CampaignKey>
  <CompanyName>sample string 5</CompanyName>
  <Email>sample string 4</Email>
  <GeoLocation>sample string 8</GeoLocation>
  <Mobile>sample string 6</Mobile>
  <MobileCode>sample string 7</MobileCode>
  <Name>sample string 3</Name>
  <ProfileImageUrl>sample string 10</ProfileImageUrl>
  <PublisherId>sample string 12</PublisherId>
  <ReferralUrl>sample string 15</ReferralUrl>
  <SipConnectionId>sample string 11</SipConnectionId>
  <UserEnvironment>sample string 9</UserEnvironment>
  <VoiceUUId>sample string 13</VoiceUUId>
</JoinMeetRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

MeetDetail

Name	Type	Additional information
CampaignKey	globally unique identifier	None.
CampaignName	string	None.
CampaignIdentity	string	None.
VerticalId	integer	None.
CampaignDesc	string	None.
StartDate	string	None.
EndDate	string	None.
CallRecord	boolean	None.
ProductGroupKey	globally unique identifier	None.
CreatedOn	date	None.
BitlyUrl	string	None.
BReqCompanyName	boolean	None.
BReqCustomerName	boolean	None.
BReqEmail	boolean	None.
BReqMobile	boolean	None.
BReqMobileVerify	boolean	None.
MReqCompanyName	boolean	None.
MReqCustomerName	boolean	None.
MReqEmail	boolean	None.
MReqMobile	boolean	None.
MReqComment	boolean	None.
CReqCompanyName	boolean	None.
CReqCustomerName	boolean	None.
CReqEmail	boolean	None.
CReqMobile	boolean	None.
CReqComment	boolean	None.
SReqCompanyName	boolean	None.
SReqCustomerName	boolean	None.
SReqEmail	boolean	None.
SReqMobile	boolean	None.
SReqComment	boolean	None.
SReqRating	boolean	None.
IsArchive	boolean	None.
ReqForm	integer	None.
CompanyKey	globally unique identifier	None.
IsMeeting	boolean	None.
Password	string	None.
OperatorId	integer	None.
CampaignLogoUrl	string	None.
CampaignType	integer	None.
CampaignPhoneNumber	string	None.
CampaignQrCodeUrl	string	None.
InteractionMedium	integer	None.
LocationAccess	boolean	None.
CustomUI	string	None.
MediaType	integer	None.
IVRBeforeCall	string	None.
IVRBeforeCallAudio	string	None.
IsVcc	boolean	None.
VccAppletName	string	None.
RingDuration	integer	None.
FallbackUrl	string	None.
FallbackMessage	string	None.
WaitingRoomVideo	string	None.
CompanyName	string	None.
CompanyUrl	string	None.
VideoUrl	string	None.
ParticipantRoomConfig	string	None.
OperatorRoomConfig	string	None.
EndCallWhenCustomerLeaves	boolean	None.
MeetingPickedMessage	string	None.
CustomAction	string	None.
StpAppDomain	string	None.
VirtualBackgrounds	Collection of VirtualBackground	None.

Response Formats

application/json, text/json

Sample:

{
  "CampaignKey": "e605467e-44af-4712-96fc-0d43d905b70f",
  "CampaignName": "sample string 1",
  "CampaignIdentity": "sample string 2",
  "VerticalId": 1,
  "CampaignDesc": "sample string 3",
  "StartDate": "sample string 4",
  "EndDate": "sample string 5",
  "CallRecord": true,
  "ProductGroupKey": "e0959571-9f46-42be-b07e-6d31dcdde042",
  "CreatedOn": "2025-04-22T09:46:06.1276762+00:00",
  "BitlyUrl": "sample string 6",
  "BReqCompanyName": true,
  "BReqCustomerName": true,
  "BReqEmail": true,
  "BReqMobile": true,
  "BReqMobileVerify": true,
  "MReqCompanyName": true,
  "MReqCustomerName": true,
  "MReqEmail": true,
  "MReqMobile": true,
  "MReqComment": true,
  "CReqCompanyName": true,
  "CReqCustomerName": true,
  "CReqEmail": true,
  "CReqMobile": true,
  "CReqComment": true,
  "SReqCompanyName": true,
  "SReqCustomerName": true,
  "SReqEmail": true,
  "SReqMobile": true,
  "SReqComment": true,
  "SReqRating": true,
  "IsArchive": true,
  "ReqForm": 1,
  "CompanyKey": "035132fa-7ec1-4fd2-a6ee-39e6653253ce",
  "IsMeeting": true,
  "Password": "sample string 7",
  "OperatorId": 1,
  "CampaignLogoUrl": "sample string 8",
  "CampaignType": 1,
  "CampaignPhoneNumber": "sample string 9",
  "CampaignQrCodeUrl": "sample string 10",
  "InteractionMedium": 1,
  "LocationAccess": true,
  "CustomUI": "sample string 11",
  "MediaType": 1,
  "IVRBeforeCall": "sample string 12",
  "IVRBeforeCallAudio": "sample string 13",
  "IsVcc": true,
  "VccAppletName": "sample string 14",
  "RingDuration": 1,
  "FallbackUrl": "sample string 15",
  "FallbackMessage": "sample string 16",
  "WaitingRoomVideo": "sample string 17",
  "CompanyName": "sample string 18",
  "CompanyUrl": "sample string 19",
  "VideoUrl": "sample string 20",
  "ParticipantRoomConfig": "sample string 21",
  "OperatorRoomConfig": "sample string 22",
  "EndCallWhenCustomerLeaves": true,
  "MeetingPickedMessage": "sample string 23",
  "CustomAction": "sample string 24",
  "StpAppDomain": "sample string 25",
  "VirtualBackgrounds": [
    {
      "VBId": 1,
      "ImageUrl": "sample string 2"
    },
    {
      "VBId": 1,
      "ImageUrl": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<MeetDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SeeTheProWebAPI.App_Code">
  <BReqCompanyName>true</BReqCompanyName>
  <BReqCustomerName>true</BReqCustomerName>
  <BReqEmail>true</BReqEmail>
  <BReqMobile>true</BReqMobile>
  <BReqMobileVerify>true</BReqMobileVerify>
  <BitlyUrl>sample string 6</BitlyUrl>
  <CReqComment>true</CReqComment>
  <CReqCompanyName>true</CReqCompanyName>
  <CReqCustomerName>true</CReqCustomerName>
  <CReqEmail>true</CReqEmail>
  <CReqMobile>true</CReqMobile>
  <CallRecord>true</CallRecord>
  <CampaignDesc>sample string 3</CampaignDesc>
  <CampaignIdentity>sample string 2</CampaignIdentity>
  <CampaignKey>e605467e-44af-4712-96fc-0d43d905b70f</CampaignKey>
  <CampaignLogoUrl>sample string 8</CampaignLogoUrl>
  <CampaignName>sample string 1</CampaignName>
  <CampaignPhoneNumber>sample string 9</CampaignPhoneNumber>
  <CampaignQrCodeUrl>sample string 10</CampaignQrCodeUrl>
  <CampaignType>1</CampaignType>
  <CompanyKey>035132fa-7ec1-4fd2-a6ee-39e6653253ce</CompanyKey>
  <CompanyName>sample string 18</CompanyName>
  <CompanyUrl>sample string 19</CompanyUrl>
  <CreatedOn>2025-04-22T09:46:06.1276762+00:00</CreatedOn>
  <CustomAction>sample string 24</CustomAction>
  <CustomUI>sample string 11</CustomUI>
  <EndCallWhenCustomerLeaves>true</EndCallWhenCustomerLeaves>
  <EndDate>sample string 5</EndDate>
  <FallbackMessage>sample string 16</FallbackMessage>
  <FallbackUrl>sample string 15</FallbackUrl>
  <IVRBeforeCall>sample string 12</IVRBeforeCall>
  <IVRBeforeCallAudio>sample string 13</IVRBeforeCallAudio>
  <InteractionMedium>1</InteractionMedium>
  <IsArchive>true</IsArchive>
  <IsMeeting>true</IsMeeting>
  <IsVcc>true</IsVcc>
  <LocationAccess>true</LocationAccess>
  <MReqComment>true</MReqComment>
  <MReqCompanyName>true</MReqCompanyName>
  <MReqCustomerName>true</MReqCustomerName>
  <MReqEmail>true</MReqEmail>
  <MReqMobile>true</MReqMobile>
  <MediaType>1</MediaType>
  <MeetingPickedMessage>sample string 23</MeetingPickedMessage>
  <OperatorId>1</OperatorId>
  <OperatorRoomConfig>sample string 22</OperatorRoomConfig>
  <ParticipantRoomConfig>sample string 21</ParticipantRoomConfig>
  <Password>sample string 7</Password>
  <ProductGroupKey>e0959571-9f46-42be-b07e-6d31dcdde042</ProductGroupKey>
  <ReqForm>1</ReqForm>
  <RingDuration>1</RingDuration>
  <SReqComment>true</SReqComment>
  <SReqCompanyName>true</SReqCompanyName>
  <SReqCustomerName>true</SReqCustomerName>
  <SReqEmail>true</SReqEmail>
  <SReqMobile>true</SReqMobile>
  <SReqRating>true</SReqRating>
  <StartDate>sample string 4</StartDate>
  <StpAppDomain>sample string 25</StpAppDomain>
  <VccAppletName>sample string 14</VccAppletName>
  <VerticalId>1</VerticalId>
  <VideoUrl>sample string 20</VideoUrl>
  <VirtualBackgrounds>
    <VirtualBackground>
      <ImageUrl>sample string 2</ImageUrl>
      <VBId>1</VBId>
    </VirtualBackground>
    <VirtualBackground>
      <ImageUrl>sample string 2</ImageUrl>
      <VBId>1</VBId>
    </VirtualBackground>
  </VirtualBackgrounds>
  <WaitingRoomVideo>sample string 17</WaitingRoomVideo>
</MeetDetail>