Jump to: navigation, search

Cancel Record with Phone Number

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

Overview

Cancels the specified outbound record.

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

Parameters

Parameter Type Value Required
operationName String CancelRecord Yes
applicationId Integer The unique identifier of the OCS application. Yes
campaignName String The name of the outbound campaign used for this operation. Yes
callingList String The name of the outbound calling list used for this operation. Yes
phoneNumber String The phone number of the record that is being cancelled. Yes
chainAttribute String The chain attribute, which can be AllChain or RecordOnly. No
devicePath String The relative path to device used for sending the TLib request. Yes
referenceId String 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-records
{
        'callingList': 'CallingList1',
	'phoneNumber':'4100180988',
        'campaignName': 'Campaign1',
	'devicePath': '/devices/57fc644b-c3b8-4ce8-ad82-d7e15c5f0b33',
	'operationName': 'CancelRecord',
	'applicationId': 134,
	'chainAttribute': 'AllChain',
        'referenceId': '123456789'
}

HTTP Response

{
    "statusCode": 0
}

CometD Response

[
	{
		'data': 
		{
			'record': 
			{
				'devicePath': '/devices/57fc644b-c3b8-4ce8-ad82-d7e15c5f0b33',
                                'callingList': 'CallingList1',
				'applicationId': 134,
				'campaignName': 'Campaign1'
			},
			'notificationType': 'RecordCancelAcknowledge',
			'messageType': 'OutboundRecordMessage',
                        'referenceId': '123456789'
		},
		'channel': '/v2/me/outbound'
	},
	{
		'data':
		{
			'metrics': 
			{
				'eventProcessing': 
				{
					'serverGenerationTimestamp': 1433915407652,
					'nodeProcessingTimeNanos': 3679212,
					'serverProcessingTimeTotalMs': 4
				}
			},
			'userData': 
			{
				'GSW_CHAIN_ATTR': 'AllChain',
				'GSW_APPLICATION_ID': 134,
				'GSW_RECORD_HANDLE': 11,
				'GSW_USER_EVENT': 'RecordCancelAcknowledge',
				'GSW_CALLING_LIST': 'CallingList1',
				'GSW_PHONE': '4100180988',
				'GSW_CAMPAIGN_NAME': 'Campaign1'
			},
			'deviceId': '57fc644b-c3b8-4ce8-ad82-d7e15c5f0b33',
			'messageType': 'DeviceUserEventMessage'
		},
		'channel': '/me/internal'
	},
	{
		'successful': True,
		'advice': 
		{
			'interval': 0, 
			'timeout': 30000, 
			'reconnect': 'retry'
		}, 
		'id': '20', 
		'channel': '/meta/connect'
	}
]

Feedback

Comment on this article:

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