POST WEYIServer/Provider/Token

As the host server, create corresponding Provider that is hosted in the remote server and return ProviderSessionToken for Relay calls

Request Information

URI Parameters

None.

Body Parameters

ParaWebServer_Provider

Name	Description	Type	Additional information
ProviderInfo		ParaProvider	None.
SecurityItem		ParaWebServerSecurity	None.

Request Formats

application/json, text/json

Sample:

{
  "ProviderInfo": {
    "Id": 1,
    "SystemLanguageId": 1,
    "Name": "sample string 1",
    "LastName": "sample string 2",
    "Email": "sample string 3",
    "RegionId": 1,
    "RegionCode": "sample string 4",
    "RegionShortCode": "sample string 5",
    "MobilePhone": "sample string 6",
    "Password": "sample string 7",
    "FacebookEmail": "sample string 8",
    "StatusCodeId": 9,
    "Status": "sample string 10",
    "RegistrationStatusCodeId": 1,
    "TrainStatusCodeId": 1,
    "CountryCode": "sample string 11",
    "IsWebApp": true,
    "VideoImageName": "sample string 12",
    "Editable": true,
    "DisableProviderScriptAnimation": true,
    "CustomizedPauseImageNeeded": true,
    "CustomizedPauseImageName": "sample string 13",
    "ServiceType": "sample string 14",
    "CultureInfo": {
      "DateDisplay": "sample string 1",
      "TimeDisplay": "sample string 2",
      "DateTimeDisplay": "sample string 3",
      "CurrencyDisplay": "sample string 4"
    },
    "IfShowNotPayable": true,
    "tipaltiProviderConfig": {
      "IfShowNotPayable": true,
      "IfShowPaymentButton": true
    },
    "NextAction": {
      "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:43:14.4712209Z"
          },
          {
            "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:43:14.4712209Z"
          }
        ],
        "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:43:14.4712209Z"
          },
          {
            "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:43:14.4712209Z"
          }
        ],
        "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
      }
    }
  },
  "SecurityItem": {
    "GlobalId": 1,
    "AuthKeyFrom": "sample string 2",
    "AuthKeyTo": "sample string 3"
  }
}

application/xml, text/xml

Sample:

<ParaWebServer_Provider xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <SecurityItem>
    <AuthKeyFrom>sample string 2</AuthKeyFrom>
    <AuthKeyTo>sample string 3</AuthKeyTo>
    <GlobalId>1</GlobalId>
  </SecurityItem>
  <ProviderInfo>
    <CountryCode>sample string 11</CountryCode>
    <CultureInfo>
      <CurrencyDisplay>sample string 4</CurrencyDisplay>
      <DateDisplay>sample string 1</DateDisplay>
      <DateTimeDisplay>sample string 3</DateTimeDisplay>
      <TimeDisplay>sample string 2</TimeDisplay>
    </CultureInfo>
    <CustomizedPauseImageName>sample string 13</CustomizedPauseImageName>
    <CustomizedPauseImageNeeded>true</CustomizedPauseImageNeeded>
    <DisableProviderScriptAnimation>true</DisableProviderScriptAnimation>
    <Editable>true</Editable>
    <Email>sample string 3</Email>
    <FacebookEmail>sample string 8</FacebookEmail>
    <Id>1</Id>
    <IfShowNotPayable>true</IfShowNotPayable>
    <IsWebApp>true</IsWebApp>
    <LastName>sample string 2</LastName>
    <MobilePhone>sample string 6</MobilePhone>
    <Name>sample string 1</Name>
    <NextAction>
      <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:d4p1="http://schemas.datacontract.org/2004/07/WEYILib">
        <d4p1:OfflineInterpreterList>
          <d4p1:WEYIDispatcherManager.OfflineInterpreter>
            <d4p1:Assigned>true</d4p1:Assigned>
            <d4p1:Company>sample string 7</d4p1:Company>
            <d4p1:ContactHelperUrl>sample string 16</d4p1:ContactHelperUrl>
            <d4p1:FromLanguage>sample string 9</d4p1:FromLanguage>
            <d4p1:FromLanguageId>8</d4p1:FromLanguageId>
            <d4p1:Gender>sample string 13</d4p1:Gender>
            <d4p1:PhoneNumber>sample string 15</d4p1:PhoneNumber>
            <d4p1:ProviderId>4</d4p1:ProviderId>
            <d4p1:ProviderName>sample string 5</d4p1:ProviderName>
            <d4p1:ProviderServiceId>6</d4p1:ProviderServiceId>
            <d4p1:ToLanguage>sample string 11</d4p1:ToLanguage>
            <d4p1:ToLanguageId>10</d4p1:ToLanguageId>
            <d4p1:VideoSupportOptionCode>sample string 17</d4p1:VideoSupportOptionCode>
            <d4p1:isOnline>true</d4p1:isOnline>
            <d4p1:nextScheduleTime>2025-04-25T15:43:14.4712209Z</d4p1:nextScheduleTime>
            <d4p1:AvailableCodeId>1</d4p1:AvailableCodeId>
            <d4p1:InterpreterContactStatus>sample string 3</d4p1:InterpreterContactStatus>
            <d4p1:InterpreterContactStatusCodeId>2</d4p1:InterpreterContactStatusCodeId>
          </d4p1:WEYIDispatcherManager.OfflineInterpreter>
          <d4p1:WEYIDispatcherManager.OfflineInterpreter>
            <d4p1:Assigned>true</d4p1:Assigned>
            <d4p1:Company>sample string 7</d4p1:Company>
            <d4p1:ContactHelperUrl>sample string 16</d4p1:ContactHelperUrl>
            <d4p1:FromLanguage>sample string 9</d4p1:FromLanguage>
            <d4p1:FromLanguageId>8</d4p1:FromLanguageId>
            <d4p1:Gender>sample string 13</d4p1:Gender>
            <d4p1:PhoneNumber>sample string 15</d4p1:PhoneNumber>
            <d4p1:ProviderId>4</d4p1:ProviderId>
            <d4p1:ProviderName>sample string 5</d4p1:ProviderName>
            <d4p1:ProviderServiceId>6</d4p1:ProviderServiceId>
            <d4p1:ToLanguage>sample string 11</d4p1:ToLanguage>
            <d4p1:ToLanguageId>10</d4p1:ToLanguageId>
            <d4p1:VideoSupportOptionCode>sample string 17</d4p1:VideoSupportOptionCode>
            <d4p1:isOnline>true</d4p1:isOnline>
            <d4p1:nextScheduleTime>2025-04-25T15:43:14.4712209Z</d4p1:nextScheduleTime>
            <d4p1:AvailableCodeId>1</d4p1:AvailableCodeId>
            <d4p1:InterpreterContactStatus>sample string 3</d4p1:InterpreterContactStatus>
            <d4p1:InterpreterContactStatusCodeId>2</d4p1:InterpreterContactStatusCodeId>
          </d4p1:WEYIDispatcherManager.OfflineInterpreter>
        </d4p1:OfflineInterpreterList>
        <d4p1:OnlineInterpreterList>
          <d4p1:WEYIDispatcherManager.OnlineInterpreter>
            <d4p1:Assigned>true</d4p1:Assigned>
            <d4p1:Company>sample string 6</d4p1:Company>
            <d4p1:ContactHelperUrl>sample string 15</d4p1:ContactHelperUrl>
            <d4p1:FromLanguage>sample string 8</d4p1:FromLanguage>
            <d4p1:FromLanguageId>7</d4p1:FromLanguageId>
            <d4p1:Gender>sample string 12</d4p1:Gender>
            <d4p1:PhoneNumber>sample string 14</d4p1:PhoneNumber>
            <d4p1:ProviderId>3</d4p1:ProviderId>
            <d4p1:ProviderName>sample string 4</d4p1:ProviderName>
            <d4p1:ProviderServiceId>5</d4p1:ProviderServiceId>
            <d4p1:ToLanguage>sample string 10</d4p1:ToLanguage>
            <d4p1:ToLanguageId>9</d4p1:ToLanguageId>
            <d4p1:VideoSupportOptionCode>sample string 16</d4p1:VideoSupportOptionCode>
            <d4p1:isOnline>true</d4p1:isOnline>
            <d4p1:nextScheduleTime>2025-04-25T15:43:14.4712209Z</d4p1:nextScheduleTime>
            <d4p1:Accepted>true</d4p1:Accepted>
            <d4p1:Routed>true</d4p1:Routed>
          </d4p1:WEYIDispatcherManager.OnlineInterpreter>
          <d4p1:WEYIDispatcherManager.OnlineInterpreter>
            <d4p1:Assigned>true</d4p1:Assigned>
            <d4p1:Company>sample string 6</d4p1:Company>
            <d4p1:ContactHelperUrl>sample string 15</d4p1:ContactHelperUrl>
            <d4p1:FromLanguage>sample string 8</d4p1:FromLanguage>
            <d4p1:FromLanguageId>7</d4p1:FromLanguageId>
            <d4p1:Gender>sample string 12</d4p1:Gender>
            <d4p1:PhoneNumber>sample string 14</d4p1:PhoneNumber>
            <d4p1:ProviderId>3</d4p1:ProviderId>
            <d4p1:ProviderName>sample string 4</d4p1:ProviderName>
            <d4p1:ProviderServiceId>5</d4p1:ProviderServiceId>
            <d4p1:ToLanguage>sample string 10</d4p1:ToLanguage>
            <d4p1:ToLanguageId>9</d4p1:ToLanguageId>
            <d4p1:VideoSupportOptionCode>sample string 16</d4p1:VideoSupportOptionCode>
            <d4p1:isOnline>true</d4p1:isOnline>
            <d4p1:nextScheduleTime>2025-04-25T15:43:14.4712209Z</d4p1:nextScheduleTime>
            <d4p1:Accepted>true</d4p1:Accepted>
            <d4p1:Routed>true</d4p1:Routed>
          </d4p1:WEYIDispatcherManager.OnlineInterpreter>
        </d4p1:OnlineInterpreterList>
        <d4p1:OriginalRequestAccepted>true</d4p1:OriginalRequestAccepted>
        <d4p1:shouldAskOPIOption>true</d4p1: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:d4p1="http://schemas.datacontract.org/2004/07/WEYILib">
        <d4p1:AlertMessage>sample string 1</d4p1:AlertMessage>
        <d4p1:NeedAlert>true</d4p1: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>
    </NextAction>
    <Password>sample string 7</Password>
    <RegionCode>sample string 4</RegionCode>
    <RegionId>1</RegionId>
    <RegionShortCode>sample string 5</RegionShortCode>
    <RegistrationStatusCodeId>1</RegistrationStatusCodeId>
    <ServiceType>sample string 14</ServiceType>
    <Status>sample string 10</Status>
    <StatusCodeId>9</StatusCodeId>
    <SystemLanguageId>1</SystemLanguageId>
    <TrainStatusCodeId>1</TrainStatusCodeId>
    <VideoImageName>sample string 12</VideoImageName>
    <tipaltiProviderConfig>
      <IfShowNotPayable>true</IfShowNotPayable>
      <IfShowPaymentButton>true</IfShowPaymentButton>
    </tipaltiProviderConfig>
  </ProviderInfo>
</ParaWebServer_Provider>

Response Information

Resource Description

ParaString

Name	Description	Type	Additional information
Content		string	None.

Response Formats

application/json, text/json

Sample:

{
  "Content": "sample string 1"
}

application/xml, text/xml

Sample:

<ParaString xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <Content>sample string 1</Content>
</ParaString>