POST Provider/Task/InviteThirdPartyVideoConference

Start the video process. Since every video call requires a confirmation from the listener before the video call can be made, it needs to inform the server that it is ready to make video call. Once this function is called, the caller needs to call GetVideoEngineAccounts in order to get the account info to make the video call.

Request Information

URI Parameters

None.

Body Parameters

ParaThirdPartyVideoParticipant

Name	Type	Additional information
Email	string	None.
RegionId	integer	None.
PhoneNumber	string	None.
Name	string	None.
DTMF	string	None.
isPSTN	boolean	None.
isPSTNStr	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Email": "sample string 1",
  "RegionId": 2,
  "PhoneNumber": "sample string 3",
  "Name": "sample string 4",
  "DTMF": "sample string 5",
  "isPSTN": true,
  "isPSTNStr": "sample string 6"
}

application/xml, text/xml

Sample:

<ParaThirdPartyVideoParticipant xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <DTMF>sample string 5</DTMF>
  <Email>sample string 1</Email>
  <Name>sample string 4</Name>
  <PhoneNumber>sample string 3</PhoneNumber>
  <RegionId>2</RegionId>
  <isPSTN>true</isPSTN>
  <isPSTNStr>sample string 6</isPSTNStr>
</ParaThirdPartyVideoParticipant>

Response Information

Resource Description

ResultVideoConferenceParticipant

Name	Type	Additional information
RequestConferenceSessionId	integer	None.
RequestConferenceSessionVideoParticipantId	integer	None.
RequestConferenceSessionVideoTypeCodeId	integer	None.
RequestConferenceSessionVideoStatusCodeId	integer	None.
PersonName	string	None.
ProviderName	string	None.
AppClientEmail	string	None.
AppClientPhoneNumber	string	None.
AppClientName	string	None.
VideoAccountIdentity	string	None.
secondRequest	ResultVideoConferenceSecondRequest	None.

Response Formats

application/json, text/json

Sample:

{
  "RequestConferenceSessionId": 1,
  "RequestConferenceSessionVideoParticipantId": 2,
  "RequestConferenceSessionVideoTypeCodeId": 3,
  "RequestConferenceSessionVideoStatusCodeId": 4,
  "PersonName": "sample string 5",
  "ProviderName": "sample string 6",
  "AppClientEmail": "sample string 7",
  "AppClientPhoneNumber": "sample string 8",
  "AppClientName": "sample string 9",
  "VideoAccountIdentity": "sample string 10",
  "secondRequest": {
    "RequestStatusCodeId": 1,
    "providerList": [
      {
        "RequestProviderId": 1,
        "Name": "sample string 2",
        "NativeLanguage": [
          "sample string 1",
          "sample string 2"
        ],
        "OtherLanguage": [
          "sample string 1",
          "sample string 2"
        ],
        "ProviderRate": 3.0,
        "ProviderPerformance": 4.0,
        "NeedHelpLanguage": "sample string 5",
        "SupportCall": true,
        "SupportVideo": true,
        "SupportText": true,
        "ProfileImage": {
          "FileName": "sample string 1",
          "MimeType": "sample string 2",
          "ImageData": "sample string 3",
          "ServerImageId": 1
        },
        "ProviderSpecialTypeId": 9,
        "isSchedule": {
          "ScheduledRequestId": 1,
          "ScheduledBlockId": 1,
          "startUtcDate": "2025-04-25T15:19:26.2846051Z",
          "startUtcDateStr": "sample string 1",
          "ScheduleDuration": 1,
          "PersonId": 1,
          "ClientName": "sample string 2",
          "PIN": "sample string 3",
          "ForceId": "sample string 4",
          "PersonName": "sample string 5",
          "PersonEmail": "sample string 6",
          "PersonPhoneNumber": "sample string 7",
          "ClientUserId": 1,
          "FromLanguageId": 1,
          "FromLanguage": "sample string 8",
          "ToLanguageId": 1,
          "ToLanguage": "sample string 9",
          "ProductName": "sample string 10",
          "ProductDescription": "sample string 11",
          "ProviderId": 1,
          "ProviderEmail": "sample string 12",
          "ProviderPhoneNumber": "sample string 13",
          "ProviderName": "sample string 14",
          "ScheduleStatusDescription": "sample string 15",
          "ScheduleStatusId": 1,
          "BillPersonPrechargeProductId": 1,
          "ScheduledRequestRoutingStatusCodeId": 1,
          "ScheduledRequestRoutingStatus": "sample string 16",
          "JoinAvailable": true,
          "callPurpose": "sample string 17",
          "ConfirmationNumber": "sample string 18",
          "GenderOptionCode": "sample string 19",
          "VideoOptionCode": "sample string 20",
          "IsOffered": true,
          "ScheduledRequestProviderId": 1
        },
        "AnyMeetingExist": true
      },
      {
        "RequestProviderId": 1,
        "Name": "sample string 2",
        "NativeLanguage": [
          "sample string 1",
          "sample string 2"
        ],
        "OtherLanguage": [
          "sample string 1",
          "sample string 2"
        ],
        "ProviderRate": 3.0,
        "ProviderPerformance": 4.0,
        "NeedHelpLanguage": "sample string 5",
        "SupportCall": true,
        "SupportVideo": true,
        "SupportText": true,
        "ProfileImage": {
          "FileName": "sample string 1",
          "MimeType": "sample string 2",
          "ImageData": "sample string 3",
          "ServerImageId": 1
        },
        "ProviderSpecialTypeId": 9,
        "isSchedule": {
          "ScheduledRequestId": 1,
          "ScheduledBlockId": 1,
          "startUtcDate": "2025-04-25T15:19:26.2846051Z",
          "startUtcDateStr": "sample string 1",
          "ScheduleDuration": 1,
          "PersonId": 1,
          "ClientName": "sample string 2",
          "PIN": "sample string 3",
          "ForceId": "sample string 4",
          "PersonName": "sample string 5",
          "PersonEmail": "sample string 6",
          "PersonPhoneNumber": "sample string 7",
          "ClientUserId": 1,
          "FromLanguageId": 1,
          "FromLanguage": "sample string 8",
          "ToLanguageId": 1,
          "ToLanguage": "sample string 9",
          "ProductName": "sample string 10",
          "ProductDescription": "sample string 11",
          "ProviderId": 1,
          "ProviderEmail": "sample string 12",
          "ProviderPhoneNumber": "sample string 13",
          "ProviderName": "sample string 14",
          "ScheduleStatusDescription": "sample string 15",
          "ScheduleStatusId": 1,
          "BillPersonPrechargeProductId": 1,
          "ScheduledRequestRoutingStatusCodeId": 1,
          "ScheduledRequestRoutingStatus": "sample string 16",
          "JoinAvailable": true,
          "callPurpose": "sample string 17",
          "ConfirmationNumber": "sample string 18",
          "GenderOptionCode": "sample string 19",
          "VideoOptionCode": "sample string 20",
          "IsOffered": true,
          "ScheduledRequestProviderId": 1
        },
        "AnyMeetingExist": true
      }
    ],
    "waitingMsg": "sample string 1",
    "RequestConferenceSessionVideoParticipantId": 1,
    "ToLanguageId": 1,
    "ToLanguage": "sample string 2",
    "additionalInfo": "sample string 3"
  }
}

application/xml, text/xml

Sample:

<ResultVideoConferenceParticipant xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <AppClientEmail>sample string 7</AppClientEmail>
  <AppClientName>sample string 9</AppClientName>
  <AppClientPhoneNumber>sample string 8</AppClientPhoneNumber>
  <PersonName>sample string 5</PersonName>
  <ProviderName>sample string 6</ProviderName>
  <RequestConferenceSessionId>1</RequestConferenceSessionId>
  <RequestConferenceSessionVideoParticipantId>2</RequestConferenceSessionVideoParticipantId>
  <RequestConferenceSessionVideoStatusCodeId>4</RequestConferenceSessionVideoStatusCodeId>
  <RequestConferenceSessionVideoTypeCodeId>3</RequestConferenceSessionVideoTypeCodeId>
  <VideoAccountIdentity>sample string 10</VideoAccountIdentity>
  <secondRequest>
    <RequestConferenceSessionVideoParticipantId>1</RequestConferenceSessionVideoParticipantId>
    <RequestStatusCodeId>1</RequestStatusCodeId>
    <ToLanguage>sample string 2</ToLanguage>
    <ToLanguageId>1</ToLanguageId>
    <additionalInfo>sample string 3</additionalInfo>
    <providerList>
      <ParaRequestProvider>
        <AnyMeetingExist>true</AnyMeetingExist>
        <Name>sample string 2</Name>
        <NativeLanguage xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </NativeLanguage>
        <NeedHelpLanguage>sample string 5</NeedHelpLanguage>
        <OtherLanguage xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </OtherLanguage>
        <ProfileImage>
          <FileName>sample string 1</FileName>
          <ImageData>sample string 3</ImageData>
          <MimeType>sample string 2</MimeType>
          <ServerImageId>1</ServerImageId>
        </ProfileImage>
        <ProviderPerformance>4</ProviderPerformance>
        <ProviderRate>3</ProviderRate>
        <ProviderSpecialTypeId>9</ProviderSpecialTypeId>
        <RequestProviderId>1</RequestProviderId>
        <SupportCall>true</SupportCall>
        <SupportText>true</SupportText>
        <SupportVideo>true</SupportVideo>
        <isSchedule>
          <BillPersonPrechargeProductId>1</BillPersonPrechargeProductId>
          <ClientName>sample string 2</ClientName>
          <ClientUserId>1</ClientUserId>
          <ConfirmationNumber>sample string 18</ConfirmationNumber>
          <ForceId>sample string 4</ForceId>
          <FromLanguage>sample string 8</FromLanguage>
          <FromLanguageId>1</FromLanguageId>
          <GenderOptionCode>sample string 19</GenderOptionCode>
          <IsOffered>true</IsOffered>
          <JoinAvailable>true</JoinAvailable>
          <PIN>sample string 3</PIN>
          <PersonEmail>sample string 6</PersonEmail>
          <PersonId>1</PersonId>
          <PersonName>sample string 5</PersonName>
          <PersonPhoneNumber>sample string 7</PersonPhoneNumber>
          <ProductDescription>sample string 11</ProductDescription>
          <ProductName>sample string 10</ProductName>
          <ProviderEmail>sample string 12</ProviderEmail>
          <ProviderId>1</ProviderId>
          <ProviderName>sample string 14</ProviderName>
          <ProviderPhoneNumber>sample string 13</ProviderPhoneNumber>
          <ScheduleDuration>1</ScheduleDuration>
          <ScheduleStatusDescription>sample string 15</ScheduleStatusDescription>
          <ScheduleStatusId>1</ScheduleStatusId>
          <ScheduledBlockId>1</ScheduledBlockId>
          <ScheduledRequestId>1</ScheduledRequestId>
          <ScheduledRequestProviderId>1</ScheduledRequestProviderId>
          <ScheduledRequestRoutingStatus>sample string 16</ScheduledRequestRoutingStatus>
          <ScheduledRequestRoutingStatusCodeId>1</ScheduledRequestRoutingStatusCodeId>
          <ToLanguage>sample string 9</ToLanguage>
          <ToLanguageId>1</ToLanguageId>
          <VideoOptionCode>sample string 20</VideoOptionCode>
          <callPurpose>sample string 17</callPurpose>
          <startUtcDate>2025-04-25T15:19:26.2846051Z</startUtcDate>
          <startUtcDateStr>sample string 1</startUtcDateStr>
        </isSchedule>
      </ParaRequestProvider>
      <ParaRequestProvider>
        <AnyMeetingExist>true</AnyMeetingExist>
        <Name>sample string 2</Name>
        <NativeLanguage xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </NativeLanguage>
        <NeedHelpLanguage>sample string 5</NeedHelpLanguage>
        <OtherLanguage xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </OtherLanguage>
        <ProfileImage>
          <FileName>sample string 1</FileName>
          <ImageData>sample string 3</ImageData>
          <MimeType>sample string 2</MimeType>
          <ServerImageId>1</ServerImageId>
        </ProfileImage>
        <ProviderPerformance>4</ProviderPerformance>
        <ProviderRate>3</ProviderRate>
        <ProviderSpecialTypeId>9</ProviderSpecialTypeId>
        <RequestProviderId>1</RequestProviderId>
        <SupportCall>true</SupportCall>
        <SupportText>true</SupportText>
        <SupportVideo>true</SupportVideo>
        <isSchedule>
          <BillPersonPrechargeProductId>1</BillPersonPrechargeProductId>
          <ClientName>sample string 2</ClientName>
          <ClientUserId>1</ClientUserId>
          <ConfirmationNumber>sample string 18</ConfirmationNumber>
          <ForceId>sample string 4</ForceId>
          <FromLanguage>sample string 8</FromLanguage>
          <FromLanguageId>1</FromLanguageId>
          <GenderOptionCode>sample string 19</GenderOptionCode>
          <IsOffered>true</IsOffered>
          <JoinAvailable>true</JoinAvailable>
          <PIN>sample string 3</PIN>
          <PersonEmail>sample string 6</PersonEmail>
          <PersonId>1</PersonId>
          <PersonName>sample string 5</PersonName>
          <PersonPhoneNumber>sample string 7</PersonPhoneNumber>
          <ProductDescription>sample string 11</ProductDescription>
          <ProductName>sample string 10</ProductName>
          <ProviderEmail>sample string 12</ProviderEmail>
          <ProviderId>1</ProviderId>
          <ProviderName>sample string 14</ProviderName>
          <ProviderPhoneNumber>sample string 13</ProviderPhoneNumber>
          <ScheduleDuration>1</ScheduleDuration>
          <ScheduleStatusDescription>sample string 15</ScheduleStatusDescription>
          <ScheduleStatusId>1</ScheduleStatusId>
          <ScheduledBlockId>1</ScheduledBlockId>
          <ScheduledRequestId>1</ScheduledRequestId>
          <ScheduledRequestProviderId>1</ScheduledRequestProviderId>
          <ScheduledRequestRoutingStatus>sample string 16</ScheduledRequestRoutingStatus>
          <ScheduledRequestRoutingStatusCodeId>1</ScheduledRequestRoutingStatusCodeId>
          <ToLanguage>sample string 9</ToLanguage>
          <ToLanguageId>1</ToLanguageId>
          <VideoOptionCode>sample string 20</VideoOptionCode>
          <callPurpose>sample string 17</callPurpose>
          <startUtcDate>2025-04-25T15:19:26.2846051Z</startUtcDate>
          <startUtcDateStr>sample string 1</startUtcDateStr>
        </isSchedule>
      </ParaRequestProvider>
    </providerList>
    <waitingMsg>sample string 1</waitingMsg>
  </secondRequest>
</ResultVideoConferenceParticipant>