Jump to: navigation, search

SetCallCompleted

This operation is part of the UCS Integration with Voice API section of the Web Services API.

Overview

This operation completes the call.

Important
Without this API, call interactions in UCS will remain in the state "In Process". Agent Desktop must send this request.
Request URL /api/v2/ucs/interactions/{interactionId}
HTTP method POST
Required features One of the following:
  • api-voice
  • api-ucs-voice

Parameters

Parameter Value
operationName SetCallCompleted
callDuration The duration of the call.
userData The map of attached data to be saved.

Sample

Request

POST /api/v2/ucs/interactions/{interactionId} 
{
  "operationName": "SetCallCompleted",
  "callDuration": 15,
  "userData": {"key1":"value1","key2":"value2"}
}

HTTP response

{
  "statusCode": 0,
  "referenceId": 123
}

CometD notifications

Success

{
 "referenceId": 123,
 "messageType": "UcsOperationResponse",
 "success": true
}

Error

{
 "referenceId": 123,
 "messageType": "UcsOperationResponse",
 "success": false,
 "errorMessage": "UCS request failed"
}

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on January 27, 2017, at 11:02.