POST Provider/Task/NextAction

This function needs to be called to get instruction on what to do next during a Task session. The UI needs to act according to instruction received through this call. For Caller (Interviewer), it needs to call this function after Accepting the task by calling Task/AcceptCandidate/{InterviewId}. For Listener (Provider as the service provider for a Client or provider as Interview Candidate being interviewed), it needs to call this function after Accepting the task by calling Task/AcceptClient/{RequestProviderId} or Task/AcceptInterviewer/{InterviewProviderId}. We support concurrent TextSession independent of a CallSession. If the TextSession is Y, that means the caller has started a TextSession. The listener end needs to determine whether to show the TextSession screen. Possible next actions: Confirmed, Call, Listen, Video, VideoListen, OpenTask, Cancelled, Killed, P, RequestFinished. Please check description of ResultOpenTaskNextAction for more detail.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

ResultOpenTaskNextAction

Name	Type	Additional information
NextActionId	integer	None.
NextAction	string	None.
TextSession	string	None.
CallEngineAccounts	ParaCallEngineAccountPair	None.
VideoEngineAccounts	ParaVideoEngineAccountPair	None.
TextSessionId	integer	None.
TextBlockId	integer	None.
OtherPartyOffline	boolean	None.
CallDisconnected	boolean	None.
VideoDisconnected	boolean	None.
ConferenceCall	ResultConferenceCall	None.
DispatcherModelInfo	DispatcherModelInterpreterInfo	None.
EARequestInfo	EAIntegrationRequestInternal	None.
EATwilioRequestInfo	EATwilioIntegrationRequestInternal	None.
isEARequest	boolean	None.
QuitEnabled	boolean	None.
RerouteEnabled	boolean	None.
RerouteVoyceCommunityOnlyOptionAvailable	boolean	None.
AdditionalInfo	string	None.
DataSessionEnabled	boolean	None.
isBARequest	boolean	None.
BARequest	ParaBARequest	None.
isSARequest	boolean	None.
SARequest	SAAlertPopUp	None.

Response Formats

application/json, text/json

Sample:

{
  "NextActionId": 1,
  "NextAction": "sample string 2",
  "TextSession": "sample string 3",
  "CallEngineAccounts": {
    "Caller": {
      "AccountNumber": "sample string 1",
      "ExpirationSeconds": 2,
      "Purpose": "sample string 3"
    },
    "Listener": {
      "AccountNumber": "sample string 1",
      "ExpirationSeconds": 2,
      "Purpose": "sample string 3"
    },
    "IsCallerOffline": true,
    "IsListenerOffline": true,
    "Killed": true,
    "Disconnected": true
  },
  "VideoEngineAccounts": {
    "Caller": {
      "AccountNumber": "sample string 1",
      "ExpirationSeconds": 2,
      "Purpose": "sample string 3"
    },
    "Listener": {
      "AccountNumber": "sample string 1",
      "ExpirationSeconds": 2,
      "Purpose": "sample string 3"
    },
    "IsCallerOffline": true,
    "IsListenerOffline": true,
    "Killed": true,
    "Disconnected": true
  },
  "TextSessionId": 1,
  "TextBlockId": 1,
  "OtherPartyOffline": true,
  "CallDisconnected": true,
  "VideoDisconnected": true,
  "ConferenceCall": {
    "ConferenceCallTypeCodeId": 1,
    "ConferenceRoomName": "sample string 1",
    "ConferenceEngineId": 1,
    "CallPartyStr": "sample string 2",
    "EnableInvitaion": true,
    "InvitationReplaceDTMF": "sample string 3",
    "EnablePSTNInvitation": true,
    "OperatorModelEnabled": true,
    "ControlPanelInitialDisplay": true,
    "ControlPanelTimeOut": 1,
    "VideoImageName": "sample string 4",
    "Editable": true,
    "PersonSignalRegion": "sample string 5",
    "ProviderSignalRegion": "sample string 6"
  },
  "DispatcherModelInfo": {
    "OfflineInterpreterList": [
      {
        "AvailableCodeId": 1,
        "InterpreterContactStatusCodeId": 2,
        "InterpreterContactStatus": "sample string 3",
        "ProviderId": 4,
        "ProviderName": "sample string 5",
        "ProviderServiceId": 6,
        "Company": "sample string 7",
        "FromLanguageId": 8,
        "FromLanguage": "sample string 9",
        "ToLanguageId": 10,
        "ToLanguage": "sample string 11",
        "isOnline": true,
        "Gender": "sample string 13",
        "Assigned": true,
        "PhoneNumber": "sample string 15",
        "ContactHelperUrl": "sample string 16",
        "VideoSupportOptionCode": "sample string 17",
        "nextScheduleTime": "2025-04-25T15:26:38.1899143Z"
      },
      {
        "AvailableCodeId": 1,
        "InterpreterContactStatusCodeId": 2,
        "InterpreterContactStatus": "sample string 3",
        "ProviderId": 4,
        "ProviderName": "sample string 5",
        "ProviderServiceId": 6,
        "Company": "sample string 7",
        "FromLanguageId": 8,
        "FromLanguage": "sample string 9",
        "ToLanguageId": 10,
        "ToLanguage": "sample string 11",
        "isOnline": true,
        "Gender": "sample string 13",
        "Assigned": true,
        "PhoneNumber": "sample string 15",
        "ContactHelperUrl": "sample string 16",
        "VideoSupportOptionCode": "sample string 17",
        "nextScheduleTime": "2025-04-25T15:26:38.1899143Z"
      }
    ],
    "OnlineInterpreterList": [
      {
        "Routed": true,
        "Accepted": true,
        "ProviderId": 3,
        "ProviderName": "sample string 4",
        "ProviderServiceId": 5,
        "Company": "sample string 6",
        "FromLanguageId": 7,
        "FromLanguage": "sample string 8",
        "ToLanguageId": 9,
        "ToLanguage": "sample string 10",
        "isOnline": true,
        "Gender": "sample string 12",
        "Assigned": true,
        "PhoneNumber": "sample string 14",
        "ContactHelperUrl": "sample string 15",
        "VideoSupportOptionCode": "sample string 16",
        "nextScheduleTime": "2025-04-25T15:26:38.1899143Z"
      },
      {
        "Routed": true,
        "Accepted": true,
        "ProviderId": 3,
        "ProviderName": "sample string 4",
        "ProviderServiceId": 5,
        "Company": "sample string 6",
        "FromLanguageId": 7,
        "FromLanguage": "sample string 8",
        "ToLanguageId": 9,
        "ToLanguage": "sample string 10",
        "isOnline": true,
        "Gender": "sample string 12",
        "Assigned": true,
        "PhoneNumber": "sample string 14",
        "ContactHelperUrl": "sample string 15",
        "VideoSupportOptionCode": "sample string 16",
        "nextScheduleTime": "2025-04-25T15:26:38.1899143Z"
      }
    ],
    "OriginalRequestAccepted": true,
    "shouldAskOPIOption": true
  },
  "EARequestInfo": {
    "Reference": "sample string 1",
    "MeetingId": "sample string 2",
    "URL": "sample string 3",
    "CallPartyStr": "sample string 4",
    "Note": "sample string 5",
    "isXframe": true,
    "Height": 1,
    "ScrollY": 1,
    "WindowWidth": 1,
    "WindowHeight": 1,
    "WindowScreenX": 1,
    "WindowScreenY": 1
  },
  "EATwilioRequestInfo": {
    "ReferenceId": "sample string 1",
    "Note": "sample string 2",
    "isVideo": true,
    "VideoInfo": {
      "VideoToken": "sample string 1",
      "RoomName": "sample string 2"
    },
    "AudioInfo": {
      "AudioToken": "sample string 1",
      "To": "sample string 2"
    }
  },
  "isEARequest": true,
  "QuitEnabled": true,
  "RerouteEnabled": true,
  "RerouteVoyceCommunityOnlyOptionAvailable": true,
  "AdditionalInfo": "sample string 4",
  "DataSessionEnabled": true,
  "isBARequest": true,
  "BARequest": {
    "LanguageName": "sample string 1",
    "InstructionPrompt": "sample string 2",
    "ActionAttentionPrompt": "sample string 3",
    "MergeAvailable": true,
    "To": "sample string 5",
    "Merging": true,
    "MergingPrompt": "sample string 7",
    "AlertPrompt": "sample string 8"
  },
  "isSARequest": true,
  "SARequest": {
    "AlertMessage": "sample string 1",
    "NeedAlert": true
  }
}

application/xml, text/xml

Sample:

<ResultOpenTaskNextAction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <AdditionalInfo>sample string 4</AdditionalInfo>
  <BARequest>
    <ActionAttentionPrompt>sample string 3</ActionAttentionPrompt>
    <AlertPrompt>sample string 8</AlertPrompt>
    <InstructionPrompt>sample string 2</InstructionPrompt>
    <LanguageName>sample string 1</LanguageName>
    <MergeAvailable>true</MergeAvailable>
    <Merging>true</Merging>
    <MergingPrompt>sample string 7</MergingPrompt>
    <To>sample string 5</To>
  </BARequest>
  <CallDisconnected>true</CallDisconnected>
  <CallEngineAccounts>
    <Caller>
      <AccountNumber>sample string 1</AccountNumber>
      <ExpirationSeconds>2</ExpirationSeconds>
      <Purpose>sample string 3</Purpose>
    </Caller>
    <Disconnected>true</Disconnected>
    <IsCallerOffline>true</IsCallerOffline>
    <IsListenerOffline>true</IsListenerOffline>
    <Killed>true</Killed>
    <Listener>
      <AccountNumber>sample string 1</AccountNumber>
      <ExpirationSeconds>2</ExpirationSeconds>
      <Purpose>sample string 3</Purpose>
    </Listener>
  </CallEngineAccounts>
  <ConferenceCall>
    <CallPartyStr>sample string 2</CallPartyStr>
    <ConferenceCallTypeCodeId>1</ConferenceCallTypeCodeId>
    <ConferenceEngineId>1</ConferenceEngineId>
    <ConferenceRoomName>sample string 1</ConferenceRoomName>
    <ControlPanelInitialDisplay>true</ControlPanelInitialDisplay>
    <ControlPanelTimeOut>1</ControlPanelTimeOut>
    <Editable>true</Editable>
    <EnableInvitaion>true</EnableInvitaion>
    <EnablePSTNInvitation>true</EnablePSTNInvitation>
    <InvitationReplaceDTMF>sample string 3</InvitationReplaceDTMF>
    <OperatorModelEnabled>true</OperatorModelEnabled>
    <PersonSignalRegion>sample string 5</PersonSignalRegion>
    <ProviderSignalRegion>sample string 6</ProviderSignalRegion>
    <VideoImageName>sample string 4</VideoImageName>
  </ConferenceCall>
  <DataSessionEnabled>true</DataSessionEnabled>
  <DispatcherModelInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/WEYILib">
    <d2p1:OfflineInterpreterList>
      <d2p1:WEYIDispatcherManager.OfflineInterpreter>
        <d2p1:Assigned>true</d2p1:Assigned>
        <d2p1:Company>sample string 7</d2p1:Company>
        <d2p1:ContactHelperUrl>sample string 16</d2p1:ContactHelperUrl>
        <d2p1:FromLanguage>sample string 9</d2p1:FromLanguage>
        <d2p1:FromLanguageId>8</d2p1:FromLanguageId>
        <d2p1:Gender>sample string 13</d2p1:Gender>
        <d2p1:PhoneNumber>sample string 15</d2p1:PhoneNumber>
        <d2p1:ProviderId>4</d2p1:ProviderId>
        <d2p1:ProviderName>sample string 5</d2p1:ProviderName>
        <d2p1:ProviderServiceId>6</d2p1:ProviderServiceId>
        <d2p1:ToLanguage>sample string 11</d2p1:ToLanguage>
        <d2p1:ToLanguageId>10</d2p1:ToLanguageId>
        <d2p1:VideoSupportOptionCode>sample string 17</d2p1:VideoSupportOptionCode>
        <d2p1:isOnline>true</d2p1:isOnline>
        <d2p1:nextScheduleTime>2025-04-25T15:26:38.1899143Z</d2p1:nextScheduleTime>
        <d2p1:AvailableCodeId>1</d2p1:AvailableCodeId>
        <d2p1:InterpreterContactStatus>sample string 3</d2p1:InterpreterContactStatus>
        <d2p1:InterpreterContactStatusCodeId>2</d2p1:InterpreterContactStatusCodeId>
      </d2p1:WEYIDispatcherManager.OfflineInterpreter>
      <d2p1:WEYIDispatcherManager.OfflineInterpreter>
        <d2p1:Assigned>true</d2p1:Assigned>
        <d2p1:Company>sample string 7</d2p1:Company>
        <d2p1:ContactHelperUrl>sample string 16</d2p1:ContactHelperUrl>
        <d2p1:FromLanguage>sample string 9</d2p1:FromLanguage>
        <d2p1:FromLanguageId>8</d2p1:FromLanguageId>
        <d2p1:Gender>sample string 13</d2p1:Gender>
        <d2p1:PhoneNumber>sample string 15</d2p1:PhoneNumber>
        <d2p1:ProviderId>4</d2p1:ProviderId>
        <d2p1:ProviderName>sample string 5</d2p1:ProviderName>
        <d2p1:ProviderServiceId>6</d2p1:ProviderServiceId>
        <d2p1:ToLanguage>sample string 11</d2p1:ToLanguage>
        <d2p1:ToLanguageId>10</d2p1:ToLanguageId>
        <d2p1:VideoSupportOptionCode>sample string 17</d2p1:VideoSupportOptionCode>
        <d2p1:isOnline>true</d2p1:isOnline>
        <d2p1:nextScheduleTime>2025-04-25T15:26:38.1899143Z</d2p1:nextScheduleTime>
        <d2p1:AvailableCodeId>1</d2p1:AvailableCodeId>
        <d2p1:InterpreterContactStatus>sample string 3</d2p1:InterpreterContactStatus>
        <d2p1:InterpreterContactStatusCodeId>2</d2p1:InterpreterContactStatusCodeId>
      </d2p1:WEYIDispatcherManager.OfflineInterpreter>
    </d2p1:OfflineInterpreterList>
    <d2p1:OnlineInterpreterList>
      <d2p1:WEYIDispatcherManager.OnlineInterpreter>
        <d2p1:Assigned>true</d2p1:Assigned>
        <d2p1:Company>sample string 6</d2p1:Company>
        <d2p1:ContactHelperUrl>sample string 15</d2p1:ContactHelperUrl>
        <d2p1:FromLanguage>sample string 8</d2p1:FromLanguage>
        <d2p1:FromLanguageId>7</d2p1:FromLanguageId>
        <d2p1:Gender>sample string 12</d2p1:Gender>
        <d2p1:PhoneNumber>sample string 14</d2p1:PhoneNumber>
        <d2p1:ProviderId>3</d2p1:ProviderId>
        <d2p1:ProviderName>sample string 4</d2p1:ProviderName>
        <d2p1:ProviderServiceId>5</d2p1:ProviderServiceId>
        <d2p1:ToLanguage>sample string 10</d2p1:ToLanguage>
        <d2p1:ToLanguageId>9</d2p1:ToLanguageId>
        <d2p1:VideoSupportOptionCode>sample string 16</d2p1:VideoSupportOptionCode>
        <d2p1:isOnline>true</d2p1:isOnline>
        <d2p1:nextScheduleTime>2025-04-25T15:26:38.1899143Z</d2p1:nextScheduleTime>
        <d2p1:Accepted>true</d2p1:Accepted>
        <d2p1:Routed>true</d2p1:Routed>
      </d2p1:WEYIDispatcherManager.OnlineInterpreter>
      <d2p1:WEYIDispatcherManager.OnlineInterpreter>
        <d2p1:Assigned>true</d2p1:Assigned>
        <d2p1:Company>sample string 6</d2p1:Company>
        <d2p1:ContactHelperUrl>sample string 15</d2p1:ContactHelperUrl>
        <d2p1:FromLanguage>sample string 8</d2p1:FromLanguage>
        <d2p1:FromLanguageId>7</d2p1:FromLanguageId>
        <d2p1:Gender>sample string 12</d2p1:Gender>
        <d2p1:PhoneNumber>sample string 14</d2p1:PhoneNumber>
        <d2p1:ProviderId>3</d2p1:ProviderId>
        <d2p1:ProviderName>sample string 4</d2p1:ProviderName>
        <d2p1:ProviderServiceId>5</d2p1:ProviderServiceId>
        <d2p1:ToLanguage>sample string 10</d2p1:ToLanguage>
        <d2p1:ToLanguageId>9</d2p1:ToLanguageId>
        <d2p1:VideoSupportOptionCode>sample string 16</d2p1:VideoSupportOptionCode>
        <d2p1:isOnline>true</d2p1:isOnline>
        <d2p1:nextScheduleTime>2025-04-25T15:26:38.1899143Z</d2p1:nextScheduleTime>
        <d2p1:Accepted>true</d2p1:Accepted>
        <d2p1:Routed>true</d2p1:Routed>
      </d2p1:WEYIDispatcherManager.OnlineInterpreter>
    </d2p1:OnlineInterpreterList>
    <d2p1:OriginalRequestAccepted>true</d2p1:OriginalRequestAccepted>
    <d2p1:shouldAskOPIOption>true</d2p1:shouldAskOPIOption>
  </DispatcherModelInfo>
  <EARequestInfo>
    <CallPartyStr>sample string 4</CallPartyStr>
    <Height>1</Height>
    <MeetingId>sample string 2</MeetingId>
    <Note>sample string 5</Note>
    <Reference>sample string 1</Reference>
    <ScrollY>1</ScrollY>
    <URL>sample string 3</URL>
    <WindowHeight>1</WindowHeight>
    <WindowScreenX>1</WindowScreenX>
    <WindowScreenY>1</WindowScreenY>
    <WindowWidth>1</WindowWidth>
    <isXframe>true</isXframe>
  </EARequestInfo>
  <EATwilioRequestInfo>
    <AudioInfo>
      <AudioToken>sample string 1</AudioToken>
      <To>sample string 2</To>
    </AudioInfo>
    <Note>sample string 2</Note>
    <ReferenceId>sample string 1</ReferenceId>
    <VideoInfo>
      <RoomName>sample string 2</RoomName>
      <VideoToken>sample string 1</VideoToken>
    </VideoInfo>
    <isVideo>true</isVideo>
  </EATwilioRequestInfo>
  <NextAction>sample string 2</NextAction>
  <NextActionId>1</NextActionId>
  <OtherPartyOffline>true</OtherPartyOffline>
  <QuitEnabled>true</QuitEnabled>
  <RerouteEnabled>true</RerouteEnabled>
  <RerouteVoyceCommunityOnlyOptionAvailable>true</RerouteVoyceCommunityOnlyOptionAvailable>
  <SARequest xmlns:d2p1="http://schemas.datacontract.org/2004/07/WEYILib">
    <d2p1:AlertMessage>sample string 1</d2p1:AlertMessage>
    <d2p1:NeedAlert>true</d2p1:NeedAlert>
  </SARequest>
  <TextBlockId>1</TextBlockId>
  <TextSession>sample string 3</TextSession>
  <TextSessionId>1</TextSessionId>
  <VideoDisconnected>true</VideoDisconnected>
  <VideoEngineAccounts>
    <Caller>
      <AccountNumber>sample string 1</AccountNumber>
      <ExpirationSeconds>2</ExpirationSeconds>
      <Purpose>sample string 3</Purpose>
    </Caller>
    <Disconnected>true</Disconnected>
    <IsCallerOffline>true</IsCallerOffline>
    <IsListenerOffline>true</IsListenerOffline>
    <Killed>true</Killed>
    <Listener>
      <AccountNumber>sample string 1</AccountNumber>
      <ExpirationSeconds>2</ExpirationSeconds>
      <Purpose>sample string 3</Purpose>
    </Listener>
  </VideoEngineAccounts>
  <isBARequest>true</isBARequest>
  <isEARequest>true</isEARequest>
  <isSARequest>true</isSARequest>
</ResultOpenTaskNextAction>