Do Not Call Record
This operation is part of the Outbound API section of the Web Services API.
Overview
Marks the specified record as DoNotCall.
Request URL | /api/v2/me/outbound-records/<record-handle> |
---|---|
HTTP Method | POST |
Required Features | api-voice-outbound |
Parameters
Parameter | Type | Value | Required |
---|---|---|---|
operationName | String | DoNotCallRecord | 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 which will be used. | No |
chainAttribute | String | The chain attribute (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/13
{
'callingList': 'CallingList1',
'phoneNumber': '3001',
'campaignName': 'Campaign1',
'devicePath': '/devices/f32a46c4-8a48-4067-9965-537fc9788790',
'operationName': 'DoNotCallRecord',
'applicationId': 134,
'chainAttribute': 'AllChain',
'referenceId': '123456789'
}
HTTP Response
{
"statusCode": 0
}
CometD Response
[
{
'data':
{
'record':
{
'devicePath': '/devices/f32a46c4-8a48-4067-9965-537fc9788790',
'callingList': 'CallingList1',
'applicationId': 134,
'recordHandle': 13,
'campaignName': 'Campaign1'
},
'notificationType': 'DoNotCallAcknowledge',
'messageType': 'OutboundRecordMessage',
'referenceId': '123456789'
},
'channel': '/v2/me/outbound'
},
{
'data':
{
'metrics':
{
'eventProcessing':
{
'serverGenerationTimestamp': 1433915450788,
'nodeProcessingTimeNanos': 4352048,
'serverProcessingTimeTotalMs': 5
}
},
'userData':
{
'GSW_CHAIN_ATTR': 'AllChain',
'GSW_APPLICATION_ID': 134,
'GSW_RECORD_HANDLE': 13,
'GSW_USER_EVENT': 'DoNotCallAcknowledge',
'GSW_CALLING_LIST': 'CallingList1',
'GSW_PHONE': '3001',
'GSW_CAMPAIGN_NAME': 'Campaign1'
},
'deviceId': 'f32a46c4-8a48-4067-9965-537fc9788790',
'messageType': 'DeviceUserEventMessage'
},
'channel': '/me/internal'
},
{
'successful': True,
'advice':
{
'interval': 0,
'timeout': 30000,
'reconnect': 'retry'
},
'id': '19',
'channel': '/meta/connect'
}
]
This page was last edited on January 22, 2016, at 19:57.
Comments or questions about this documentation? Contact us for support!