| Requires any of the roles: | SystemAdministrator, Manager, Customer |
| POST | /notifications/{notificationId}/resend |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EntityInfo:
# @ApiMember(Description="The ID of the object")
id: Optional[str] = None
"""
The ID of the object
"""
# @ApiMember(Description="The date the object was created")
date_created: Optional[str] = None
"""
The date the object was created
"""
# @ApiMember(Description="The date the object was last modified")
date_last_modified: Optional[str] = None
"""
The date the object was last modified
"""
# @ApiMember(Description="The user that created this object")
created_by: Optional[str] = None
"""
The user that created this object
"""
# @ApiMember(Description="The user that last modified this object")
last_modified_by: Optional[str] = None
"""
The user that last modified this object
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerBreadcrumb:
id: Optional[str] = None
name: Optional[str] = None
class NotificationTypes(str, Enum):
EMAIL = 'Email'
SMS = 'Sms'
PUSH = 'Push'
INCOMING_CALL = 'IncomingCall'
OUTGOING_CALL = 'OutgoingCall'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NotificationRecipientInfo:
# @ApiMember(Description="The address of the recipient")
address: Optional[str] = None
"""
The address of the recipient
"""
# @ApiMember(Description="Extra info about the recipient e.g. CC, BCC")
extra: Optional[str] = None
"""
Extra info about the recipient e.g. CC, BCC
"""
# @ApiMember(Description="The name of the recipient")
name: Optional[str] = None
"""
The name of the recipient
"""
class FileTypes(str, Enum):
UPLOAD = 'Upload'
VOICE_MESSAGE = 'VoiceMessage'
CALL_RECORDING = 'CallRecording'
FAX = 'Fax'
ATTACHMENT = 'Attachment'
FAX_OUTGOING = 'FaxOutgoing'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FileInfo(EntityInfo):
# @ApiMember(Description="The type of file this is")
type: Optional[FileTypes] = None
"""
The type of file this is
"""
# @ApiMember(Description="The account ID this file is associated with")
account_id: Optional[str] = None
"""
The account ID this file is associated with
"""
# @ApiMember(Description="The name of the account this file is associated with")
account_name: Optional[str] = None
"""
The name of the account this file is associated with
"""
# @ApiMember(Description="The ID of the customer this file is associated with")
customer_id: Optional[str] = None
"""
The ID of the customer this file is associated with
"""
# @ApiMember(Description="The name of the customer this file is associated with")
customer_name: Optional[str] = None
"""
The name of the customer this file is associated with
"""
# @ApiMember(Description="The breadcrumb to the customer for this file")
customer_breadcrumb: Optional[List[CustomerBreadcrumb]] = None
"""
The breadcrumb to the customer for this file
"""
# @ApiMember(Description="The ID of the user this file is assocaited with")
user_id: Optional[str] = None
"""
The ID of the user this file is assocaited with
"""
# @ApiMember(Description="The name of the user this file is associated with")
user_name: Optional[str] = None
"""
The name of the user this file is associated with
"""
# @ApiMember(Description="The original file name for the file")
file_name: Optional[str] = None
"""
The original file name for the file
"""
# @ApiMember(Description="The URI of the file")
uri: Optional[str] = None
"""
The URI of the file
"""
# @ApiMember(Description="The Content type of the file")
content_type: Optional[str] = None
"""
The Content type of the file
"""
# @ApiMember(Description="The size of the file")
content_length: Optional[int] = None
"""
The size of the file
"""
# @ApiMember(Description="The Twilio ID of the recording")
recording_sid: Optional[str] = None
"""
The Twilio ID of the recording
"""
# @ApiMember(Description="The duration of the recording in seconds")
recording_duration: Optional[int] = None
"""
The duration of the recording in seconds
"""
# @ApiMember(Description="Who is the recording from?")
recording_from: Optional[str] = None
"""
Who is the recording from?
"""
# @ApiMember(Description="Transcription (if available)")
transcription: Optional[str] = None
"""
Transcription (if available)
"""
# @ApiMember(Description="From Address (e.g. caller ID) for incoming calls")
from_address: Optional[str] = None
"""
From Address (e.g. caller ID) for incoming calls
"""
# @ApiMember(Description="To Address (e.g. dialed number) for outgoing calls")
to_address: Optional[str] = None
"""
To Address (e.g. dialed number) for outgoing calls
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NotificationInfo(EntityInfo):
# @ApiMember(Description="The account ID this endpoint is associated with")
account_id: Optional[str] = None
"""
The account ID this endpoint is associated with
"""
# @ApiMember(Description="The name of the account this endpoint is associated with")
account_name: Optional[str] = None
"""
The name of the account this endpoint is associated with
"""
# @ApiMember(Description="The ID of the customer this endpoint is associated with")
customer_id: Optional[str] = None
"""
The ID of the customer this endpoint is associated with
"""
# @ApiMember(Description="The name of the customer this endpoint is associated with")
customer_name: Optional[str] = None
"""
The name of the customer this endpoint is associated with
"""
# @ApiMember(Description="The breadcrumb to the customer for this endpoint")
customer_breadcrumb: Optional[List[CustomerBreadcrumb]] = None
"""
The breadcrumb to the customer for this endpoint
"""
# @ApiMember(Description="The type of notification")
type: Optional[NotificationTypes] = None
"""
The type of notification
"""
# @ApiMember(Description="The subject of the notification")
subject: Optional[str] = None
"""
The subject of the notification
"""
# @ApiMember(Description="The body of the notification")
body: Optional[str] = None
"""
The body of the notification
"""
# @ApiMember(Description="The recipients of this notification")
recipients: Optional[List[NotificationRecipientInfo]] = None
"""
The recipients of this notification
"""
# @ApiMember(Description="The list of attachments")
attachments: Optional[List[FileInfo]] = None
"""
The list of attachments
"""
# @ApiMember(Description="The original from for the session")
from_: Optional[str] = field(metadata=config(field_name='from'), default=None)
"""
The original from for the session
"""
# @ApiMember(Description="The original To for the session")
to: Optional[str] = None
"""
The original To for the session
"""
# @ApiMember(Description="Was there an error?")
error: Optional[bool] = None
"""
Was there an error?
"""
# @ApiMember(Description="The error message")
error_message: Optional[str] = None
"""
The error message
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResendNotification:
# @ApiMember(Description="The ID of the notification to resend")
notification_id: Optional[str] = None
"""
The ID of the notification to resend
"""
Python 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: 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,
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
}