Documentation:HTCC:Dev:OutboundNamespace:9.0.0DRAFT

Outbound namespace

Methods

The Outbound namespace includes the following methods:

• getCampaigns
• getPreviewRecord
• callPreviewRecord
• rejectPreviewRecord
• cancelPreviewRecord
• startDirectPushPreview
• 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 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.