Package com.mypurecloud.sdk.v2.model

Class CreateCallbackCommand

java.lang.Object
com.mypurecloud.sdk.v2.model.CreateCallbackCommand
All Implemented Interfaces:
Serializable
public class CreateCallbackCommand extends Object implements Serializable
CreateCallbackCommand
See Also:

  • Constructor Details

    • CreateCallbackCommand

      public CreateCallbackCommand()

    • CreateCallbackCommand

      public CreateCallbackCommand(Boolean initWithEmptyList)

  • Method Details

    • scriptId

      public CreateCallbackCommand scriptId(String scriptId)
      The identifier of the script to be used for the callback

    • getScriptId

      public String getScriptId()

    • setScriptId

      public void setScriptId(String scriptId)

    • queueId

      public CreateCallbackCommand queueId(String queueId)
      The identifier of the queue to be used for the callback. Either queueId or routingData is required.

    • getQueueId

      public String getQueueId()

    • setQueueId

      public void setQueueId(String queueId)

    • routingData

      public CreateCallbackCommand routingData(RoutingData routingData)
      The routing data to be used for the callback. Either queueId or routingData is required.

    • getRoutingData

      public RoutingData getRoutingData()

    • setRoutingData

      public void setRoutingData(RoutingData routingData)

    • callbackUserName

      public CreateCallbackCommand callbackUserName(String callbackUserName)
      The name of the party to be called back.

    • getCallbackUserName

      public String getCallbackUserName()

    • setCallbackUserName

      public void setCallbackUserName(String callbackUserName)

    • callbackNumbers

      public CreateCallbackCommand callbackNumbers(List<String> callbackNumbers)
      A list of phone numbers for the callback.

    • getCallbackNumbers

      public List<String> getCallbackNumbers()

    • setCallbackNumbers

      public void setCallbackNumbers(List<String> callbackNumbers)

    • callbackScheduledTime

      public CreateCallbackCommand callbackScheduledTime(Date callbackScheduledTime)
      The scheduled date-time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

    • getCallbackScheduledTime

      public Date getCallbackScheduledTime()

    • setCallbackScheduledTime

      public void setCallbackScheduledTime(Date callbackScheduledTime)

    • countryCode

      public CreateCallbackCommand countryCode(String countryCode)
      The country code to be associated with the callback numbers.

    • getCountryCode

      public String getCountryCode()

    • setCountryCode

      public void setCountryCode(String countryCode)

    • validateCallbackNumbers

      public CreateCallbackCommand validateCallbackNumbers(Boolean validateCallbackNumbers)
      Whether or not to validate the callback numbers for phone number format.

    • getValidateCallbackNumbers

      public Boolean getValidateCallbackNumbers()

    • setValidateCallbackNumbers

      public void setValidateCallbackNumbers(Boolean validateCallbackNumbers)

    • data

      public CreateCallbackCommand data(Map<String,String> data)
      A map of key-value pairs containing additional data that can be associated to the callback. These values will appear in the attributes property on the conversation participant. Example: { \"notes\": \"ready to close the deal!\", \"customerPreferredName\": \"Doc\" }

    • getData

      public Map<String,String> getData()

    • setData

      public void setData(Map<String,String> data)

    • callerId

      public CreateCallbackCommand callerId(String callerId)
      The phone number displayed to recipients when a phone call is placed as part of the callback. Must conform to the E.164 format. May be overridden by other settings in the system such as external trunk settings. Telco support for \"callerId\" varies.

    • getCallerId

      public String getCallerId()

    • setCallerId

      public void setCallerId(String callerId)

    • callerIdName

      public CreateCallbackCommand callerIdName(String callerIdName)
      The name displayed to recipients when a phone call is placed as part of the callback. May be overridden by other settings in the system such as external trunk settings. Telco support for \"callerIdName\" varies.

    • getCallerIdName

      public String getCallerIdName()

    • setCallerIdName

      public void setCallerIdName(String callerIdName)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object