com.aliyun.sdk.service.dyvmsapi20170525.models.SingleCallByVoiceRequest Maven / Gradle / Ivy
Show all versions of alibabacloud-dyvmsapi20170525 Show documentation
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sdk.service.dyvmsapi20170525.models;
import com.aliyun.core.annotation.*;
import darabonba.core.RequestModel;
import darabonba.core.TeaModel;
import com.aliyun.sdk.gateway.pop.models.*;
/**
* {@link SingleCallByVoiceRequest} extends {@link RequestModel}
*
* SingleCallByVoiceRequest
*/
public class SingleCallByVoiceRequest extends Request {
@Query
@NameInMap("CalledNumber")
@Validation(required = true)
private String calledNumber;
@Query
@NameInMap("CalledShowNumber")
private String calledShowNumber;
@Query
@NameInMap("OutId")
private String outId;
@Query
@NameInMap("OwnerId")
private Long ownerId;
@Query
@NameInMap("PlayTimes")
private Integer playTimes;
@Query
@NameInMap("ResourceOwnerAccount")
private String resourceOwnerAccount;
@Query
@NameInMap("ResourceOwnerId")
private Long resourceOwnerId;
@Query
@NameInMap("Speed")
private Integer speed;
@Query
@NameInMap("VoiceCode")
@Validation(required = true)
private String voiceCode;
@Query
@NameInMap("Volume")
private Integer volume;
private SingleCallByVoiceRequest(Builder builder) {
super(builder);
this.calledNumber = builder.calledNumber;
this.calledShowNumber = builder.calledShowNumber;
this.outId = builder.outId;
this.ownerId = builder.ownerId;
this.playTimes = builder.playTimes;
this.resourceOwnerAccount = builder.resourceOwnerAccount;
this.resourceOwnerId = builder.resourceOwnerId;
this.speed = builder.speed;
this.voiceCode = builder.voiceCode;
this.volume = builder.volume;
}
public static Builder builder() {
return new Builder();
}
public static SingleCallByVoiceRequest create() {
return builder().build();
}
@Override
public Builder toBuilder() {
return new Builder(this);
}
/**
* @return calledNumber
*/
public String getCalledNumber() {
return this.calledNumber;
}
/**
* @return calledShowNumber
*/
public String getCalledShowNumber() {
return this.calledShowNumber;
}
/**
* @return outId
*/
public String getOutId() {
return this.outId;
}
/**
* @return ownerId
*/
public Long getOwnerId() {
return this.ownerId;
}
/**
* @return playTimes
*/
public Integer getPlayTimes() {
return this.playTimes;
}
/**
* @return resourceOwnerAccount
*/
public String getResourceOwnerAccount() {
return this.resourceOwnerAccount;
}
/**
* @return resourceOwnerId
*/
public Long getResourceOwnerId() {
return this.resourceOwnerId;
}
/**
* @return speed
*/
public Integer getSpeed() {
return this.speed;
}
/**
* @return voiceCode
*/
public String getVoiceCode() {
return this.voiceCode;
}
/**
* @return volume
*/
public Integer getVolume() {
return this.volume;
}
public static final class Builder extends Request.Builder {
private String calledNumber;
private String calledShowNumber;
private String outId;
private Long ownerId;
private Integer playTimes;
private String resourceOwnerAccount;
private Long resourceOwnerId;
private Integer speed;
private String voiceCode;
private Integer volume;
private Builder() {
super();
}
private Builder(SingleCallByVoiceRequest request) {
super(request);
this.calledNumber = request.calledNumber;
this.calledShowNumber = request.calledShowNumber;
this.outId = request.outId;
this.ownerId = request.ownerId;
this.playTimes = request.playTimes;
this.resourceOwnerAccount = request.resourceOwnerAccount;
this.resourceOwnerId = request.resourceOwnerId;
this.speed = request.speed;
this.voiceCode = request.voiceCode;
this.volume = request.volume;
}
/**
* The number for receiving voice notifications.
*
*
* Number format:
*
* * In the Chinese mainland:
*
* * Mobile phone number, for example, 159\*\*\*\*0000.
* * Landline number, for example, 0571\*\*\*\*5678.
*
* * Outside the Chinese mainland: country code + phone number, for example, 85200\*\*\*\*00.
*
* >
*
* * You can specify only one called number for a request. For more information, see [How to use voice notifications in the Chinese mainland](~~150016~~) or [How to use voice notifications in regions outside the Chinese mainland](~~268810~~).
*
* * Voice notifications are sent to a called number at the following frequency: one time per minute, five times per hour, and 20 times per 24 hours.
*/
public Builder calledNumber(String calledNumber) {
this.putQueryParameter("CalledNumber", calledNumber);
this.calledNumber = calledNumber;
return this;
}
/**
* The number displayed to the called party.
*
*
* * You do not need to specify this parameter if you use a voice notification file that uses the common outbound call mode. For more information, see [FAQ about the common outbound call mode](~~172104~~).
* * If you use a voice notification file that uses the dedicated outbound call mode, you must specify a number that you purchased. You can specify only one number. You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home) and choose **Real Number Service** > **Real Number Management** to view the number that you purchased.
*/
public Builder calledShowNumber(String calledShowNumber) {
this.putQueryParameter("CalledShowNumber", calledShowNumber);
this.calledShowNumber = calledShowNumber;
return this;
}
/**
* The ID reserved for the caller. This ID is returned to the caller in a receipt message.
*
*
* The value must be of the STRING type and 1 to 15 bytes in length.
*/
public Builder outId(String outId) {
this.putQueryParameter("OutId", outId);
this.outId = outId;
return this;
}
/**
* OwnerId.
*/
public Builder ownerId(Long ownerId) {
this.putQueryParameter("OwnerId", ownerId);
this.ownerId = ownerId;
return this;
}
/**
* The number of times the voice notification file is played. Valid values: 1 to 3.
*/
public Builder playTimes(Integer playTimes) {
this.putQueryParameter("PlayTimes", playTimes);
this.playTimes = playTimes;
return this;
}
/**
* ResourceOwnerAccount.
*/
public Builder resourceOwnerAccount(String resourceOwnerAccount) {
this.putQueryParameter("ResourceOwnerAccount", resourceOwnerAccount);
this.resourceOwnerAccount = resourceOwnerAccount;
return this;
}
/**
* ResourceOwnerId.
*/
public Builder resourceOwnerId(Long resourceOwnerId) {
this.putQueryParameter("ResourceOwnerId", resourceOwnerId);
this.resourceOwnerId = resourceOwnerId;
return this;
}
/**
* The playback speed of the voice notification file. Valid values: -500 to 500.
*/
public Builder speed(Integer speed) {
this.putQueryParameter("Speed", speed);
this.speed = speed;
return this;
}
/**
* The voice ID of the voice notification file.
*
*
* You can log on to the [Voice Messaging Service console](https://dyvms.console.aliyun.com/overview/home), choose **Voice Messages** > **Voice Notifications** or **Voice File Management**, and then click the **Voice Notification Files** tab to view the **voice ID**.
*/
public Builder voiceCode(String voiceCode) {
this.putQueryParameter("VoiceCode", voiceCode);
this.voiceCode = voiceCode;
return this;
}
/**
* The playback volume of the voice notification file. Valid values: 0 to 100. Default value: 100.
*/
public Builder volume(Integer volume) {
this.putQueryParameter("Volume", volume);
this.volume = volume;
return this;
}
@Override
public SingleCallByVoiceRequest build() {
return new SingleCallByVoiceRequest(this);
}
}
}