Maintenance Notice - PDF Generation
Dynamic PDF generation for web-based content is temporarily unavailable. This maintenance affects dynamic PDF files that are generated from either the HTML-based page or manual that you are viewing. Links that normally allow this functionality have been hidden, and will reappear as soon as the feature is restored.

Note: Access to static files, including PDF files that are not dynamically generated from our web-based content, is unaffected.

Jump to: navigation, search


This operation is part of the SMS Session API section of the Web Services API.


Use this operation to cancel a Consult request. If the agent has already accepted the invitation, Web Services can't cancel the consultation.

Request URL /api/v2/me/smssessions/{id}
Required Features api-multimedia


Parameter Value
operationName CancelConsult



POST api/v2/smssessions/0000Na9B26EF006E
  "operationName": "CancelConsult"

HTTP response

  "statusCode": 0,
  "referenceId": 5


If a request is successful, Web Services doesn't publish a CometD notification. See below for examples of how Web Services handles errors:

Cancel interaction error

    u'notificationType': u'Error',
    u'errorMessage': u'Request failed',
    u'referenceId': 35

User data update error

    u'notificationType': u'Error',
    u'errorMessage': u'Unable to manage user data for interaction id',
    u'referenceId': 35
This page was last edited on November 4, 2016, at 17:53.


Comment on this article:

blog comments powered by Disqus