WikiSysop at 13:44, February 22, 2023

2023-02-22T13:44:31Z

Show changes

Jumunn: Published

2022-02-18T13:20:33Z

Published

Julie.munn@genesys.com: Published

2021-10-14T19:56:36Z

Published

Show changes

Julie.munn@genesys.com: Published

2021-03-25T17:53:46Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Outbound namespace
|Context=Learn about the Outbound namespace methods in the Service Client API.
|ComingSoon=No
|Role=Developer
|Section={{Section
|sectionHeading=Methods
|anchor=Methods
|alignment=Vertical
|structuredtext=The Outbound namespace includes the following methods:

*{{Link-SomewhereInThisManual|topic=OutboundNamespace|anchor=getCampaigns|display text=getCampaigns}}
*{{Link-SomewhereInThisManual|topic=OutboundNamespace|anchor=getPreviewRecord|display text=getPreviewRecord}}
*{{Link-SomewhereInThisManual|topic=OutboundNamespace|anchor=callPreviewRecord|display text=callPreviewRecord}}
*{{Link-SomewhereInThisManual|topic=OutboundNamespace|anchor=rejectPreviewRecord|display text=rejectPreviewRecord}}
*{{Link-SomewhereInThisManual|topic=OutboundNamespace|anchor=cancelPreviewRecord|display text=cancelPreviewRecord}}
*{{Link-SomewhereInThisManual|topic=OutboundNamespace|anchor=startDirectPushPreview|display text=startDirectPushPreview}}
*{{Link-SomewhereInThisManual|topic=OutboundNamespace|anchor=stopDirectPushPreview|display text=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.
{{!}}}
{{!}}}
|Status=No
}}
}}

@@ Line 6: / Line 6: @@
 |Role=Developer
 |Section={{Section
 |sectionHeading=Methods
 |anchor=Methods
@@ Line 425: / Line 429: @@
 {{!}}-
 !Description
-{{!}}Set the schedule information on the record based on its time zone.
+{{!}}Set the schedule information on the record based on its time zone. You can perform this operation regardless of how the Workspace Web Edition options [https://docs.genesys.com/Documentation/Options/Current/HTCC/GWS-interaction-workspace#privilege-outbound-can-reschedule privilege.outbound.can-reschedule] and [https://docs.genesys.com/Documentation/Options/Current/HTCC/GWS-interaction-workspace#privilege-outbound-can-reschedule-before-call privilege.outbound.can-reschedule-before-call] are configured.
 {{!}}-
 !Parameters

PEC-Developer/Current/SCAPI/OutboundNamespace - Revision history

WikiSysop at 13:44, February 22, 2023

Jumunn: Published

Julie.munn@genesys.com: Published

Julie.munn@genesys.com: Published