Requires any of the roles: | SystemAdministrator, Manager, Customer |
POST | /notifications/{notificationId}/resend |
---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
public static class ResendNotification
{
/**
* The ID of the notification to resend
*/
@ApiMember(Description="The ID of the notification to resend")
public String notificationId = null;
public String getNotificationId() { return notificationId; }
public ResendNotification setNotificationId(String value) { this.notificationId = value; return this; }
}
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;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /notifications/{notificationId}/resend HTTP/1.1
Host: team.evovoice.io
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
notificationId: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { 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 }