Jump to: navigation, search

Request Campaign Status

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

Overview

Returns the outbound campaign status.

Request URL /api/v2/me/outbound-campaigns
HTTP Method POST
Required Features api-voice-outbound

Parameters

Parameter Value Required
operationName GetCampaignStatus 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
{
  'devicePath': '/devices/5910b027-3e64-4c85-9b9d-87248a21d8a5', 
  'operationName': 'GetCampaignStatus',
  'referenceId': '123456789'
}

HTTP Response

{
    "statusCode": 0
}

CometD Response

{
'messageType': 'OutboundCampaignMessage', 
'notificationType': 'CampaignLoaded', 
'campaign': 
	{'description': '', 
	'groupName': 'Campaign1@AgentGroup1', 
	'state': 'Active', 
	'devicePath': '/devices/5910b027-3e64-4c85-9b9d-87248a21d8a5', 
	'applicationId': 134, 
	'groupDescription': '', 
	'name': 'Campaign1'
	},
}
'referenceId': '123456789'

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on January 22, 2016, at 11:57.