Jump to: navigation, search

Complete

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

Overview

This request marks an SMS session interaction as complete and ends the SMS session for the customer if it hasn't been ended already. If queueName is specified, the SMS session interaction will be placed in the specified queue.

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

Parameters

Parameter Value
operationName Complete
queueName The name of the queue where Web Services should place this SMS session interaction. (optional)
saveLAR Possible values are true or false. If true, information about the agent performing the operation is set in the Contact Profile so that it can be used for last agent routing. (optional)

Sample

Request

POST api/v2/me/smssessions/0071023821aec011
{
  "operationName": "Complete"
}

or

POST api/v2/me/smssessions/0071023821aec011
{
  "operationName": "Complete",
  "queueName": "PostProcessingQueue"
}

Response

{
  "statusCode": 0
}

Notification

{
    "messageType": "SMSsessionStateChangeMessage",
    "notificationType": "StatusChange",
    "smssession": {
        "state": "Completed",
        "id": "0000Na9B26EF002X",
        "uri": "http://localhost:8080/api/v2/smssessions/0000Na9B26EF002X",
}    }
}

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on November 4, 2016, at 09:54.