POST api/meet/start/{accesskey}/{meetingkey}?JoinKey={JoinKey}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
accesskey | globally unique identifier |
Required |
|
meetingkey | globally unique identifier |
Required |
|
JoinKey | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
MeetDetailName | Description | 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": "363af362-1a67-4a20-a612-d9f02cdfaa91", "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": "8768ea31-50d1-44b8-92b4-03c59353f107", "CreatedOn": "2025-04-22T15:17:26.6997076+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": "4cc54ef4-44fd-4004-92a0-6158c432eaf5", "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>363af362-1a67-4a20-a612-d9f02cdfaa91</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>4cc54ef4-44fd-4004-92a0-6158c432eaf5</CompanyKey> <CompanyName>sample string 18</CompanyName> <CompanyUrl>sample string 19</CompanyUrl> <CreatedOn>2025-04-22T15:17:26.6997076+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>8768ea31-50d1-44b8-92b4-03c59353f107</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>