Evo Voice

<back to all web services

NotUsedRequest

The following routes are available for this service:
All Verbs/not-used
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


class PushNotificationTypes(str, Enum):
    SESSION_DISCONNECTED = 'SessionDisconnected'
    SESSION_INVITE = 'SessionInvite'
    CHAT_MESSAGE = 'ChatMessage'
    SESSION_INACTIVATED = 'SessionInactivated'
    AGENT_STATE_CHANGED = 'AgentStateChanged'
    SESSION_HELD = 'SessionHeld'
    SESSION_ANSWERED = 'SessionAnswered'
    ACTIVE_SESSIONS_CHANGED = 'ActiveSessionsChanged'
    PING = 'Ping'
    SESSION_SCREEN_CHANGED = 'SessionScreenChanged'
    TOAST = 'Toast'
    SESSION_INFO_CHANGED = 'SessionInfoChanged'
    MESSAGE_RECEIVED = 'MessageReceived'
    SESSION_HOLDING = 'SessionHolding'


class FlowChannels(str, Enum):
    VOICE = 'Voice'
    CHAT = 'Chat'
    FAX = 'Fax'


class AgentStates(str, Enum):
    UNKNOWN = 'Unknown'
    READY = 'Ready'
    NOT_READY = 'NotReady'
    LOGGED_OUT = 'LoggedOut'
    WRAP_UP = 'WrapUp'
    OUTGOING = 'Outgoing'
    OTHER = 'Other'


class AgentStateReasons(str, Enum):
    UNKNOWN = 'Unknown'
    SET_BY_USER = 'SetByUser'
    MISSED_CALL = 'MissedCall'
    SET_BY_SYSTEM = 'SetBySystem'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PushNotification:
    type: Optional[PushNotificationTypes] = None
    channel: Optional[FlowChannels] = None
    endpoint_id: Optional[str] = None
    endpoint_user_name: Optional[str] = None
    session_id: Optional[str] = None
    sender: Optional[str] = None
    title: Optional[str] = None
    body: Optional[str] = None
    badge: Optional[int] = None
    attachment_uri: Optional[str] = None
    attachment_content_type: Optional[str] = None
    agent_state: Optional[AgentStates] = None
    agent_state_reason: Optional[AgentStateReasons] = None


@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: int = 0
    """
    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: int = 0
    """
    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
    """


    # @ApiMember(Description="The AI transcription for this call")
    ai_transcription: Optional[str] = None
    """
    The AI transcription for this call
    """


@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: bool = False
    """
    Was there an error?
    """


    # @ApiMember(Description="The error message")
    error_message: Optional[str] = None
    """
    The error message
    """


class ValueTypes(str, Enum):
    NOT_SPECIFIED = 'NotSpecified'
    STRING = 'String'
    BOOLEAN = 'Boolean'
    NUMBER = 'Number'
    LIST = 'List'
    STRUCT = 'Struct'
    TRANSITION = 'Transition'
    CUSTOM = 'Custom'
    DATE = 'Date'
    AUDIO_FILE = 'AudioFile'
    TIME_ZONE_ID = 'TimeZoneId'
    PHONE_NUMBER = 'PhoneNumber'
    USER = 'User'
    ENDPOINT = 'Endpoint'
    TIME = 'Time'
    FILE = 'File'
    FAX_NUMBER = 'FaxNumber'
    EMAIL_ACCOUNT = 'EmailAccount'
    CUSTOMER = 'Customer'
    FLOW = 'Flow'
    TEAM = 'Team'
    FLOW_REFERENCE = 'FlowReference'
    INTEGRATION = 'Integration'
    ASSISTANT = 'Assistant'


class ValueSources(str, Enum):
    VALUE = 'Value'
    FLOW = 'Flow'
    SYSTEM = 'System'
    CUSTOMER = 'Customer'
    SESSION = 'Session'
    ENDPOINT = 'Endpoint'
    EXPRESSION = 'Expression'
    USER = 'User'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Struct(Dict[str,Value]):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Value:
    bool_value: Optional[bool] = None
    string_value: Optional[str] = None
    number_value: Optional[float] = None
    list_value: Optional[List[Struct]] = None
    struct_value: Optional[Struct] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NodeParameterMap(Dict[str,NodeParameter]):
    pass


class UIHints(str, Enum):
    NONE = 'None'
    LARGE_TEXT = 'LargeText'
    INLINE_FORM = 'InlineForm'
    PASSWORD = 'Password'
    INLINE_STRUCT = 'InlineStruct'


class DataFieldUniqueness(str, Enum):
    NOT_UNIQUE = 'NotUnique'
    UNIQUE = 'Unique'
    UNIQUE_TO_CUSTOMER = 'UniqueToCustomer'


class UserDataFieldModes(str, Enum):
    HIDDEN = 'Hidden'
    READ_ONLY = 'ReadOnly'
    READ_WRITE = 'ReadWrite'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DataField:
    id: Optional[str] = None
    name: Optional[str] = None
    type: Optional[ValueTypes] = None
    ui_hint: Optional[UIHints] = None
    ui_tab: Optional[str] = None
    is_async: bool = False
    disable_binding: bool = False
    struct_type: Optional[DataType] = None
    list_type: Optional[DataType] = None
    description: Optional[str] = None
    possible_values: Optional[List[str]] = None
    is_output: bool = False
    custom_field_values_url: Optional[str] = None
    default_value: Optional[Value] = None
    transition_name_format: Optional[str] = None
    uniqueness: Optional[DataFieldUniqueness] = None
    voice_only: bool = False
    conditional_visibility_field: Optional[str] = None
    conditional_visibility_value: Optional[str] = None
    no_eval_template: bool = False
    user_mode: Optional[UserDataFieldModes] = None
    any_value_type: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DataType:
    type_name: Optional[str] = None
    fields: Optional[List[DataField]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NodeParameter:
    id: Optional[str] = None
    type: Optional[ValueTypes] = None
    source: Optional[ValueSources] = None
    is_async: bool = False
    reference_id: Optional[str] = None
    value: Optional[Value] = None
    no_eval_template: bool = False
    list_parameters: Optional[List[NodeParameterMap]] = None
    struct_parameters: Optional[NodeParameterMap] = None
    is_output: bool = False
    expression: Optional[str] = None
    list_type: Optional[DataType] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NotUsedRequest:
    push_notification: Optional[PushNotification] = None
    notifications: Optional[List[NotificationInfo]] = None
    node_parameter: Optional[NodeParameter] = None

Python NotUsedRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<NotUsedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">
  <NodeParameter xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Flows" i:nil="true" />
  <Notifications xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Notifications">
    <d2p1:NotificationInfo>
      <CreatedBy>String</CreatedBy>
      <DateCreated>String</DateCreated>
      <DateLastModified>String</DateLastModified>
      <Id>String</Id>
      <LastModifiedBy>String</LastModifiedBy>
      <d2p1:AccountId>String</d2p1:AccountId>
      <d2p1:AccountName>String</d2p1:AccountName>
      <d2p1:Attachments xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Files">
        <d4p1:FileInfo>
          <CreatedBy>String</CreatedBy>
          <DateCreated>String</DateCreated>
          <DateLastModified>String</DateLastModified>
          <Id>String</Id>
          <LastModifiedBy>String</LastModifiedBy>
          <d4p1:AITranscription>String</d4p1:AITranscription>
          <d4p1:AccountId>String</d4p1:AccountId>
          <d4p1:AccountName>String</d4p1:AccountName>
          <d4p1:ContentLength>0</d4p1:ContentLength>
          <d4p1:ContentType>String</d4p1:ContentType>
          <d4p1:CustomerBreadcrumb xmlns:d6p1="http://schemas.datacontract.org/2004/07/Voice.Api.Customers">
            <d6p1:CustomerBreadcrumb>
              <d6p1:Id>String</d6p1:Id>
              <d6p1:Name>String</d6p1:Name>
            </d6p1:CustomerBreadcrumb>
          </d4p1:CustomerBreadcrumb>
          <d4p1:CustomerId>String</d4p1:CustomerId>
          <d4p1:CustomerName>String</d4p1:CustomerName>
          <d4p1:FileName>String</d4p1:FileName>
          <d4p1:FromAddress>String</d4p1:FromAddress>
          <d4p1:RecordingDuration>0</d4p1:RecordingDuration>
          <d4p1:RecordingFrom>String</d4p1:RecordingFrom>
          <d4p1:RecordingSid>String</d4p1:RecordingSid>
          <d4p1:ToAddress>String</d4p1:ToAddress>
          <d4p1:Transcription>String</d4p1:Transcription>
          <d4p1:Type>Upload</d4p1:Type>
          <d4p1:Uri>String</d4p1:Uri>
          <d4p1:UserId>String</d4p1:UserId>
          <d4p1:UserName>String</d4p1:UserName>
        </d4p1:FileInfo>
      </d2p1:Attachments>
      <d2p1:Body>String</d2p1:Body>
      <d2p1:CustomerBreadcrumb xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Customers">
        <d4p1:CustomerBreadcrumb>
          <d4p1:Id>String</d4p1:Id>
          <d4p1:Name>String</d4p1:Name>
        </d4p1:CustomerBreadcrumb>
      </d2p1:CustomerBreadcrumb>
      <d2p1:CustomerId>String</d2p1:CustomerId>
      <d2p1:CustomerName>String</d2p1:CustomerName>
      <d2p1:Error>false</d2p1:Error>
      <d2p1:ErrorMessage>String</d2p1:ErrorMessage>
      <d2p1:From>String</d2p1:From>
      <d2p1:Recipients>
        <d2p1:NotificationRecipientInfo>
          <d2p1:Address>String</d2p1:Address>
          <d2p1:Extra>String</d2p1:Extra>
          <d2p1:Name>String</d2p1:Name>
        </d2p1:NotificationRecipientInfo>
      </d2p1:Recipients>
      <d2p1:Subject>String</d2p1:Subject>
      <d2p1:To>String</d2p1:To>
      <d2p1:Type>Email</d2p1:Type>
    </d2p1:NotificationInfo>
  </Notifications>
  <PushNotification xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.App">
    <d2p1:AgentState>Unknown</d2p1:AgentState>
    <d2p1:AgentStateReason>Unknown</d2p1:AgentStateReason>
    <d2p1:AttachmentContentType>String</d2p1:AttachmentContentType>
    <d2p1:AttachmentUri>String</d2p1:AttachmentUri>
    <d2p1:Badge>0</d2p1:Badge>
    <d2p1:Body>String</d2p1:Body>
    <d2p1:Channel>Voice</d2p1:Channel>
    <d2p1:EndpointId>String</d2p1:EndpointId>
    <d2p1:EndpointUserName>String</d2p1:EndpointUserName>
    <d2p1:Sender>String</d2p1:Sender>
    <d2p1:SessionId>String</d2p1:SessionId>
    <d2p1:Title>String</d2p1:Title>
    <d2p1:Type>SessionDisconnected</d2p1:Type>
  </PushNotification>
</NotUsedRequest>