Jump to: navigation, search
(Created target blank page For Version: HTCC:9.0.0)
 
(Update with the copy of version: 9.0.0DRAFT)
 
Line 1: Line 1:
−
<!-- Creation of the target page -->
+
=Outbound namespace=
 +
==Methods==
 +
The Outbound namespace includes the following methods:
 +
 
 +
*[[OutboundNamespace#getCampaigns|getCampaigns]]
 +
*[[OutboundNamespace#getPreviewRecord|getPreviewRecord]]
 +
*[[OutboundNamespace#callPreviewRecord|callPreviewRecord]]
 +
*[[OutboundNamespace#rejectPreviewRecord|rejectPreviewRecord]]
 +
*[[OutboundNamespace#cancelPreviewRecord|cancelPreviewRecord]]
 +
*[[OutboundNamespace#startDirectPushPreview|startDirectPushPreview]]
 +
*[[OutboundNamespace#stopDirectPushPreview|stopDirectPushPreview]]
 +
 
 +
===getCampaigns===
 +
{|
 +
!Signature
 +
|<static> getCampaigns(''succeeded'', ''failed'')
 +
|-
 +
!Description
 +
|Get the details of all outbound campaigns (loaded or active) for the current agent.
 +
|-
 +
!Parameters
 +
|
 +
{|
 +
!Name
 +
!Type
 +
!Description
 +
|-
 +
|succeeded
 +
|string
 +
|The callback function to use if the operation succeeded.
 +
|-
 +
|failed
 +
|string
 +
|The callback function to use if the operation failed.
 +
|}
 +
|}
 +
===getPreviewRecord===
 +
{|
 +
!Signature
 +
|<static> getPreviewRecord(''campaignName'', ''succeeded'', ''failed'')
 +
|-
 +
!Description
 +
|Get a preview record from [https://docs.genesys.com/Documentation/OU Outbound Contact Server].
 +
|-
 +
!Parameters
 +
|
 +
{|
 +
!Name
 +
!Type
 +
!Description
 +
|-
 +
|campaignName
 +
|string
 +
|The name of the outbound campaign.
 +
|-
 +
|succeeded
 +
|string
 +
|The callback function to use if the operation succeeded.
 +
|-
 +
|failed
 +
|string
 +
|The callback function to use if the operation failed.
 +
|}
 +
|}
 +
===callPreviewRecord===
 +
{|
 +
!Signature
 +
|<static> callPreviewRecord(''interactionId'',''succeeded'', ''failed'')
 +
|-
 +
!Description
 +
|Make a call using the preview record.
 +
|-
 +
!Parameters
 +
|
 +
{|
 +
!Name
 +
!Type
 +
!Description
 +
|-
 +
|interactionId
 +
|string
 +
|The unique identifier for the interaction.
 +
|-
 +
|succeeded
 +
|string
 +
|The callback function to use if the operation succeeded.
 +
|-
 +
|failed
 +
|string
 +
|The callback function to use if the operation failed.
 +
|}
 +
|}
 +
===rejectPreviewRecord===
 +
{|
 +
!Signature
 +
|<static> rejectPreviewRecord(''succeeded'', ''failed'')
 +
|-
 +
!Description
 +
|Reject a pull preview, push preview, or direct push preview record.
 +
|-
 +
!Parameters
 +
|
 +
{|
 +
!Name
 +
!Type
 +
!Description
 +
|-
 +
|succeeded
 +
|string
 +
|The callback function to use if the operation succeeded.
 +
|-
 +
|failed
 +
|string
 +
|The callback function to use if the operation failed.
 +
|}
 +
|}
 +
===cancelPreviewRecord===
 +
{|
 +
!Signature
 +
|<static> cancelPreviewRecord(''succeeded'', ''failed'')
 +
|-
 +
!Description
 +
|Cancel a pull preview, push preview, or direct push preview record.
 +
|-
 +
!Parameters
 +
|
 +
{|
 +
!Name
 +
!Type
 +
!Description
 +
|-
 +
|succeeded
 +
|string
 +
|The callback function to use if the operation succeeded.
 +
|-
 +
|failed
 +
|string
 +
|The callback function to use if the operation failed.
 +
|}
 +
|}
 +
===startDirectPushPreview===
 +
{|
 +
!Signature
 +
|<static> startDirectPushPreview(''succeeded'', ''failed'')
 +
|-
 +
!Description
 +
|Send a Dialing Mode Start request to [https://docs.genesys.com/Documentation/OU Outbound Contact Server] to start sending direct push preview records to the agent.
 +
|-
 +
!Parameters
 +
|
 +
{|
 +
!Name
 +
!Type
 +
!Description
 +
|-
 +
|succeeded
 +
|string
 +
|The callback function to use if the operation succeeded.
 +
|-
 +
|failed
 +
|string
 +
|The callback function to use if the operation failed.
 +
|}
 +
|}
 +
===stopDirectPushPreview===
 +
{|
 +
!Signature
 +
|<static> stopDirectPushPreview(''succeeded'', ''failed'')
 +
|-
 +
!Description
 +
|Send a Dialing Mode Stop request to [https://docs.genesys.com/Documentation/OU Outbound Contact Server] to stop sending direct push preview records to the agent.
 +
|-
 +
!Parameters
 +
|
 +
{|
 +
!Name
 +
!Type
 +
!Description
 +
|-
 +
|succeeded
 +
|string
 +
|The callback function to use if the operation succeeded.
 +
|-
 +
|failed
 +
|string
 +
|The callback function to use if the operation failed.
 +
|}
 +
|}
 +
 
 +
[[Category:V:HTCC:9.0.0]]

Latest revision as of 14:18, July 20, 2021

Outbound namespace

Methods

The Outbound namespace includes the following methods:

getCampaigns

Signature <static> getCampaigns(succeeded, failed)
Description Get the details of all outbound campaigns (loaded or active) for the current agent.
Parameters
Name Type Description
succeeded string The callback function to use if the operation succeeded.
failed string The callback function to use if the operation failed.

getPreviewRecord

Signature <static> getPreviewRecord(campaignName, succeeded, failed)
Description Get a preview record from Outbound Contact Server.
Parameters
Name Type Description
campaignName string The name of the outbound campaign.
succeeded string The callback function to use if the operation succeeded.
failed string The callback function to use if the operation failed.

callPreviewRecord

Signature <static> callPreviewRecord(interactionId,succeeded, failed)
Description Make a call using the preview record.
Parameters
Name Type Description
interactionId string The unique identifier for the interaction.
succeeded string The callback function to use if the operation succeeded.
failed string The callback function to use if the operation failed.

rejectPreviewRecord

Signature <static> rejectPreviewRecord(succeeded, failed)
Description Reject a pull preview, push preview, or direct push preview record.
Parameters
Name Type Description
succeeded string The callback function to use if the operation succeeded.
failed string The callback function to use if the operation failed.

cancelPreviewRecord

Signature <static> cancelPreviewRecord(succeeded, failed)
Description Cancel a pull preview, push preview, or direct push preview record.
Parameters
Name Type Description
succeeded string The callback function to use if the operation succeeded.
failed string The callback function to use if the operation failed.

startDirectPushPreview

Signature <static> startDirectPushPreview(succeeded, failed)
Description Send a Dialing Mode Start request to Outbound Contact Server to start sending direct push preview records to the agent.
Parameters
Name Type Description
succeeded string The callback function to use if the operation succeeded.
failed string The callback function to use if the operation failed.

stopDirectPushPreview

Signature <static> stopDirectPushPreview(succeeded, failed)
Description Send a Dialing Mode Stop request to Outbound Contact Server to stop sending direct push preview records to the agent.
Parameters
Name Type Description
succeeded string The callback function to use if the operation succeeded.
failed string The callback function to use if the operation failed.
This page was last edited on July 20, 2021, at 14:18.
Comments or questions about this documentation? Contact us for support!