| All Verbs | /not-used |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
public static class NotUsedRequest
{
public PushNotification pushNotification = null;
public ArrayList<NotificationInfo> notifications = null;
public NodeParameter nodeParameter = null;
public PushNotification getPushNotification() { return pushNotification; }
public NotUsedRequest setPushNotification(PushNotification value) { this.pushNotification = value; return this; }
public ArrayList<NotificationInfo> getNotifications() { return notifications; }
public NotUsedRequest setNotifications(ArrayList<NotificationInfo> value) { this.notifications = value; return this; }
public NodeParameter getNodeParameter() { return nodeParameter; }
public NotUsedRequest setNodeParameter(NodeParameter value) { this.nodeParameter = value; return this; }
}
public static class PushNotification
{
public PushNotificationTypes type = null;
public FlowChannels channel = null;
public String endpointId = null;
public String endpointUserName = null;
public String sessionId = null;
public String sender = null;
public String title = null;
public String body = null;
public Integer badge = null;
public String attachmentUri = null;
public String attachmentContentType = null;
public AgentStates agentState = null;
public AgentStateReasons agentStateReason = null;
public PushNotificationTypes getType() { return type; }
public PushNotification setType(PushNotificationTypes value) { this.type = value; return this; }
public FlowChannels getChannel() { return channel; }
public PushNotification setChannel(FlowChannels value) { this.channel = value; return this; }
public String getEndpointId() { return endpointId; }
public PushNotification setEndpointId(String value) { this.endpointId = value; return this; }
public String getEndpointUserName() { return endpointUserName; }
public PushNotification setEndpointUserName(String value) { this.endpointUserName = value; return this; }
public String getSessionId() { return sessionId; }
public PushNotification setSessionId(String value) { this.sessionId = value; return this; }
public String getSender() { return sender; }
public PushNotification setSender(String value) { this.sender = value; return this; }
public String getTitle() { return title; }
public PushNotification setTitle(String value) { this.title = value; return this; }
public String getBody() { return body; }
public PushNotification setBody(String value) { this.body = value; return this; }
public Integer getBadge() { return badge; }
public PushNotification setBadge(Integer value) { this.badge = value; return this; }
public String getAttachmentUri() { return attachmentUri; }
public PushNotification setAttachmentUri(String value) { this.attachmentUri = value; return this; }
public String getAttachmentContentType() { return attachmentContentType; }
public PushNotification setAttachmentContentType(String value) { this.attachmentContentType = value; return this; }
public AgentStates getAgentState() { return agentState; }
public PushNotification setAgentState(AgentStates value) { this.agentState = value; return this; }
public AgentStateReasons getAgentStateReason() { return agentStateReason; }
public PushNotification setAgentStateReason(AgentStateReasons value) { this.agentStateReason = value; return this; }
}
public static enum PushNotificationTypes
{
SessionDisconnected,
SessionInvite,
ChatMessage,
SessionInactivated,
AgentStateChanged,
SessionHeld,
SessionAnswered,
ActiveSessionsChanged,
Ping,
SessionScreenChanged,
Toast,
SessionInfoChanged,
MessageReceived,
SessionHolding;
}
public static enum FlowChannels
{
Voice,
Chat,
Fax;
}
public static enum AgentStates
{
Unknown,
Ready,
NotReady,
LoggedOut,
WrapUp,
Outgoing,
Other;
}
public static enum AgentStateReasons
{
Unknown,
SetByUser,
MissedCall,
SetBySystem;
}
public static class NotificationInfo extends EntityInfo
{
/**
* The account ID this endpoint is associated with
*/
@ApiMember(Description="The account ID this endpoint is associated with")
public String accountId = null;
/**
* The name of the account this endpoint is associated with
*/
@ApiMember(Description="The name of the account this endpoint is associated with")
public String accountName = null;
/**
* The ID of the customer this endpoint is associated with
*/
@ApiMember(Description="The ID of the customer this endpoint is associated with")
public String customerId = null;
/**
* The name of the customer this endpoint is associated with
*/
@ApiMember(Description="The name of the customer this endpoint is associated with")
public String customerName = null;
/**
* The breadcrumb to the customer for this endpoint
*/
@ApiMember(Description="The breadcrumb to the customer for this endpoint")
public ArrayList<CustomerBreadcrumb> customerBreadcrumb = null;
/**
* The type of notification
*/
@ApiMember(Description="The type of notification")
public NotificationTypes type = null;
/**
* The subject of the notification
*/
@ApiMember(Description="The subject of the notification")
public String subject = null;
/**
* The body of the notification
*/
@ApiMember(Description="The body of the notification")
public String body = null;
/**
* The recipients of this notification
*/
@ApiMember(Description="The recipients of this notification")
public ArrayList<NotificationRecipientInfo> recipients = null;
/**
* The list of attachments
*/
@ApiMember(Description="The list of attachments")
public ArrayList<FileInfo> attachments = null;
/**
* The original from for the session
*/
@ApiMember(Description="The original from for the session")
public String from = null;
/**
* The original To for the session
*/
@ApiMember(Description="The original To for the session")
public String to = null;
/**
* Was there an error?
*/
@ApiMember(Description="Was there an error?")
public Boolean error = null;
/**
* The error message
*/
@ApiMember(Description="The error message")
public String errorMessage = null;
public String getAccountId() { return accountId; }
public NotificationInfo setAccountId(String value) { this.accountId = value; return this; }
public String getAccountName() { return accountName; }
public NotificationInfo setAccountName(String value) { this.accountName = value; return this; }
public String getCustomerId() { return customerId; }
public NotificationInfo setCustomerId(String value) { this.customerId = value; return this; }
public String getCustomerName() { return customerName; }
public NotificationInfo setCustomerName(String value) { this.customerName = value; return this; }
public ArrayList<CustomerBreadcrumb> getCustomerBreadcrumb() { return customerBreadcrumb; }
public NotificationInfo setCustomerBreadcrumb(ArrayList<CustomerBreadcrumb> value) { this.customerBreadcrumb = value; return this; }
public NotificationTypes getType() { return type; }
public NotificationInfo setType(NotificationTypes value) { this.type = value; return this; }
public String getSubject() { return subject; }
public NotificationInfo setSubject(String value) { this.subject = value; return this; }
public String getBody() { return body; }
public NotificationInfo setBody(String value) { this.body = value; return this; }
public ArrayList<NotificationRecipientInfo> getRecipients() { return recipients; }
public NotificationInfo setRecipients(ArrayList<NotificationRecipientInfo> value) { this.recipients = value; return this; }
public ArrayList<FileInfo> getAttachments() { return attachments; }
public NotificationInfo setAttachments(ArrayList<FileInfo> value) { this.attachments = value; return this; }
public String getFrom() { return from; }
public NotificationInfo setFrom(String value) { this.from = value; return this; }
public String getTo() { return to; }
public NotificationInfo setTo(String value) { this.to = value; return this; }
public Boolean isError() { return error; }
public NotificationInfo setError(Boolean value) { this.error = value; return this; }
public String getErrorMessage() { return errorMessage; }
public NotificationInfo setErrorMessage(String value) { this.errorMessage = value; return this; }
}
public static class EntityInfo
{
/**
* The ID of the object
*/
@ApiMember(Description="The ID of the object")
public String id = null;
/**
* The date the object was created
*/
@ApiMember(Description="The date the object was created")
public String dateCreated = null;
/**
* The date the object was last modified
*/
@ApiMember(Description="The date the object was last modified")
public String dateLastModified = null;
/**
* The user that created this object
*/
@ApiMember(Description="The user that created this object")
public String createdBy = null;
/**
* The user that last modified this object
*/
@ApiMember(Description="The user that last modified this object")
public String lastModifiedBy = null;
public String getId() { return id; }
public EntityInfo setId(String value) { this.id = value; return this; }
public String getDateCreated() { return dateCreated; }
public EntityInfo setDateCreated(String value) { this.dateCreated = value; return this; }
public String getDateLastModified() { return dateLastModified; }
public EntityInfo setDateLastModified(String value) { this.dateLastModified = value; return this; }
public String getCreatedBy() { return createdBy; }
public EntityInfo setCreatedBy(String value) { this.createdBy = value; return this; }
public String getLastModifiedBy() { return lastModifiedBy; }
public EntityInfo setLastModifiedBy(String value) { this.lastModifiedBy = value; return this; }
}
public static class CustomerBreadcrumb
{
public String id = null;
public String name = null;
public String getId() { return id; }
public CustomerBreadcrumb setId(String value) { this.id = value; return this; }
public String getName() { return name; }
public CustomerBreadcrumb setName(String value) { this.name = value; return this; }
}
public static enum NotificationTypes
{
Email,
Sms,
Push,
IncomingCall,
OutgoingCall;
}
public static class NotificationRecipientInfo
{
/**
* The address of the recipient
*/
@ApiMember(Description="The address of the recipient")
public String address = null;
/**
* Extra info about the recipient e.g. CC, BCC
*/
@ApiMember(Description="Extra info about the recipient e.g. CC, BCC")
public String extra = null;
/**
* The name of the recipient
*/
@ApiMember(Description="The name of the recipient")
public String name = null;
public String getAddress() { return address; }
public NotificationRecipientInfo setAddress(String value) { this.address = value; return this; }
public String getExtra() { return extra; }
public NotificationRecipientInfo setExtra(String value) { this.extra = value; return this; }
public String getName() { return name; }
public NotificationRecipientInfo setName(String value) { this.name = value; return this; }
}
public static class FileInfo extends EntityInfo
{
/**
* The type of file this is
*/
@ApiMember(Description="The type of file this is")
public FileTypes type = null;
/**
* The account ID this file is associated with
*/
@ApiMember(Description="The account ID this file is associated with")
public String accountId = null;
/**
* The name of the account this file is associated with
*/
@ApiMember(Description="The name of the account this file is associated with")
public String accountName = null;
/**
* The ID of the customer this file is associated with
*/
@ApiMember(Description="The ID of the customer this file is associated with")
public String customerId = null;
/**
* The name of the customer this file is associated with
*/
@ApiMember(Description="The name of the customer this file is associated with")
public String customerName = null;
/**
* The breadcrumb to the customer for this file
*/
@ApiMember(Description="The breadcrumb to the customer for this file")
public ArrayList<CustomerBreadcrumb> customerBreadcrumb = null;
/**
* The ID of the user this file is assocaited with
*/
@ApiMember(Description="The ID of the user this file is assocaited with")
public String userId = null;
/**
* The name of the user this file is associated with
*/
@ApiMember(Description="The name of the user this file is associated with")
public String userName = null;
/**
* The original file name for the file
*/
@ApiMember(Description="The original file name for the file")
public String fileName = null;
/**
* The URI of the file
*/
@ApiMember(Description="The URI of the file")
public String uri = null;
/**
* The Content type of the file
*/
@ApiMember(Description="The Content type of the file")
public String contentType = null;
/**
* The size of the file
*/
@ApiMember(Description="The size of the file")
public Long contentLength = null;
/**
* The Twilio ID of the recording
*/
@ApiMember(Description="The Twilio ID of the recording")
public String recordingSid = null;
/**
* The duration of the recording in seconds
*/
@ApiMember(Description="The duration of the recording in seconds")
public Integer recordingDuration = null;
/**
* Who is the recording from?
*/
@ApiMember(Description="Who is the recording from?")
public String recordingFrom = null;
/**
* Transcription (if available)
*/
@ApiMember(Description="Transcription (if available)")
public String transcription = null;
/**
* From Address (e.g. caller ID) for incoming calls
*/
@ApiMember(Description="From Address (e.g. caller ID) for incoming calls")
public String fromAddress = null;
/**
* To Address (e.g. dialed number) for outgoing calls
*/
@ApiMember(Description="To Address (e.g. dialed number) for outgoing calls")
public String toAddress = null;
/**
* The AI transcription for this call
*/
@ApiMember(Description="The AI transcription for this call")
public String aiTranscription = null;
public FileTypes getType() { return type; }
public FileInfo setType(FileTypes value) { this.type = value; return this; }
public String getAccountId() { return accountId; }
public FileInfo setAccountId(String value) { this.accountId = value; return this; }
public String getAccountName() { return accountName; }
public FileInfo setAccountName(String value) { this.accountName = value; return this; }
public String getCustomerId() { return customerId; }
public FileInfo setCustomerId(String value) { this.customerId = value; return this; }
public String getCustomerName() { return customerName; }
public FileInfo setCustomerName(String value) { this.customerName = value; return this; }
public ArrayList<CustomerBreadcrumb> getCustomerBreadcrumb() { return customerBreadcrumb; }
public FileInfo setCustomerBreadcrumb(ArrayList<CustomerBreadcrumb> value) { this.customerBreadcrumb = value; return this; }
public String getUserId() { return userId; }
public FileInfo setUserId(String value) { this.userId = value; return this; }
public String getUserName() { return userName; }
public FileInfo setUserName(String value) { this.userName = value; return this; }
public String getFileName() { return fileName; }
public FileInfo setFileName(String value) { this.fileName = value; return this; }
public String getUri() { return uri; }
public FileInfo setUri(String value) { this.uri = value; return this; }
public String getContentType() { return contentType; }
public FileInfo setContentType(String value) { this.contentType = value; return this; }
public Long getContentLength() { return contentLength; }
public FileInfo setContentLength(Long value) { this.contentLength = value; return this; }
public String getRecordingSid() { return recordingSid; }
public FileInfo setRecordingSid(String value) { this.recordingSid = value; return this; }
public Integer getRecordingDuration() { return recordingDuration; }
public FileInfo setRecordingDuration(Integer value) { this.recordingDuration = value; return this; }
public String getRecordingFrom() { return recordingFrom; }
public FileInfo setRecordingFrom(String value) { this.recordingFrom = value; return this; }
public String getTranscription() { return transcription; }
public FileInfo setTranscription(String value) { this.transcription = value; return this; }
public String getFromAddress() { return fromAddress; }
public FileInfo setFromAddress(String value) { this.fromAddress = value; return this; }
public String getToAddress() { return toAddress; }
public FileInfo setToAddress(String value) { this.toAddress = value; return this; }
public String getAiTranscription() { return aiTranscription; }
public FileInfo setAiTranscription(String value) { this.aiTranscription = value; return this; }
}
public static enum FileTypes
{
Upload,
VoiceMessage,
CallRecording,
Fax,
Attachment,
FaxOutgoing;
}
public static class NodeParameter
{
public String id = null;
public ValueTypes type = null;
public ValueSources source = null;
public Boolean isAsync = null;
public String referenceId = null;
public Value value = null;
public Boolean noEvalTemplate = null;
public ArrayList<NodeParameterMap> listParameters = null;
public NodeParameterMap structParameters = null;
public Boolean isOutput = null;
public String expression = null;
public DataType listType = null;
public String getId() { return id; }
public NodeParameter setId(String value) { this.id = value; return this; }
public ValueTypes getType() { return type; }
public NodeParameter setType(ValueTypes value) { this.type = value; return this; }
public ValueSources getSource() { return source; }
public NodeParameter setSource(ValueSources value) { this.source = value; return this; }
public Boolean getIsAsync() { return isAsync; }
public NodeParameter setIsAsync(Boolean value) { this.isAsync = value; return this; }
public String getReferenceId() { return referenceId; }
public NodeParameter setReferenceId(String value) { this.referenceId = value; return this; }
public Value getValue() { return value; }
public NodeParameter setValue(Value value) { this.value = value; return this; }
public Boolean isNoEvalTemplate() { return noEvalTemplate; }
public NodeParameter setNoEvalTemplate(Boolean value) { this.noEvalTemplate = value; return this; }
public ArrayList<NodeParameterMap> getListParameters() { return listParameters; }
public NodeParameter setListParameters(ArrayList<NodeParameterMap> value) { this.listParameters = value; return this; }
public NodeParameterMap getStructParameters() { return structParameters; }
public NodeParameter setStructParameters(NodeParameterMap value) { this.structParameters = value; return this; }
public Boolean getIsOutput() { return isOutput; }
public NodeParameter setIsOutput(Boolean value) { this.isOutput = value; return this; }
public String getExpression() { return expression; }
public NodeParameter setExpression(String value) { this.expression = value; return this; }
public DataType getListType() { return listType; }
public NodeParameter setListType(DataType value) { this.listType = value; return this; }
}
public static enum ValueTypes
{
NotSpecified,
String,
Boolean,
Number,
List,
Struct,
Transition,
Custom,
Date,
AudioFile,
TimeZoneId,
PhoneNumber,
User,
Endpoint,
Time,
File,
FaxNumber,
EmailAccount,
Customer,
Flow,
Team,
FlowReference,
Integration,
Assistant;
}
public static enum ValueSources
{
Value,
Flow,
System,
Customer,
Session,
Endpoint,
Expression,
User;
}
public static class Value
{
public Boolean boolValue = null;
public String stringValue = null;
public Double numberValue = null;
public ArrayList<Struct> listValue = null;
public Struct structValue = null;
public Boolean isBoolValue() { return boolValue; }
public Value setBoolValue(Boolean value) { this.boolValue = value; return this; }
public String getStringValue() { return stringValue; }
public Value setStringValue(String value) { this.stringValue = value; return this; }
public Double getNumberValue() { return numberValue; }
public Value setNumberValue(Double value) { this.numberValue = value; return this; }
public ArrayList<Struct> getListValue() { return listValue; }
public Value setListValue(ArrayList<Struct> value) { this.listValue = value; return this; }
public Struct getStructValue() { return structValue; }
public Value setStructValue(Struct value) { this.structValue = value; return this; }
}
public static class Struct extends HashMap<String,Value>
{
}
public static class NodeParameterMap extends HashMap<String,NodeParameter>
{
}
public static class DataType
{
public String typeName = null;
public ArrayList<DataField> fields = null;
public String getTypeName() { return typeName; }
public DataType setTypeName(String value) { this.typeName = value; return this; }
public ArrayList<DataField> getFields() { return fields; }
public DataType setFields(ArrayList<DataField> value) { this.fields = value; return this; }
}
public static class DataField
{
public String id = null;
public String name = null;
public ValueTypes type = null;
public UIHints uiHint = null;
public String uiTab = null;
public Boolean isAsync = null;
public Boolean disableBinding = null;
public DataType structType = null;
public DataType listType = null;
public String description = null;
public ArrayList<String> possibleValues = null;
public Boolean isOutput = null;
public String customFieldValuesUrl = null;
public Value defaultValue = null;
public String transitionNameFormat = null;
public DataFieldUniqueness uniqueness = null;
public Boolean voiceOnly = null;
public String conditionalVisibilityField = null;
public String conditionalVisibilityValue = null;
public Boolean noEvalTemplate = null;
public UserDataFieldModes userMode = null;
public Boolean anyValueType = null;
public String getId() { return id; }
public DataField setId(String value) { this.id = value; return this; }
public String getName() { return name; }
public DataField setName(String value) { this.name = value; return this; }
public ValueTypes getType() { return type; }
public DataField setType(ValueTypes value) { this.type = value; return this; }
public UIHints getUiHint() { return uiHint; }
public DataField setUiHint(UIHints value) { this.uiHint = value; return this; }
public String getUiTab() { return uiTab; }
public DataField setUiTab(String value) { this.uiTab = value; return this; }
public Boolean getIsAsync() { return isAsync; }
public DataField setIsAsync(Boolean value) { this.isAsync = value; return this; }
public Boolean isDisableBinding() { return disableBinding; }
public DataField setDisableBinding(Boolean value) { this.disableBinding = value; return this; }
public DataType getStructType() { return structType; }
public DataField setStructType(DataType value) { this.structType = value; return this; }
public DataType getListType() { return listType; }
public DataField setListType(DataType value) { this.listType = value; return this; }
public String getDescription() { return description; }
public DataField setDescription(String value) { this.description = value; return this; }
public ArrayList<String> getPossibleValues() { return possibleValues; }
public DataField setPossibleValues(ArrayList<String> value) { this.possibleValues = value; return this; }
public Boolean getIsOutput() { return isOutput; }
public DataField setIsOutput(Boolean value) { this.isOutput = value; return this; }
public String getCustomFieldValuesUrl() { return customFieldValuesUrl; }
public DataField setCustomFieldValuesUrl(String value) { this.customFieldValuesUrl = value; return this; }
public Value getDefaultValue() { return defaultValue; }
public DataField setDefaultValue(Value value) { this.defaultValue = value; return this; }
public String getTransitionNameFormat() { return transitionNameFormat; }
public DataField setTransitionNameFormat(String value) { this.transitionNameFormat = value; return this; }
public DataFieldUniqueness getUniqueness() { return uniqueness; }
public DataField setUniqueness(DataFieldUniqueness value) { this.uniqueness = value; return this; }
public Boolean isVoiceOnly() { return voiceOnly; }
public DataField setVoiceOnly(Boolean value) { this.voiceOnly = value; return this; }
public String getConditionalVisibilityField() { return conditionalVisibilityField; }
public DataField setConditionalVisibilityField(String value) { this.conditionalVisibilityField = value; return this; }
public String getConditionalVisibilityValue() { return conditionalVisibilityValue; }
public DataField setConditionalVisibilityValue(String value) { this.conditionalVisibilityValue = value; return this; }
public Boolean isNoEvalTemplate() { return noEvalTemplate; }
public DataField setNoEvalTemplate(Boolean value) { this.noEvalTemplate = value; return this; }
public UserDataFieldModes getUserMode() { return userMode; }
public DataField setUserMode(UserDataFieldModes value) { this.userMode = value; return this; }
public Boolean isAnyValueType() { return anyValueType; }
public DataField setAnyValueType(Boolean value) { this.anyValueType = value; return this; }
}
public static enum UIHints
{
None,
LargeText,
InlineForm,
Password,
InlineStruct;
}
public static enum DataFieldUniqueness
{
NotUnique,
Unique,
UniqueToCustomer;
}
public static enum UserDataFieldModes
{
Hidden,
ReadOnly,
ReadWrite;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /not-used HTTP/1.1
Host: team.evovoice.io
Accept: application/json
Content-Type: application/json
Content-Length: length
{"pushNotification":{"type":"SessionDisconnected","channel":"Voice","endpointId":"String","endpointUserName":"String","sessionId":"String","sender":"String","title":"String","body":"String","badge":0,"attachmentUri":"String","attachmentContentType":"String","agentState":"Unknown","agentStateReason":"Unknown"},"notifications":[{"accountId":"String","accountName":"String","customerId":"String","customerName":"String","customerBreadcrumb":[{"id":"String","name":"String"}],"type":"Email","subject":"String","body":"String","recipients":[{"address":"String","extra":"String","name":"String"}],"attachments":[{"type":"Upload","accountId":"String","accountName":"String","customerId":"String","customerName":"String","customerBreadcrumb":[{"id":"String","name":"String"}],"userId":"String","userName":"String","fileName":"String","uri":"String","contentType":"String","contentLength":0,"recordingSid":"String","recordingDuration":0,"recordingFrom":"String","transcription":"String","fromAddress":"String","toAddress":"String","aiTranscription":"String","id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}],"from":"String","to":"String","error":false,"errorMessage":"String","id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}]}