POST common/chinese/generate/details

Generate audios files based on a pinyin list. We will convert the pinyin list to word list and generate audio for each word.

Request Information

Parameters

Name	Description	Additional information
inVO		Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "wordList": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ],
  "curUserId": "sample string 1",
  "isSSO": true,
  "requestHost": "sample string 3",
  "applicationPath": "sample string 4",
  "secureApplicationPath": "sample string 5",
  "absoluteApplicationPath": "sample string 6",
  "isHttps": true,
  "isMobileDevice": true,
  "clientType": 0,
  "clientVersion": "sample string 9",
  "clientOS": "sample string 10",
  "clientBuild": "sample string 11",
  "timeZone": 12,
  "clientId": "sample string 13"
}

application/xml, text/xml

Sample:

<GenerateDetailsInVO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AiChinese.Internal.API.VO.Input">
  <ClientId xmlns="http://schemas.datacontract.org/2004/07/AiChinese.Internal.API.VO.Input.Common">sample string 13</ClientId>
  <ClientType xmlns="http://schemas.datacontract.org/2004/07/AiChinese.Internal.API.VO.Input.Common">Web</ClientType>
  <TimeZone xmlns="http://schemas.datacontract.org/2004/07/AiChinese.Internal.API.VO.Input.Common">12</TimeZone>
  <absoluteApplicationPath xmlns="http://schemas.datacontract.org/2004/07/AiChinese.Internal.API.VO.Input.Common">sample string 6</absoluteApplicationPath>
  <applicationPath xmlns="http://schemas.datacontract.org/2004/07/AiChinese.Internal.API.VO.Input.Common">sample string 4</applicationPath>
  <cachedKey xmlns="http://schemas.datacontract.org/2004/07/AiChinese.Internal.API.VO.Input.Common">sample string 1</cachedKey>
  <clientBuild xmlns="http://schemas.datacontract.org/2004/07/AiChinese.Internal.API.VO.Input.Common">sample string 11</clientBuild>
  <clientOS xmlns="http://schemas.datacontract.org/2004/07/AiChinese.Internal.API.VO.Input.Common">sample string 10</clientOS>
  <clientVersion xmlns="http://schemas.datacontract.org/2004/07/AiChinese.Internal.API.VO.Input.Common">sample string 9</clientVersion>
  <curUserId xmlns="http://schemas.datacontract.org/2004/07/AiChinese.Internal.API.VO.Input.Common">sample string 1</curUserId>
  <isHttps xmlns="http://schemas.datacontract.org/2004/07/AiChinese.Internal.API.VO.Input.Common">true</isHttps>
  <isMobileDevice xmlns="http://schemas.datacontract.org/2004/07/AiChinese.Internal.API.VO.Input.Common">true</isMobileDevice>
  <isSSO xmlns="http://schemas.datacontract.org/2004/07/AiChinese.Internal.API.VO.Input.Common">true</isSSO>
  <requestHost xmlns="http://schemas.datacontract.org/2004/07/AiChinese.Internal.API.VO.Input.Common">sample string 3</requestHost>
  <secureApplicationPath xmlns="http://schemas.datacontract.org/2004/07/AiChinese.Internal.API.VO.Input.Common">sample string 5</secureApplicationPath>
  <WordList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
    <d2p1:string>sample string 3</d2p1:string>
  </WordList>
</GenerateDetailsInVO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "isDone": true,
  "code": 0,
  "message": "sample string 2",
  "cachedKey": "sample string 3",
  "correlationId": "54c5f5d3-68df-40f6-a9a7-b0c9d943c811",
  "data": {
    "words": [
      {
        "syllables": [
          "sample string 1",
          "sample string 2",
          "sample string 3"
        ],
        "translation": null,
        "virtualPath": "sample string 1"
      },
      {
        "syllables": [
          "sample string 1",
          "sample string 2",
          "sample string 3"
        ],
        "translation": null,
        "virtualPath": "sample string 1"
      },
      {
        "syllables": [
          "sample string 1",
          "sample string 2",
          "sample string 3"
        ],
        "translation": null,
        "virtualPath": "sample string 1"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ApiResponseOfGenerateDetailsOutVODeMvvqei xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AiChinese.Internal.API">
  <CachedKey>sample string 3</CachedKey>
  <Code>None</Code>
  <CorrelationId>54c5f5d3-68df-40f6-a9a7-b0c9d943c811</CorrelationId>
  <IsDone>true</IsDone>
  <Message>sample string 2</Message>
</ApiResponseOfGenerateDetailsOutVODeMvvqei>