Requires any of the roles: | SystemAdministrator, Manager, Customer |
POST | /notifications/{notificationId}/resend |
---|
export class NodeParameterMap
{
[key:string] : NodeParameter;
public constructor(init?: Partial<NodeParameterMap>) { (Object as any).assign(this, init); }
}
export class EntityInfo
{
/** @description The ID of the object */
// @ApiMember(Description="The ID of the object")
public id: string;
/** @description The date the object was created */
// @ApiMember(Description="The date the object was created")
public dateCreated: string;
/** @description The date the object was last modified */
// @ApiMember(Description="The date the object was last modified")
public dateLastModified: string;
/** @description The user that created this object */
// @ApiMember(Description="The user that created this object")
public createdBy: string;
/** @description The user that last modified this object */
// @ApiMember(Description="The user that last modified this object")
public lastModifiedBy: string;
public constructor(init?: Partial<EntityInfo>) { (Object as any).assign(this, init); }
}
export class CustomerBreadcrumb
{
public id: string;
public name: string;
public constructor(init?: Partial<CustomerBreadcrumb>) { (Object as any).assign(this, init); }
}
export enum NotificationTypes
{
Email = 'Email',
Sms = 'Sms',
Push = 'Push',
IncomingCall = 'IncomingCall',
OutgoingCall = 'OutgoingCall',
}
export class NotificationRecipientInfo
{
/** @description The address of the recipient */
// @ApiMember(Description="The address of the recipient")
public address: string;
/** @description Extra info about the recipient e.g. CC, BCC */
// @ApiMember(Description="Extra info about the recipient e.g. CC, BCC")
public extra: string;
/** @description The name of the recipient */
// @ApiMember(Description="The name of the recipient")
public name: string;
public constructor(init?: Partial<NotificationRecipientInfo>) { (Object as any).assign(this, init); }
}
export enum FileTypes
{
Upload = 'Upload',
VoiceMessage = 'VoiceMessage',
CallRecording = 'CallRecording',
Fax = 'Fax',
Attachment = 'Attachment',
FaxOutgoing = 'FaxOutgoing',
}
export class FileInfo extends EntityInfo
{
/** @description The type of file this is */
// @ApiMember(Description="The type of file this is")
public type: FileTypes;
/** @description The account ID this file is associated with */
// @ApiMember(Description="The account ID this file is associated with")
public accountId: string;
/** @description The name of the account this file is associated with */
// @ApiMember(Description="The name of the account this file is associated with")
public accountName: string;
/** @description The ID of the customer this file is associated with */
// @ApiMember(Description="The ID of the customer this file is associated with")
public customerId: string;
/** @description The name of the customer this file is associated with */
// @ApiMember(Description="The name of the customer this file is associated with")
public customerName: string;
/** @description The breadcrumb to the customer for this file */
// @ApiMember(Description="The breadcrumb to the customer for this file")
public customerBreadcrumb: CustomerBreadcrumb[];
/** @description The ID of the user this file is assocaited with */
// @ApiMember(Description="The ID of the user this file is assocaited with")
public userId: string;
/** @description The name of the user this file is associated with */
// @ApiMember(Description="The name of the user this file is associated with")
public userName: string;
/** @description The original file name for the file */
// @ApiMember(Description="The original file name for the file")
public fileName: string;
/** @description The URI of the file */
// @ApiMember(Description="The URI of the file")
public uri: string;
/** @description The Content type of the file */
// @ApiMember(Description="The Content type of the file")
public contentType: string;
/** @description The size of the file */
// @ApiMember(Description="The size of the file")
public contentLength: number;
/** @description The Twilio ID of the recording */
// @ApiMember(Description="The Twilio ID of the recording")
public recordingSid: string;
/** @description The duration of the recording in seconds */
// @ApiMember(Description="The duration of the recording in seconds")
public recordingDuration: number;
/** @description Who is the recording from? */
// @ApiMember(Description="Who is the recording from?")
public recordingFrom: string;
/** @description Transcription (if available) */
// @ApiMember(Description="Transcription (if available)")
public transcription: string;
/** @description From Address (e.g. caller ID) for incoming calls */
// @ApiMember(Description="From Address (e.g. caller ID) for incoming calls")
public fromAddress: string;
/** @description To Address (e.g. dialed number) for outgoing calls */
// @ApiMember(Description="To Address (e.g. dialed number) for outgoing calls")
public toAddress: string;
/** @description The AI transcription for this call */
// @ApiMember(Description="The AI transcription for this call")
public aiTranscription: string;
public constructor(init?: Partial<FileInfo>) { super(init); (Object as any).assign(this, init); }
}
export class NotificationInfo extends EntityInfo
{
/** @description The account ID this endpoint is associated with */
// @ApiMember(Description="The account ID this endpoint is associated with")
public accountId: string;
/** @description The name of the account this endpoint is associated with */
// @ApiMember(Description="The name of the account this endpoint is associated with")
public accountName: string;
/** @description The ID of the customer this endpoint is associated with */
// @ApiMember(Description="The ID of the customer this endpoint is associated with")
public customerId: string;
/** @description The name of the customer this endpoint is associated with */
// @ApiMember(Description="The name of the customer this endpoint is associated with")
public customerName: string;
/** @description The breadcrumb to the customer for this endpoint */
// @ApiMember(Description="The breadcrumb to the customer for this endpoint")
public customerBreadcrumb: CustomerBreadcrumb[];
/** @description The type of notification */
// @ApiMember(Description="The type of notification")
public type: NotificationTypes;
/** @description The subject of the notification */
// @ApiMember(Description="The subject of the notification")
public subject: string;
/** @description The body of the notification */
// @ApiMember(Description="The body of the notification")
public body: string;
/** @description The recipients of this notification */
// @ApiMember(Description="The recipients of this notification")
public recipients: NotificationRecipientInfo[];
/** @description The list of attachments */
// @ApiMember(Description="The list of attachments")
public attachments: FileInfo[];
/** @description The original from for the session */
// @ApiMember(Description="The original from for the session")
public from: string;
/** @description The original To for the session */
// @ApiMember(Description="The original To for the session")
public to: string;
/** @description Was there an error? */
// @ApiMember(Description="Was there an error?")
public error: boolean;
/** @description The error message */
// @ApiMember(Description="The error message")
public errorMessage: string;
public constructor(init?: Partial<NotificationInfo>) { super(init); (Object as any).assign(this, init); }
}
export class ResendNotification
{
/** @description The ID of the notification to resend */
// @ApiMember(Description="The ID of the notification to resend")
public notificationId: string;
public constructor(init?: Partial<ResendNotification>) { (Object as any).assign(this, init); }
}
TypeScript ResendNotification DTOs
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 }