IvrCallRequest (dyvmsapi20170525 4.1.0 API)

java.lang.Object
- com.aliyun.tea.TeaModel
- - com.aliyun.dyvmsapi20170525.models.IvrCallRequest

public class IvrCallRequest
extends com.aliyun.tea.TeaModel

嵌套类概要

嵌套类
限定符和类型类和说明

static class IvrCallRequest.IvrCallRequestMenuKeyMap

嵌套类
限定符和类型	类和说明
`static class`	`IvrCallRequest.IvrCallRequestMenuKeyMap`

字段概要

字段
限定符和类型	字段和说明
`String`	`byeCode` The end voice.
`String`	`byeTtsParams` The variables in the TTS template, in the JSON format.
`String`	`calledNumber` The called number.
`String`	`calledShowNumber` The calling number.
`List<IvrCallRequest.IvrCallRequestMenuKeyMap>`	`menuKeyMap` The information about the key pressed by the subscriber.
`String`	`outId` The ID that is reserved for the caller of the operation.
`Long`	`ownerId`
`Long`	`playTimes` The number of replay times.
`String`	`resourceOwnerAccount`
`Long`	`resourceOwnerId`
`String`	`startCode` The voice that is played when the call begins.
`String`	`startTtsParams` The variables in the TTS template, in the JSON format.
`Integer`	`timeout` The timeout period for the subscriber to press a key.

构造器概要

构造器
构造器和说明

IvrCallRequest()

构造器
构造器和说明
`IvrCallRequest()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static IvrCallRequest`	`build(Map<String,?> map)`
`String`	`getByeCode()`
`String`	`getByeTtsParams()`
`String`	`getCalledNumber()`
`String`	`getCalledShowNumber()`
`List<IvrCallRequest.IvrCallRequestMenuKeyMap>`	`getMenuKeyMap()`
`String`	`getOutId()`
`Long`	`getOwnerId()`
`Long`	`getPlayTimes()`
`String`	`getResourceOwnerAccount()`
`Long`	`getResourceOwnerId()`
`String`	`getStartCode()`
`String`	`getStartTtsParams()`
`Integer`	`getTimeout()`
`IvrCallRequest`	`setByeCode(String byeCode)`
`IvrCallRequest`	`setByeTtsParams(String byeTtsParams)`
`IvrCallRequest`	`setCalledNumber(String calledNumber)`
`IvrCallRequest`	`setCalledShowNumber(String calledShowNumber)`
`IvrCallRequest`	`setMenuKeyMap(List<IvrCallRequest.IvrCallRequestMenuKeyMap> menuKeyMap)`
`IvrCallRequest`	`setOutId(String outId)`
`IvrCallRequest`	`setOwnerId(Long ownerId)`
`IvrCallRequest`	`setPlayTimes(Long playTimes)`
`IvrCallRequest`	`setResourceOwnerAccount(String resourceOwnerAccount)`
`IvrCallRequest`	`setResourceOwnerId(Long resourceOwnerId)`
`IvrCallRequest`	`setStartCode(String startCode)`
`IvrCallRequest`	`setStartTtsParams(String startTtsParams)`
`IvrCallRequest`	`setTimeout(Integer timeout)`

从类继承的方法 com.aliyun.tea.TeaModel
build, buildMap, confirmType, confirmType, parseObject, toMap, toMap, toModel, validate, validateParams

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - byeCode
```
@NameInMap(value="ByeCode")
public String byeCode
```
    The end voice.
    - If you use a voice notification file, this parameter specifies the voice ID. You can log on to the Voice Messaging Service console, choose Voice Messages > Voice Notifications, and then click the Voice Notification Files tab to view the voice ID.
    - If you use a TTS template, this parameter specifies the template ID. You can log on to the Voice Messaging Service console, choose Voice Messages > Voice Notifications, and then click the TTS Template tab to view the template ID.
    The value of the ByeCode parameter must be of the same type as the value of the StartCode parameter. This means that both parameters must specify voice IDs or TTS template IDs.
    
    example:
    TTS_1234****
  - byeTtsParams
```
@NameInMap(value="ByeTtsParams")
public String byeTtsParams
```
    The variables in the TTS template, in the JSON format.
    
    This parameter is required when the ByeCode parameter is set to the ID of a TTS template that contains variables.
    
    example:
    {"name":"xxx","code":"123"}
  - calledNumber
```
@NameInMap(value="CalledNumber")
public String calledNumber
```
    The called number.
    
    Only phone numbers in the Chinese mainland are supported. Each request supports only one called number.
    
    This parameter is required.
    example:
    1590****000
  - calledShowNumber
```
@NameInMap(value="CalledShowNumber")
public String calledShowNumber
```
    The calling number.
    
    The value must be a number you purchased. Each request supports only one calling number. In most cases, a calling number is configured with the maximum number of concurrent requests. New requests fail if the maximum number of concurrent requests is reached. You can log on to the Voice Messaging Service console and choose Real Number Service > Real Number Management to view the number you purchased.
    
    This parameter is required.
    example:
    0571****5678
  - menuKeyMap
```
@NameInMap(value="MenuKeyMap")
public List<IvrCallRequest.IvrCallRequestMenuKeyMap> menuKeyMap
```
    The information about the key pressed by the subscriber.
  - outId
```
@NameInMap(value="OutId")
public String outId
```
    The ID that is reserved for the caller of the operation. This ID is returned to the caller in a receipt message.
    
    The value is of the STRING type and must be 1 to 15 bytes in length.
    example:
    PR0210428****
  - ownerId
```
@NameInMap(value="OwnerId")
public Long ownerId
```
  - playTimes
```
@NameInMap(value="PlayTimes")
public Long playTimes
```
    The number of replay times. Valid values: 1 to 3.
    example:
    3
  - resourceOwnerAccount
```
@NameInMap(value="ResourceOwnerAccount")
public String resourceOwnerAccount
```
  - resourceOwnerId
```
@NameInMap(value="ResourceOwnerId")
public Long resourceOwnerId
```
  - startCode
```
@NameInMap(value="StartCode")
public String startCode
```
    The voice that is played when the call begins.
    - If you use a voice notification file, this parameter specifies the voice ID. You can log on to the Voice Messaging Service console, choose Voice Messages > Voice Notifications, and then click the Voice Notification Files tab to view the voice ID.
    - If you use a text-to-speech (TTS) template, this parameter specifies the template ID. You can log on to the Voice Messaging Service console, choose Voice Messages > Voice Notifications, and then click the TTS Template tab to view the template ID.
    This parameter is required.
    example:
    TTS_1234****
  - startTtsParams
```
@NameInMap(value="StartTtsParams")
public String startTtsParams
```
    The variables in the TTS template, in the JSON format.
    
    This parameter is required when the StartCode parameter is set to the ID of a TTS template that contains variables.
    
    example:
    {"name":"xxx","code":"123"}
  - timeout
```
@NameInMap(value="Timeout")
public Integer timeout
```
    The timeout period for the subscriber to press a key. Unit: milliseconds.
    example:
    3000
- 构造器详细资料
  - IvrCallRequest
```
public IvrCallRequest()
```
- 方法详细资料
  - build
```
public static IvrCallRequest build(Map<String,?> map)
                            throws Exception
```
    抛出:
    
    Exception
  - setByeCode
```
public IvrCallRequest setByeCode(String byeCode)
```
  - getByeCode
```
public String getByeCode()
```
  - setByeTtsParams
```
public IvrCallRequest setByeTtsParams(String byeTtsParams)
```
  - getByeTtsParams
```
public String getByeTtsParams()
```
  - setCalledNumber
```
public IvrCallRequest setCalledNumber(String calledNumber)
```
  - getCalledNumber
```
public String getCalledNumber()
```
  - setCalledShowNumber
```
public IvrCallRequest setCalledShowNumber(String calledShowNumber)
```
  - getCalledShowNumber
```
public String getCalledShowNumber()
```
  - setMenuKeyMap
```
public IvrCallRequest setMenuKeyMap(List<IvrCallRequest.IvrCallRequestMenuKeyMap> menuKeyMap)
```
  - getMenuKeyMap
```
public List<IvrCallRequest.IvrCallRequestMenuKeyMap> getMenuKeyMap()
```
  - setOutId
```
public IvrCallRequest setOutId(String outId)
```
  - getOutId
```
public String getOutId()
```
  - setOwnerId
```
public IvrCallRequest setOwnerId(Long ownerId)
```
  - getOwnerId
```
public Long getOwnerId()
```
  - setPlayTimes
```
public IvrCallRequest setPlayTimes(Long playTimes)
```
  - getPlayTimes
```
public Long getPlayTimes()
```
  - setResourceOwnerAccount
```
public IvrCallRequest setResourceOwnerAccount(String resourceOwnerAccount)
```
  - getResourceOwnerAccount
```
public String getResourceOwnerAccount()
```
  - setResourceOwnerId
```
public IvrCallRequest setResourceOwnerId(Long resourceOwnerId)
```
  - getResourceOwnerId
```
public Long getResourceOwnerId()
```
  - setStartCode
```
public IvrCallRequest setStartCode(String startCode)
```
  - getStartCode
```
public String getStartCode()
```
  - setStartTtsParams
```
public IvrCallRequest setStartTtsParams(String startTtsParams)
```
  - getStartTtsParams
```
public String getStartTtsParams()
```
  - setTimeout
```
public IvrCallRequest setTimeout(Integer timeout)
```
  - getTimeout
```
public Integer getTimeout()
```

类 IvrCallRequest

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 com.aliyun.tea.TeaModel

从类继承的方法 java.lang.Object

字段详细资料

byeCode

byeTtsParams

calledNumber

calledShowNumber

menuKeyMap

outId

ownerId

playTimes

resourceOwnerAccount

resourceOwnerId

startCode

startTtsParams

timeout

构造器详细资料

IvrCallRequest

方法详细资料

build

setByeCode

getByeCode

setByeTtsParams

getByeTtsParams

setCalledNumber

getCalledNumber

setCalledShowNumber

getCalledShowNumber

setMenuKeyMap

getMenuKeyMap

setOutId

getOutId

setOwnerId

getOwnerId

setPlayTimes

getPlayTimes

setResourceOwnerAccount

getResourceOwnerAccount

setResourceOwnerId

getResourceOwnerId

setStartCode

getStartCode

setStartTtsParams

getStartTtsParams

setTimeout

getTimeout