POST Request/New

Create a new request

Request Information

URI Parameters

None.

Body Parameters

Service Request Object

EATwilioIntegrationRequest
NameDescriptionTypeAdditional information
LanguageId

Language Id

integer

None.

SpecialtyOptionCodeId

Specialty Option ( Optional. Default: 1 General ) 1: General 2: Medical 3: Legal

integer

None.

VideoOptionCodeId

Video Option ( Optional. Default: 1: Video Preferred ) 1: Video Preferred 2: Audio Only 3: Video Only

integer

None.

GenderOptionCodeId

Gender Option (Optional. Default: 1: No Preferrence ) 1: No Preferrence 2: Female Preferred 3: Female Only 4: Male Preferred 5: Male Only

integer

None.

Note

Note, will be displayed to the interpreter

string

None.

ReferenceId

Reference Id

string

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:
{
  "LanguageId": 1,
  "SpecialtyOptionCodeId": 1,
  "VideoOptionCodeId": 1,
  "GenderOptionCodeId": 1,
  "Note": "sample string 2",
  "ReferenceId": "sample string 3",
  "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:
<EATwilioIntegrationRequest 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>
  <GenderOptionCodeId>1</GenderOptionCodeId>
  <LanguageId>1</LanguageId>
  <Note>sample string 2</Note>
  <ReferenceId>sample string 3</ReferenceId>
  <SpecialtyOptionCodeId>1</SpecialtyOptionCodeId>
  <VideoInfo>
    <RoomName>sample string 2</RoomName>
    <VideoToken>sample string 1</VideoToken>
  </VideoInfo>
  <VideoOptionCodeId>1</VideoOptionCodeId>
  <isVideo>true</isVideo>
</EATwilioIntegrationRequest>

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 'EATwilioIntegrationRequest'.

Response Information

Resource Description

RequestId if the call is successful

EATwilioIntegrationResultRequestId
NameDescriptionTypeAdditional information
RequestId

The Request Id generated by Voyce

integer

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,
  "Successful": true,
  "Reason": "sample string 3"
}

application/xml, text/xml

Sample:
<EATwilioIntegrationResultRequestId xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <Reason>sample string 3</Reason>
  <Successful>true</Successful>
  <RequestId>1</RequestId>
</EATwilioIntegrationResultRequestId>