Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CXoneWorkflowRequest

Interface used as a intermediate for creating request json for API call

@example
Array<CXoneCRMWorkflowRequest>

Hierarchy

  • CXoneWorkflowRequest

Index

Properties

Properties

action

action: string
remarks
  • type of Action

Optional cacheKey

cacheKey?: string
remarks
  • cache key

Optional configurationId

configurationId?: string
remarks

-Agent Integration configuration id

Optional contactID

contactID?: string

contactID

Optional customSearch

customSearch?: any
remarks
  • custom Search Payload

Optional cxoneContact

cxoneContact?: CXoneDigitalContactData | CXoneVoiceContactData

cxone contact information of different CRM flows

Optional dataMappingId

dataMappingId?: string
remarks
  • Data Mapping Id

Optional dynamicDataMappingId

dynamicDataMappingId?: string
remarks
  • Dynamic Data Mapping Id

Optional integration

integration?: RelatesToEntity[]
remarks
  • Data Memorialization Workflow Payload - changed to RelatesTo because of extending from CXoneIntegrationEntity

Optional interactionID

interactionID?: string

interactionID

Optional workflowId

workflowId?: string
remarks

-Agent Integration workflow id

Optional workflowInput

workflowInput?: { email?: string; entites?: CXoneIntegrationEntity[]; phoneNumber?: string }

paramter for workflow search

Type declaration

  • Optional email?: string
    remarks
    • Email id
  • Optional entites?: CXoneIntegrationEntity[]

    Array of CRM Entities to search comma separated string

  • Optional phoneNumber?: string
    remarks
    • Phone Number

Generated using TypeDoc