End Preview Session

This operation is part of the Outbound API section of the Web Services API.

Overview

This request ends a preview mode outbound session for the current user and specified campaign.

Request URL	/api/v2/me/outbound-campaigns/<campaign-name>
HTTP Method	POST
Required Features	api-voice-outbound

Parameters

Parameter	Value	Required
operationName	EndPreviewSession	Yes
applicationId	The unique identifier of the Outbound Contact Server application.	Yes
devicePath	The relative path to the device used for sending the TLib request.	Yes
referenceId	A unique identifier used to map the API call to the CometD response. If the request contains a referenceId, Web Services sends an acknowledgement or other event with the same reference ID via CometD.	No

Samples

Request

POST /api/v2/me/outbound-campaigns/<campaign-name>
{
   'operationName': 'EndPreviewSession',
   'applicationId': 124,
   'devicePath': '/devices/1234567890',
   'referenceId': '123456789'
}

HTTP Response

{
    'statusCode': 0
}

CometD Response

{
'messageType': 'OutboundCampaignMessage', 
'notificationType': 'PreviewSessionEnded', 
'campaign': 
	{'devicePath': '/devices/5910b027-3e64-4c85-9b9d-87248a21d8a5', 
	 'state': 'Started', 
	 'applicationId': 134, 
	 'name': 'Campaign1'
	 },
'referenceId': '123456789'
}