CreateCallbackParms (engagement-java 9.0.21 API)

java.lang.Object
- com.genesys.internal.engagement.model.CreateCallbackParms

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2019-05-17T22:34:31.653Z")
public class CreateCallbackParms
extends java.lang.Object

CreateCallbackParms

Constructor Summary

Constructors
Constructor and Description

CreateCallbackParms()

Constructors
Constructor and Description
`CreateCallbackParms()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateCallbackParms`	`captchaToken(java.lang.String captchaToken)`
`CreateCallbackParms`	`cbOfferType(java.lang.String cbOfferType)`
`CreateCallbackParms`	`cbOriginationIxnId(java.lang.String cbOriginationIxnId)`
`CreateCallbackParms`	`channel(java.lang.String channel)`
`CreateCallbackParms`	`desiredTime(org.threeten.bp.OffsetDateTime desiredTime)`
`boolean`	`equals(java.lang.Object o)`
`java.lang.String`	`getCaptchaToken()` The response key generated from the user's captcha interaction.
`java.lang.String`	`getCbOfferType()` Type of callback that was originally offered and accepted by the customer.
`java.lang.String`	`getCbOriginationIxnId()` The Call ID (CallUUID) of the inbound call where callback was offered originally and accepted.
`java.lang.String`	`getChannel()` Callback origination channel.
`org.threeten.bp.OffsetDateTime`	`getDesiredTime()` Desired time to have the callback.
`java.lang.String`	`getInboundVQ()` The name of the inbound virtual queue the call would have been placed in if the caller did not accept the callback.
`java.lang.String`	`getLanguage()` Preferred language for voice prompts in Designer's format.
`java.math.BigDecimal`	`getOfferThreshold()` This is the estimated wait time threshold (in seconds) that was used to determine when callback should be offered.
`java.lang.String`	`getOfferTiming()` OFF-HOURS when callback (typically scheduled only) was offered outside business hours, ON-HOURS when callback was offered during business hours.
`java.lang.String`	`getPhoneNumber()` Number to call back.
`java.math.BigDecimal`	`getPriority()` The initial priority of the call when placed in the virtual queue.
`java.lang.String`	`getPushChannel()` The push channel to receive a push notification when the serviceName provided is configured to be USERORIGINATED.
`java.lang.String`	`getPushTarget()` The push target to receive a push notification when the serviceName provided is configured to be USERORIGINATED.
`java.lang.String`	`getRoutePoint()` Routing point to use when making an outbound call.
`java.lang.String`	`getServiceName()` Name of the callback execution service provisioned in GES.
`java.lang.String`	`getSurveyRP()` After the callback is complete, the user can be routed to a survey application to provide feedback.
`java.lang.String`	`getUserData()` A hash map of user-specific data that will be associated with the callback.
`int`	`hashCode()`
`CreateCallbackParms`	`inboundVQ(java.lang.String inboundVQ)`
`CreateCallbackParms`	`language(java.lang.String language)`
`CreateCallbackParms`	`offerThreshold(java.math.BigDecimal offerThreshold)`
`CreateCallbackParms`	`offerTiming(java.lang.String offerTiming)`
`CreateCallbackParms`	`phoneNumber(java.lang.String phoneNumber)`
`CreateCallbackParms`	`priority(java.math.BigDecimal priority)`
`CreateCallbackParms`	`pushChannel(java.lang.String pushChannel)`
`CreateCallbackParms`	`pushTarget(java.lang.String pushTarget)`
`CreateCallbackParms`	`routePoint(java.lang.String routePoint)`
`CreateCallbackParms`	`serviceName(java.lang.String serviceName)`
`void`	`setCaptchaToken(java.lang.String captchaToken)`
`void`	`setCbOfferType(java.lang.String cbOfferType)`
`void`	`setCbOriginationIxnId(java.lang.String cbOriginationIxnId)`
`void`	`setChannel(java.lang.String channel)`
`void`	`setDesiredTime(org.threeten.bp.OffsetDateTime desiredTime)`
`void`	`setInboundVQ(java.lang.String inboundVQ)`
`void`	`setLanguage(java.lang.String language)`
`void`	`setOfferThreshold(java.math.BigDecimal offerThreshold)`
`void`	`setOfferTiming(java.lang.String offerTiming)`
`void`	`setPhoneNumber(java.lang.String phoneNumber)`
`void`	`setPriority(java.math.BigDecimal priority)`
`void`	`setPushChannel(java.lang.String pushChannel)`
`void`	`setPushTarget(java.lang.String pushTarget)`
`void`	`setRoutePoint(java.lang.String routePoint)`
`void`	`setServiceName(java.lang.String serviceName)`
`void`	`setSurveyRP(java.lang.String surveyRP)`
`void`	`setUserData(java.lang.String userData)`
`CreateCallbackParms`	`surveyRP(java.lang.String surveyRP)`
`java.lang.String`	`toString()`
`CreateCallbackParms`	`userData(java.lang.String userData)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateCallbackParms
```
public CreateCallbackParms()
```
- Method Detail
  - serviceName
```
public CreateCallbackParms serviceName(java.lang.String serviceName)
```
  - getServiceName
```
public java.lang.String getServiceName()
```
    Name of the callback execution service provisioned in GES.
    
    Returns:
    
    serviceName
  - setServiceName
```
public void setServiceName(java.lang.String serviceName)
```
  - phoneNumber
```
public CreateCallbackParms phoneNumber(java.lang.String phoneNumber)
```
  - getPhoneNumber
```
public java.lang.String getPhoneNumber()
```
    Number to call back.
    
    Returns:
    
    phoneNumber
  - setPhoneNumber
```
public void setPhoneNumber(java.lang.String phoneNumber)
```
  - desiredTime
```
public CreateCallbackParms desiredTime(org.threeten.bp.OffsetDateTime desiredTime)
```
  - getDesiredTime
```
public org.threeten.bp.OffsetDateTime getDesiredTime()
```
    Desired time to have the callback. By default, the desired time is the current time. This option format is ISO 8601 yyyy-MM-ddTHH:mm:ss.SSSZ such as 2013-05-28T15:30:00.000Z.
    
    Returns:
    
    desiredTime
  - setDesiredTime
```
public void setDesiredTime(org.threeten.bp.OffsetDateTime desiredTime)
```
  - cbOfferType
```
public CreateCallbackParms cbOfferType(java.lang.String cbOfferType)
```
  - getCbOfferType
```
public java.lang.String getCbOfferType()
```
    Type of callback that was originally offered and accepted by the customer. Possible values are ASAP, SCHEDULED, COMBINED_SCHEDULED_AND_ASAP. Note that this is used for reporting purposes only.
    
    Returns:
    
    cbOfferType
  - setCbOfferType
```
public void setCbOfferType(java.lang.String cbOfferType)
```
  - language
```
public CreateCallbackParms language(java.lang.String language)
```
  - getLanguage
```
public java.lang.String getLanguage()
```
    Preferred language for voice prompts in Designer's format. It needs to be in the ISO-639-1 format for the first part (indicating the language) and the ISO Alpha-2 code for the second part (indicating the region which speaks the language). Please check in Designer System Variables under Language for the list of supported values. Here are some sample values, en-US, en-UK, fr-FR, fr-CA, es-ES, es-MX.
    
    Returns:
    
    language
  - setLanguage
```
public void setLanguage(java.lang.String language)
```
  - inboundVQ
```
public CreateCallbackParms inboundVQ(java.lang.String inboundVQ)
```
  - getInboundVQ
```
public java.lang.String getInboundVQ()
```
    The name of the inbound virtual queue the call would have been placed in if the caller did not accept the callback. This is for reporting the estimated wait time for the inbound virtual queue.
    
    Returns:
    
    inboundVQ
  - setInboundVQ
```
public void setInboundVQ(java.lang.String inboundVQ)
```
  - offerThreshold
```
public CreateCallbackParms offerThreshold(java.math.BigDecimal offerThreshold)
```
  - getOfferThreshold
```
public java.math.BigDecimal getOfferThreshold()
```
    This is the estimated wait time threshold (in seconds) that was used to determine when callback should be offered.
    
    Returns:
    
    offerThreshold
  - setOfferThreshold
```
public void setOfferThreshold(java.math.BigDecimal offerThreshold)
```
  - channel
```
public CreateCallbackParms channel(java.lang.String channel)
```
  - getChannel
```
public java.lang.String getChannel()
```
    Callback origination channel.
    
    Returns:
    
    channel
  - setChannel
```
public void setChannel(java.lang.String channel)
```
  - offerTiming
```
public CreateCallbackParms offerTiming(java.lang.String offerTiming)
```
  - getOfferTiming
```
public java.lang.String getOfferTiming()
```
    OFF-HOURS when callback (typically scheduled only) was offered outside business hours, ON-HOURS when callback was offered during business hours. If not passed in, then default value is <unspecified>.
    
    Returns:
    
    offerTiming
  - setOfferTiming
```
public void setOfferTiming(java.lang.String offerTiming)
```
  - cbOriginationIxnId
```
public CreateCallbackParms cbOriginationIxnId(java.lang.String cbOriginationIxnId)
```
  - getCbOriginationIxnId
```
public java.lang.String getCbOriginationIxnId()
```
    The Call ID (CallUUID) of the inbound call where callback was offered originally and accepted. For chat scenarios this should be chat interaction id. If not passed in, then default value is <unspecified>\".
    
    Returns:
    
    cbOriginationIxnId
  - setCbOriginationIxnId
```
public void setCbOriginationIxnId(java.lang.String cbOriginationIxnId)
```
  - surveyRP
```
public CreateCallbackParms surveyRP(java.lang.String surveyRP)
```
  - getSurveyRP
```
public java.lang.String getSurveyRP()
```
    After the callback is complete, the user can be routed to a survey application to provide feedback. If passed in, this will override the value configured in the CALLBACK_SETTINGS data table.
    
    Returns:
    
    surveyRP
  - setSurveyRP
```
public void setSurveyRP(java.lang.String surveyRP)
```
  - priority
```
public CreateCallbackParms priority(java.math.BigDecimal priority)
```
  - getPriority
```
public java.math.BigDecimal getPriority()
```
    The initial priority of the call when placed in the virtual queue. This will override the value configured in the Callback V2 block's UI if passed in. The other values configured in the Callback V2 block's UI for priority (priority increments and priority limits) will not be modified.
    
    Returns:
    
    priority
  - setPriority
```
public void setPriority(java.math.BigDecimal priority)
```
  - routePoint
```
public CreateCallbackParms routePoint(java.lang.String routePoint)
```
  - getRoutePoint
```
public java.lang.String getRoutePoint()
```
    Routing point to use when making an outbound call. This will override the value configured in the CALLBACK_SETTINGS data table if passed in.
    
    Returns:
    
    routePoint
  - setRoutePoint
```
public void setRoutePoint(java.lang.String routePoint)
```
  - userData
```
public CreateCallbackParms userData(java.lang.String userData)
```
  - getUserData
```
public java.lang.String getUserData()
```
    A hash map of user-specific data that will be associated with the callback. Use hash key names that are considered valid JavaScript variable names - otherwise they will be ignored. For privacy reason, all contents of the user data will not be written to the application logs.
    
    Returns:
    
    userData
  - setUserData
```
public void setUserData(java.lang.String userData)
```
  - captchaToken
```
public CreateCallbackParms captchaToken(java.lang.String captchaToken)
```
  - getCaptchaToken
```
public java.lang.String getCaptchaToken()
```
    The response key generated from the user's captcha interaction. Required if captcha validation is required for the tenant.
    
    Returns:
    
    captchaToken
  - setCaptchaToken
```
public void setCaptchaToken(java.lang.String captchaToken)
```
  - pushChannel
```
public CreateCallbackParms pushChannel(java.lang.String pushChannel)
```
  - getPushChannel
```
public java.lang.String getPushChannel()
```
    The push channel to receive a push notification when the serviceName provided is configured to be USERORIGINATED. Otherwise this is ignored. Currently only supports a value of 'FCM'.
    
    Returns:
    
    pushChannel
  - setPushChannel
```
public void setPushChannel(java.lang.String pushChannel)
```
  - pushTarget
```
public CreateCallbackParms pushTarget(java.lang.String pushTarget)
```
  - getPushTarget
```
public java.lang.String getPushTarget()
```
    The push target to receive a push notification when the serviceName provided is configured to be USERORIGINATED. Otherwise this is ignored.
    
    Returns:
    
    pushTarget
  - setPushTarget
```
public void setPushTarget(java.lang.String pushTarget)
```
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class CreateCallbackParms

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CreateCallbackParms

Method Detail

serviceName

getServiceName

setServiceName

phoneNumber

getPhoneNumber

setPhoneNumber

desiredTime

getDesiredTime

setDesiredTime

cbOfferType

getCbOfferType

setCbOfferType

language

getLanguage

setLanguage

inboundVQ

getInboundVQ

setInboundVQ

offerThreshold

getOfferThreshold

setOfferThreshold

channel

getChannel

setChannel

offerTiming

getOfferTiming

setOfferTiming

cbOriginationIxnId

getCbOriginationIxnId

setCbOriginationIxnId

surveyRP

getSurveyRP

setSurveyRP

priority

getPriority

setPriority

routePoint

getRoutePoint

setRoutePoint

userData

getUserData

setUserData

captchaToken

getCaptchaToken

setCaptchaToken

pushChannel

getPushChannel

setPushChannel

pushTarget

getPushTarget

setPushTarget

equals

hashCode

toString