POST Request/InviteWithoutLanguage

Initiate a request without language and option selection. This API needs to be called when the third party wants to use the Voyce Language and Option Selection Web module.

Request Information

URI Parameters

None.

Body Parameters

Detail of the request

EATwilioIntegrationRequestWithoutLanguage

Name	Description	Type	Additional information
Reference	Reference Number. It could be used as a unique key for the request	string	None.
MeetingId	Meeting Id	string	None.
Note	Note, will be displayed to the interpreter	string	None.
ClientUserInfo	Client User Info provided by the Third Party System	EAIntegrationClientAndUserInfo	None.
isVideo	Whether it is a video call.	boolean	None.
VideoInfo	Twilio video information, this is needed if it is a video call	EATwilioVideoInfo	None.
AudioInfo	Twilio audio information, this is needed if it is an audio call	EATwilioAudioInfo	None.

Request Formats

application/json, text/json

Sample:

{
  "Reference": "sample string 1",
  "MeetingId": "sample string 2",
  "Note": "sample string 3",
  "ClientUserInfo": {
    "ClientId": "sample string 1",
    "ClientName": "sample string 2",
    "UserId": "sample string 3",
    "UserName": "sample string 4",
    "AdditionalInfo": "sample string 5"
  },
  "isVideo": true,
  "VideoInfo": {
    "VideoToken": "sample string 1",
    "RoomName": "sample string 2"
  },
  "AudioInfo": {
    "AudioToken": "sample string 1",
    "To": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<EATwilioIntegrationRequestWithoutLanguage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <AudioInfo>
    <AudioToken>sample string 1</AudioToken>
    <To>sample string 2</To>
  </AudioInfo>
  <ClientUserInfo>
    <AdditionalInfo>sample string 5</AdditionalInfo>
    <ClientId>sample string 1</ClientId>
    <ClientName>sample string 2</ClientName>
    <UserId>sample string 3</UserId>
    <UserName>sample string 4</UserName>
  </ClientUserInfo>
  <MeetingId>sample string 2</MeetingId>
  <Note>sample string 3</Note>
  <Reference>sample string 1</Reference>
  <VideoInfo>
    <RoomName>sample string 2</RoomName>
    <VideoToken>sample string 1</VideoToken>
  </VideoInfo>
  <isVideo>true</isVideo>
</EATwilioIntegrationRequestWithoutLanguage>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'EATwilioIntegrationRequestWithoutLanguage'.

Response Information

Resource Description

URL to the Voyce web app for language and other option selection, as well as a PreInviteToken that will be used to uniquely identy the session.

EAIntegrationResultRequestWithoutLanguage

Name	Description	Type	Additional information
PreInviteToken	The token generated by Voyce that is returned to the Third Party System before an invitation to an interpreter	string	None.
URL	The token generated by Voyce that is returned to the Third Party System before an invitation to an interpreter	string	None.
Successful	Whether the function call is successful True: Successful False: Failed	boolean	None.
Reason	If the call is failed, return the reason.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "PreInviteToken": "sample string 1",
  "URL": "sample string 2",
  "Successful": true,
  "Reason": "sample string 4"
}

application/xml, text/xml

Sample:

<EAIntegrationResultRequestWithoutLanguage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <Reason>sample string 4</Reason>
  <Successful>true</Successful>
  <PreInviteToken>sample string 1</PreInviteToken>
  <URL>sample string 2</URL>
</EAIntegrationResultRequestWithoutLanguage>