GET Request/StatusByPreInviteToken?PreInviteToken={PreInviteToken}

Get the status of a request

Request Information

URI Parameters

Name	Description	Type	Additional information
PreInviteToken	PreInviteToken returned with the API call to InviteWithoutLangauge	string	Required

Body Parameters

None.

Response Information

Resource Description

0: Not Initiated 1: New 2: In Service 3: Serviced 4: Cancelled 5: Interpreter Accepted 9: No Interpreter Available

EAIntegrationResultRequestStatus

Name	Description	Type	Additional information
RequestId	Return the Request Id assigned by Voyce	integer	None.
Status	Status 0: Not Initiated 1: New 2: In Service 3: Serviced 4: Cancelled 5: Interpreter Accepted 9: No Interpreter Available	string	None.
StatusCodeId	Status CodeId 0: Not Initiated 1: New 2: In Service 3: Serviced 4: Cancelled 5: Interpreter Accepted 9: No Interpreter Available	integer	None.
EstimationTimeString	This is an estimated waiting time we provide to the customer Sample Result: Your estimated waiting time is less than 30 seconds.	string	None.
InterpreterID	Interpreter ID	string	None.
InterpreterName	Interpreter Name	string	None.
RequestDetail	Request Detail. If the request is initiated through the Voyce Language and Option Selection Web Module, this will return the details of the Request.	EAIntegrationRequest	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:

{
  "RequestId": 1,
  "Status": "sample string 1",
  "StatusCodeId": 2,
  "EstimationTimeString": "sample string 3",
  "InterpreterID": "sample string 4",
  "InterpreterName": "sample string 5",
  "RequestDetail": {
    "LanguageId": 1,
    "SpecialtyOptionCodeId": 1,
    "VideoOptionCodeId": 1,
    "GenderOptionCodeId": 1,
    "Reference": "sample string 2",
    "MeetingId": "sample string 3",
    "Note": "sample string 4",
    "URL": "sample string 5",
    "USPhone": "sample string 6",
    "PhoneAccessCode": "sample string 7",
    "ClientUserInfo": {
      "ClientId": "sample string 1",
      "ClientName": "sample string 2",
      "UserId": "sample string 3",
      "UserName": "sample string 4",
      "AdditionalInfo": "sample string 5"
    }
  },
  "Successful": true,
  "Reason": "sample string 7"
}

application/xml, text/xml

Sample:

<EAIntegrationResultRequestStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <Reason>sample string 7</Reason>
  <Successful>true</Successful>
  <EstimationTimeString>sample string 3</EstimationTimeString>
  <InterpreterID>sample string 4</InterpreterID>
  <InterpreterName>sample string 5</InterpreterName>
  <RequestDetail>
    <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 3</MeetingId>
    <Note>sample string 4</Note>
    <PhoneAccessCode>sample string 7</PhoneAccessCode>
    <Reference>sample string 2</Reference>
    <URL>sample string 5</URL>
    <USPhone>sample string 6</USPhone>
    <GenderOptionCodeId>1</GenderOptionCodeId>
    <LanguageId>1</LanguageId>
    <SpecialtyOptionCodeId>1</SpecialtyOptionCodeId>
    <VideoOptionCodeId>1</VideoOptionCodeId>
  </RequestDetail>
  <RequestId>1</RequestId>
  <Status>sample string 1</Status>
  <StatusCodeId>2</StatusCodeId>
</EAIntegrationResultRequestStatus>