WEYI API Help Page (v2.25.0225)

Get available server list

Get provider's current status

Get Provider Transation History Url

Get Provider Transation History Url

Login. It will return SecurityToken, which is required to be set as the header value VOYCEToken for subsequent calls.

Logout

Update Name of the Provider

Update Password

Get the list of languages for the Provider

Get the list of eligible service for a provider

Upload Profile Image

Upload Profile Image using Base64 (the size could be 33% more)

Upload Profile Image using Base64 (the size could be 33% more)

Get Profile Image

Get Profile Image using Base64 (the size could be 33% more).

Get Profile Image using Base64 (the size could be 33% more)

Get the list of options for Available dropdownlist

Get the list of options for Days dropdownlist

Get the list of options for Hours dropdownlist

Get provider's weekly working schedule

Get provider's weekly working schedule

Set new working schedule record. It will return provider's one week working schedule

Set new working schedule record. It will return provider's one week working schedule

Get provider's working schedule for today

Gets the list of daily schedule options available for the Provider.

Start password reset request.

Reset Password with verification code

Get the FAQ URL (web version of FAQ)

Get the list of FAQ

Update System Language

Get System Language for the current session

Return the link (URL) for the web app to allow accessing certain functions through the web. Type of URLs: Payment, TransactionHistory, ReferNewProvider, ReferNewClient

Send Device information to the server.

Get ProviderAvailability

Get ProviderAvailability not available minutes list

Set ProviderAvailability

No documentation available.

Get Porider Dedicated Schedule Time Blocks

Return Entity# and DepartmentPin#.

Get list of UIElements that needs to be updated

Get the list of UIElement for selected language

Get the list of UIElement for selected language

Get the list of UI Element Keys for selected app and device

Delete UIElements for all languages pertaining to the given AppName and Element Key.

Set UI Element. UISetupKey is required in the header

Get WEYI Server assigned device token, which will be used for WEYI Server to send notifications to the device

Register local server into the WEYI network of servers

Set PrivateKey and PublicKey for the local server

Register local server into the WEYI network of servers

Sync local server's info with remote servers in the WEYI network

Sync local server's info with remote servers in the WEYI network

Sync local server's info with remote servers in the WEYI network

Sync local server's info with remote servers in the WEYI network

No documentation available.

Process New Server Registration Request. When a new server is launched online, it needs to register itself to all existing servers in the WEYI distributed network.

Process Remote Server Sync Request.

Process Remote Server Sync/DPTAvailableService Request.

Process Remote Server Sync/RequestAvailableService Request.

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

Host server verify an InSession DPT is indeed in service by the same provider

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

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

As the host server, create register provider

As the host server, create register provider

As the host server, Create Person Trial user

As the host server, create RequestProvider for the provider in the remote server and return ProviderSessionToken for Relay calls

As the host server, create RequestProvider for the provider in the remote server and return ProviderSessionToken for Relay calls

As the host server, create DPTProvider for the provider in the remote server and return ProviderSessionToken for Relay calls

As the host server, create DPTProvider for the provider in the remote server and return ProviderSessionToken for Relay calls

Check if the email for a Person is already in use.

Check if the email for a Provider is already in use.

Person Login

Provider Login

Person PasswordResetRequest

Provider PasswordResetRequest

Login using Facebook account. We only need the facebook email account

Login using Facebook account. We only need the facebook email account

Check if the device is already setup for a Person.

Sync Person data between home server and backup server

Sync Provider data between home server and backup server

Sync SysConfig data between home server and backup server

Create PM in remote server

New reuqest from a Person in remote server

New DPT from a Person in remote server

Additional provider search for a Request in remote server

Additional provider search for a DPT in remote server

Cancel request in remote server

Clear request in remote server

Cancel DPT in remote server

Update Request Status in remote server

Update DPT Status in remote server

PM Provider Search

PM Provider Train Action

Test

Test

Get list of Regions

Get one entity

Get one entity

Debug Tool to get ErrorLog info. Special key is required.

ErrorLog

Clear Interview

Debug Tool to get TextSession Content

Get the API version

DeepLink launching mobile

DeepLink launching mobile

DeepLink launching mobile

DeepLink launching mobile

DeepLink launching mobile

DeepLink launching mobile

DeepLink launching mobile

DeepLink launching mobile

upload greeting mp3 file

Return the list of Code. Supported Category: AroundToday CallType DescrCategory DeviceType InterviewProviderCallStatus InterviewProviderStatus InterviewStatus LanguageProficiency MsgDeliveryMethod PersonBillingType PersonPaymentMethod PersonSetupStatus ProviderBillingType ProviderPaymentMethod ProviderScheduleAvailable ProviderScheduleDaysType ProviderScheduleHoursType ProviderServiceApplicationStatus ProviderServiceStatus ProviderSetupStatus ProviderStatus ProviderTodayScheduleOption RequestProviderCallStatus RequestProviderStatus RequestSituation RequestStatus WeekDay

Get one entity object

Inform the server that the caller is having a video session with the other party.

Inform the server that the caller is having a video session with the other party.

Inform the server that the caller is having a video session with the other party.

Inform the server that the caller is having a video session with the other party.

Inform the server that third party join conference

Inform the server that third party leave conference

Inform the server that the caller is having a video session with the other party.

Inform the server that the call is disconnected

Inform the server that the video is disconnected

Before the caller calls Request/Finished, the caller may initiate another phone call. Since every phone call requires a confirmation from the listener before the phone call can be made, it needs to inform the server that it is ready to make another phone call. Once this function is called, the caller needs to call GetCallEngineAccounts in order to get the account info to make the phone call.

Before the caller calls Request/Finished, the caller may initiate another video call. 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 another 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.

Finished the call (Successful or cancelled)

Finished the call (Successful or cancelled)

Finished the request (Successful or cancelled)

NeedSurveyInterpretation

Finished the request (Successful or cancelled)

Get the list of Evaluation Questions. It can only be called after a successful service and before the evaluation is saved

Get the list of Evaluation Questions. It can only be called after a successful service and before the evaluation is saved

To be replaced by the other funciton: Request/Evaluation. Post the answers for those evaluation questions

To be replaced by the other funciton: Request/Evaluation. Post the answers for those evaluation questions

Post the answers for those evaluation questions, plus the evaluation feedback

Direct Provider Translate (DPT): new DPT from MTBlock

Direct Provider Translate (DPT): start new DPT request

Direct Provider Translate (DPT): Get block data from provider

Direct Provider Translate (DPT): Get block data, including both from the sender and from the provider. It is used to get the full content of the DPT block

Get the list of Evaluation Questions for DPT

Post the answers for the evaluation questions and feedback

Get the list of DPT Cancel reason

Direct Provider Translate (DPT): start new DPT request

Direct Provider Translate (DPT): Get the list of DPT requests

Direct Provider Translate (DPT): Get the list of language list

Direct Provider Translation (DPT): Get the list of To Language List for the selected From Language

Direct Provider Translation: Start a DPT session

Direct Provider Translation: Get a DPT session already started

Direct Provider Translate (DPT): start new DPT request

Machine Translation: Start a machine translation session

Machine Translation: Get a machine translation session already started

Machine Translation: get text session content

Machine Translation: End a machine translation session. The session will never end, but we use this function to log user's activity

Machine Translation: Change the selected From Language

Machine Translation: Change the selected To Language

Machine Translation: Switch the selected From/To Language

Machine Translation: Send the block data to the server

Machine Translation: Get the Prompt for redoing the block

Machine Translation: Switch the from and to language and redo the block

Machine Translation: Switch the from and to language and redo the block

Machine Translation: Get block data from the Machine translation

Start a text session

End a text session

Send the block data to the server

Get image

Get Audio

Send Device information to the server.

Get Twilio Token for Phone Call

Get Twilio Token for Phone Call

Get Twilio Conference Video Token

Get Twilio Video Token

Get Room Twilio Video Token

Insert feedback

Get AdditionOptionsLink before send request

Get AdditionOptionsLink Text before send request

Get External Link

Start password reset request.

Reset Password with verification code

Get the FAQ URL (web version of FAQ)

Get the list of FAQ

Update System Language

Get System Language for the current session

Get the number of allowed trials before registration for a given device. If there is, the system automatically generate a security Token for future access. If applicable, it will also return the information (LanguageList) entered during previous trials on the device

Return the link (URL) for the web app to allow accessing certain functions through the web. Type of URLs: ReferNewProvider, ReferNewClient

Upload PromoCode QR Image using Base64

Get the list of CreditCardList for this user

Get the list of CreditCardList for this user

Get the list of CreditCardList for this user

Get the list of CreditCardList for this user

Get whether company support individual enrollment

Get the list of CreditCardList for this user

Bind a CreditCard

Apply a PromoCode in Registration

Remove a PromoCode in Registration

Remove a PromoCode in Registration

Apply a PromoCode in Registration

Apply a GiftCardCode in Setting

Set a creditcard as a default card

Delete a CreditCard

Delete a CreditCard

Refer Other

Get Person Transation History Url

BandWidthUpdate

Get list of Regions

Get Script Url After accept a request

ScriptAction/StartService

ScriptAction/FinishSession

Get Video Conference ParticipantList without token

Camera information update

Get Company ID and Code based on URL

Get Company ID and Code based on URL

Get System Language for the current session

Get System Language for the current session

DeepLink launching mobile

DeepLink launching mobile

DeepLink launching mobile

Get available server list

Get Person's current status

Get Person's current status

Get Person's current status

Set Person's TimeZone

Set current location

Register Client It will return SecurityToken, which is required to be set as the header value WEYIToken for subsequent calls.

Register Client It will return SecurityToken, which is required to be set as the header value WEYIToken for subsequent calls.

Register Client It will return SecurityToken, which is required to be set as the header value WEYIToken for subsequent calls.

Cancel registration

Cancel registration (Android Version)

Login. It will return SecurityToken, which is required to be set as the header value WEYIToken for subsequent calls.

Login Special through the web. It will return SecurityToken, which is required to be set as the header value WEYIToken for subsequent calls.

Login. Web Use Only It will return SecurityToken, which is required to be set as the header value WEYIToken for subsequent calls.

Login by SAML Token (SAML Single Sign On). Web Use Only It will return SecurityToken, which is required to be set as the header value WEYIToken for subsequent calls.

EAIntegration Login by PreInviteToken. Web Use Only It will return SecurityToken, which is required to be set as the header value WEYIToken for subsequent calls.

Single Sign On Login by SingleSignOnToken. Web Use Only It will return SecurityToken, which is required to be set as the header value WEYIToken for subsequent calls.

Validate single sign on. It will return SecurityToken, which is required to be set as the header value WEYIToken for subsequent calls.

Login. It will return SecurityToken, which is required to be set as the header value WEYIToken for subsequent calls.

Submit the deviceInfo based on each market app packages

Login using Facebook account. We only need the facebook email account It will return SecurityToken, which is required to be set as the header value WEYIToken for subsequent calls.

Logout

Start Mobile Number Validation

Confirm Mobile Number Validation Code

Update Name of the Client

Update Password

Upload Profile Image

Upload Profile Image using Base64 (the size could be 33% more)

Get Profile Image

Get Profile Image using Base64 (the size could be 33% more)

Get whether we should ask the Client for the PromoCode. It will also return the PromoCode the system determines based on the information received so far about the client

Save the promo code

Get the list of available languages to be selected from, which will exclue the language already selected.

Get the list of languages for the Client

Update the client's language skill

Replace the client's language skill

Delete Client's language skill record

Delete Client's language skill record (Android Version)

Notify server that the Registration process is done

Get the list of URLs to be displayed in the Home screen

Check if the App needs to be upgraded

Return the list of languages for service based on the person's language skills and location

Return the list of source languages for service for an LSP request

Return the list of source languages for service for an LSP request

Return the list of target languages (language to) for service for an LSP request

Return the list of target languages (language to) for service for an LSP request

Return the list of target languages (language to) for service for an LSP request

Return the list of target languages (language to) for service for an LSP request

Request a new service

Get the result what the person should do after a service

Request a new service

Schedule a new service in product view

Schedule a new service in product view with response

Cancel a new service in product view

Cancel the current schedule service request

Post ScheduleRequestUpdate

Get ScheduleRequestList

Get ScheduleRequestList

Get ListDateTime

Get DurationList

Precheck if there is active scheduled task 1. yes 2. no

Precheck if there is active scheduled task 1. yes 2. no

ScheduledRequest Start ApplicationCompanyCode, ApplicationTypeCodeId, DeviceTypeCodeId, RelatedVersionCode Needed

ScheduledRequest Start ApplicationCompanyCode, ApplicationTypeCodeId, DeviceTypeCodeId, RelatedVersionCode Needed

ScheduledRequestStartFromPanel ApplicationCompanyCode, ApplicationTypeCodeId, DeviceTypeCodeId, RelatedVersionCode Needed

Request a new service in product view

Directly Invitation Request Permission Get 0. No Permission Granted 1. Video Only 2. Audio Only 3. Video and Audio

Directly Invitation Request

Request a new service in product view

Request Recovery Before Accept

Before Request Check

Before Request Check

No documentation available.

Before Request Check

Before Request Check

Request a direrct connect by an agent

Get the list of URLs to be displayed while connecting to a provider

Cancel the current service request

Cancel the specified request

Cancel the current service request (Android Version)

Cancel the specified request (Android Version)

ScheduleRequestCancelQuestion

ScheduleRequestCancelInCalendarQuestion

Cancel the current service request

Cancel the current service request (Android Version)

Get the list of providers who accepted the client's request

Method to record the call happens in Exception Process

Method to get phone number info in Direct Call Process

Method to record the call happens in Direct Call Process

Method to record the call happens in Direct Call Process

Method to record the call happens in Exception Process

Method to record the call happens in Exception Process

Method to record the call happens in Exception Process

Exception Handling Next Action Action need to be executed by client "CallPM" include PM Schedule Id and number "CallBackUp" include Backup Schedule Id and number "ExceptionPMPending" include working button status "Pending" server need to decide which exeption handler state "AssignToProvider" already special routing to a provider "Finish" whole exeption process finished "Killed" exeption time out or other error, server kill by force

Client confirm received provider command

Client confirm receiving BackUpPhoneSystem number in exception process

Client confirm receiving PM number in Exception process

Client confirm the provider

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

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.

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.

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.

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.

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.

Get Video Conference ParticipantList RequestConferenceSessionVideoStatusCodeId: 1 Informed,2 Confirmed,3 ConferenceRouted,4 ConferenceConnected,5 ConferenceDisconnected,6 Finished

Get Video Conference ParticipantList without token RequestConferenceSessionVideoStatusCodeId: 1 Informed,2 Confirmed,3 ConferenceRouted,4 ConferenceConnected,5 ConferenceDisconnected,6 Finished

Get Video Conference ParticipantList without token

Get Video Conference ParticipantList without token

Start the audio conference process. Since every audio conference 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 audio conference.

Request/StartRequestDispatcher

RequestDispatcherCallStart

RequestDispatcherCallStart

RequestDispatcherCallFinish

Kick a participant in Conference

ReconnectInfoGet

Invite third party PSTN to the audio conference process.

RequestConferenceInfoGet 1: calling provider 2: provider connected 3: calling third party 4: third party connected 5: third party leave before you went back to conference 6: in conference 7: finish(should hang up) 8: calling second request 9: second request connected 10: second request interpreter leave before you went back to conference 11: hold 12: Escalated

Merge current individual call to conference

End Individual Call , move person back to conference

Get or create call engine acccounts in order to make call. It needs to be called after calls to these functions: Request/StartCallProcess or Request/CallAgain so that it can obtain the CallEngineAccounts in order to make the call. If the call is not successful, it needs to be called again until either the CallEngineAccounts are obtained from the server, or timeout and it displays failed call info to the user.

Get or create video engine acccounts in order to make video call. It needs to be called after calls to these functions: Request/StartVideoProcess or Request/VideoAgain so that it can obtain the VideoEngineAccounts in order to make the call. If the call is not successful, it needs to be called again until either the VideoEngineAccounts are obtained from the server, or timeout and it displays failed call info to the user.

Ping from the client's device

Ping from the client's device

Inform the server that the caller is calling the other party.

Request transfer confirm

Get list of UIElementCompany that needs to be updated

Get list of UIElementCompany that needs to be updated

Get the list of UIElementCompany for selected language

Get the list of UIElementCompany for selected language

Get the list of UI Element Keys for selected app and device

Send Download Link to Web User

Get Company ID and Code based on URL

Get Company ID based on URL

Return the list of languages

Get one entity

Pre register

Pre register for Provider

No documentation available.

No documentation available.

Login. It will return SecurityToken, which is required to be set as the header value WEYIToken for subsequent calls.

Logout

Ping from the PM's device

Update System Language

Get System Language for the current session

Search for Providers for Training

Provider Training Action

No documentation available.

Get list of supported system languages

Get info about the system language

Update System Language. This is to be replaced by Client/SystemLanguage/{SystemLanguageId:int}, and Provider/SystemLanguage/{SystemLanguageId:int}

No documentation available.

No documentation available.

Provider deny the Scheduled service request from client. After the call is made, the provider app will not receive this request any more the next step

Provider accepted the service request from client. After the call is made, the provider app needs to call Task/NextAction to determine the next step

Provider accepted the service request from client. After the call is made, the provider app needs to call Task/NextAction to determine the next step

Get ScheduleRequestList

Provider accepted the service request from client. After the call is made, the provider app needs to call Task/NextAction to determine the next step

Get Script Url After accept a request

Provider accepted interview request from the interviewer. After the call is made, the provider app needs to call Task/NextAction to determine the next step

Provider accepted task to interview the candidate. After the call is made, the provider app needs to call Task/NextAction to determine the next step

Get the result what the provider should do after a service

If the provider is the interviewer, it can start the call process by calling this function. Since every call requires a confirmation from the listener before the call can be made, it needs to inform the server that it is ready to make call. It needs to call Task/NextAction to get the CallEngine account info in order to make the call.

If the provider is the interviewer, it can start the video call process by calling this function. Since every call requires a confirmation from the listener before the call can be made, it needs to inform the server that it is ready to make video call. It needs to call Task/NextAction to get the VideoEngine account info in order to make the video call.

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.

Ping from the Provider's device.

Mark the current task session for the provider (when the provider is currently a listener) as finished

Mark the current task session for the provider (when the provider is currently a listener) as finished

Mark the current task session for the provider (when the provider is currently a listener) as finished

Reroute the request.

Inform the server that the provider is listening and is ready to accept the call. Whenever the provider is required to listen and started listening successfully, it needs to call this function to inform the server so that the server can inform the other party to start the call.

Inform the server that the provider is listening for the video and is ready to accept the video call. Whenever the provider is required to listen for the video call and started listening for video successfully, it needs to call this function to inform the server so that the server can inform the other party to start the video call.

Inform the server that the provider is listening for the audio conference and is ready to accept the audio conference. Whenever the provider is required to listen for the video call and started listening for video successfully, it needs to call this function to inform the server so that the server can inform the other party to start the video call.

Inform the server that the provider is listening for the video conference and is ready to accept the video conference. Whenever the provider is required to listen for the video call and started listening for video successfully, it needs to call this function to inform the server so that the server can inform the other party to start the video call.

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.

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.

Get Video Conference ParticipantList RequestConferenceSessionVideoStatusCodeId: 1 Informed,2 Confirmed,3 ConferenceRouted,4 ConferenceConnected,5 ConferenceDisconnected,6 Finished

Inform the server that the provider is calling the other party. Whenever the provider is required to call and started calling successfully, it needs to call this function to inform the server.

Inform the server that the provider is in the video call with the other party. Whenever the provider is required to be in a video call and is successful joining the video call, it needs to call this function to inform the server.

Inform the server that the provider is calling the other party. Whenever the provider is required to call and started calling successfully, it needs to call this function to inform the server.

Invite third party PSTN to the audio conference process.

Invite second request to the audio conference process.

RequestConferenceSecondRequestConfirm

RequestConferenceSecondRequestRouteToBackup

RequestConferenceSecondRequestCancel

RequestConferenceInfoGet 1: calling provider 2: provider connected 3: calling third party 4: third party connected 5: third party leave before you went back to conference 6: in conference 7: finish(should hang up) 8: calling second request 9: second request connected 10: second request interpreter leave before you went back to conference 11: hold

Kick a participant in Conference

InterpreterListDispatcherGet

AssignProviderDispatcherModel

UnAssignProviderDispatcherModel

VRIToOPIConfirm

Hold/Unhold a participant in Conference

Hold/Unhold a participant in Conference

StartOperationService

Merge current individual call to conference

Before Escalate

End Individual Call , move person back to conference

Inform the server that the provider is calling the other party. Whenever the provider is required to call and started calling successfully, it needs to call this function to inform the server.

Inform the server that the call is disconnected

Inform the server that the video call is disconnected

Inform the server that the video conference is disconnected

Inform the server that the audio conference is disconnected

Inform the server that the audio conference is disconnected

Before the caller calls Task/CallFinished, the caller may initiate another call. Since every call requires a confirmation from the listener before the call can be made, it needs to inform the server that it is ready to make another call. It needs to call Task/NextAction to get the CallEngine account info in order to make the call.

Before the caller calls Task/Finished, the caller may initiate another video call. 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 another video call. It needs to call Task/NextAction to get the VideoEngine account info in order to make the video call.

Finished the request (Successful or cancelled)

Finished the request (Successful or cancelled)

Get the list of Evaluation Questions based on the current task in session

To be replaced by the other funciton: Request/Evaluation. Post the answers for those evaluation questions

Post the answers for those evaluation questions, plus the evaluation feedback

Start a text session by the Interviewer. Only the Interviewer can start a Text Session

GetSummaryPageContent

GetSummaryPageContent

End a text session that is started by the provider as Interviewer.

Send the block data to the server

Get complete TextSession data for recovery

Get image

Get Audio

Send Device information to the server.

Get Twilio Token for Phone Call

Get Twilio Token for Phone Call

Get Room Twilio Video Token

Get Twilio Token for Video

Insert feedback

InterpreterSelfCheckFinish

InterpreterSelfCheckCancel

InterpreterSelfCheckGet

Get External Link

Start password reset request.

Reset Password with verification code

Get the FAQ URL (web version of FAQ)

Get the list of FAQ

Update System Language

Get System Language for the current session

Return the link (URL) for the web app to allow accessing certain functions through the web. Type of URLs: Payment, TransactionHistory, ReferNewProvider, ReferNewClient

Logs the Push Notification Setting information

Get the list of training steps for the Provider

Add a completed training step for a provider.

Log training step video time for the Provider.

Upload PromoCode QR Image using Base64

Refer Other

Get the Signed Contract for the Provider

Get the Contract for the Provider

Save the signed contract for the Provider

Consume the Train Key

Consume the Train Key

BandWidthUpdate

Get list of Regions

Return the list of source languages for service for an operator invite third party

Return the list of source languages for service for an operator invite third party

EA Request Launch Start

EA Request Launch Finish

Check if the interpreter needs to provide feedback

Check if the interpreter needs to provide feedback

Save the feedback from a provider regarding the just finished session

Get Provider Dedicated Schedule Time Zone Info

Get Porider Dedicated Schedule Time Blocks

Get Porider Dedicated Schedule Time Blocks

Get Porider Dedicated Schedule Time Blocks

Get Porider Dedicated Schedule Time Blocks

Get Porider Dedicated Schedule Time Blocks

Get Porider Dedicated Schedule Time Blocks

BAServiceMerge

BAServiceDone

BAServiceUpdateInterpreterInfo

BAServiceUpdateFeedback

Get available server list

Get provider's current status

Clear the provider from the current task session

Clear the provider from the current task session (Android Version)

Set Provider's TimeZone

Set current location

Get Provider Transation History Url

Get Provider Request Summary Page Info

Get Provider Transation History Url

Register Provider It will return SecurityToken, which is required to be set as the header value WEYIToken for subsequent calls.

Cancel registration

Cancel registration (Android Version)

Login. It will return SecurityToken, which is required to be set as the header value WEYIToken for subsequent calls.

Login by SAML Token (SAML Single Sign On). Web Use Only It will return SecurityToken, which is required to be set as the header value WEYIToken for subsequent calls.

Login. It will return SecurityToken, which is required to be set as the header value WEYIToken for subsequent calls.

Validate single sign on. It will return SecurityToken, which is required to be set as the header value WEYIToken for subsequent calls.

Web Login Page. It will return Provider Login Page

Login. It will return SecurityToken, which is required to be set as the header value WEYIToken for subsequent calls.

Login using Facebook account. We only need the facebook email account It will return SecurityToken, which is required to be set as the header value WEYIToken for subsequent calls.

Logout

Start Mobile Number Validation

Confirm Mobile Number Validation Code

Update Account of the Provider

Update Name of the Provider

Update Password

Upload Profile Image

Upload Profile Image using Base64 (the size could be 33% more)

Upload Profile Image using Base64 (the size could be 33% more)

Get Profile Image

Get Profile Image using Base64 (the size could be 33% more).

Get Profile Image using Base64 (the size could be 33% more)

Get whether we should ask the Provider for the PromoCode. It will also return the PromoCode the system determines based on the information received so far about the Provider

Save the promo code

Get the list of available languages to be selected from, which will exclue the language already selected.

Get the list of available languages to be selected from, which will exclue the language already selected.

Get the list of available languages to be selected from, which will exclue the language already selected.

ProviderScriptConfirmAndRoute

ProviderScriptConfirmAndStartService

ProviderScriptSAFinish

ProviderScriptScheduleTask

Add language as a full package, including Language certificates.

Get the list of languages for the Provider

Add a new language for a provider.

Not supported any more

Delete Provider's language skill record

Delete Provider's language skill record (Android Version)

Get whether the language list for the Provider is OK.

Get the list of language certificates for the selected language for a Provider

Insert new certificate

Update existing certificate

Delete Language Certificate

Delete Language Certificate (Android Version)

Upload Certificate Image

Upload Certificate Image in Based

Get Language Certificate Image

Get Language Certificate Image

Get the translation certificates for a provider

Get the translation certificates for the given provider service id

Get the list of eligible service for a provider

Update the provider service selection (whether the Provider is willing to offer a specific service)

Get the list of eligible service for a provider

Get one entity

Add Service Certificate as a package (certificate info and image being added with one call). The image is not required while the certificate info is.

Create new Service Certificate

Delete Service Certificate

Delete Service Certificate (Android Version)

Upload Service Certificate Image

Upload Certificate Image in Base 64

Get Service Certificate Image

Get Service Certificate Image

Additional info about the provider. This function is obsolete. Please use AdditionalInfoNew below.

Additional info about the provider

Get the list of Interview Time

Get one entity

Add the list of interview times as a package

add Interview Time (UTC time is expected)

Delete InterviewTime item

Delete InterviewTime item (Android Version)

Notify server that the Registration process is done

Get the business day info for the provider

Set business day info for a provider with one input as a package, which include Weekday set up, and non business day select. Business days are local time zone.

Get one entity

Set value

Set up the list of business available days: Monday through Sunday

Add a new Non Business Day Range item.

Delete Non Business Day Range item.

Delete Non Business Day Range item. (Android Version)

Get the business hour info for the provider

Set business hour info for a provider with one input as a packag. Business hours are local time zone. The date part of From and To will be ignored. If the From time is later than the To time, then it is cross midnight.

Add a new Business Hour item.

Delete business hour item.

Delete business hour item. (Android Version)

Get the list of options for Available dropdownlist

Get the list of options for Days dropdownlist

Get the list of options for Hours dropdownlist

Get provider's weekly working schedule

Get provider's weekly working schedule

Set new working schedule record. It will return provider's one week working schedule

Set new working schedule record. It will return provider's one week working schedule

Get provider's working schedule for today

Gets the list of daily schedule options available for the Provider.

Get the list of URLs to be displayed in the Home screen

Check if the App needs to be upgraded

Change Provider's current day's(today) schedule for the given Schedule option.

OnLineStatusChangeRequirementGet

Change Provider's OnLine Status

Change Provider's OnLine Status

Get the number of open tasks for the Provider

Get the number of open tasks for the Provider

No documentation available.

Get the list of open tasks, including Service Request from Client, Interview from Interviewer, and Interview from Candidate

Get Profile Image of the client

Get Profile Image of the client using Base64 (the size could be 33% more)

Get Profile Image of the other provider for an interview

Get Profile Image of the other provider for an interview using Base64 (the size could be 33% more).

V2: Get the list of open tasks, including Dedicated Service Request from Client, Interview from Interviewer, Interview from Candidate, and Direct Person Translation (DPT)

Get Training URLs to be displayed in the Home screen

Confirm the latest DisplayURL list obtained from the server

Provider accepted the DPT task from client.

Direct Provider Translate (DPT): Get block data, including both from the sender and from the provider. It is used to get the full content of the DPT block

Provider escalates the DPT task from client and put the DPT task back to the queue. The DPT task should have already been confirmed accepted by the provider.

Get the list of DPT escalation reason

Provider denied the DPT task from client. The DPT task should have already been confirmed accepted by the provider.

Get the list of DPT Deny reason

Direct Provider Translation (DPT): Provider send the block data to the server

Provider deny the service request from client. After the call is made, the provider app will not receive this request any more the next step

Client Preselection NextStep: 1. Agreement 2. Payment 3. PreLanguageOption 4. SourceLanguage 5. TargetLanguage 6. SubmitRequest

Client Preselection Agreement

Client Preselection Agreement Accept

Client Preselection Payment

Client Preselection Payment submit

Client Preselection Before Language

Client Preselection SourceLanguageList

Client Preselection TargetLanguageList

Client Preselection TargetLanguageList with Availability

Client Preselection AdditionalInfoOptionList Refresh

Client Preselection AdditionalInfoOptionList

Client Preselection Get Scheduled Time

Client Preselection Set Scheduled Time

Client Preselection SubmitRequest

Client Preselection SubmitRequest

Client Preselection RequestStatusPull

Log Error

No documentation available.

No documentation available.