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

AddComment

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

Overview

This sets a comment for the specified SMS session.

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

Parameters

Parameter Value
operationName AddComment
comment A string value to be used for the SMS session comment.

Sample

Request

POST api/v2/me/smssessions/0000Na9B26EF003M 
 
{
 "operationName": "AddComment", 
 "comment": "Some chat comment text"
}

Response

{
  "statusCode": 0
}

Notification

{
    "referenceId": 34,
    "smssession": {
        "participants": [
            {
                "nickname": "TestName",
                "type": "Agent",
                "participantId": "009052C73228006D"
            },
            {
                "nickname": "FirstL",
                "type": "Customer",
                "participantId": "009052C73223006B"
            }
        ],
        "state": "Chatting",
        "id": "0000Na9B26EF003M",
        "capabilities": [
            "Transfer",
            "Complete",
            "Leave",
            "InFocus",
            "SendMessage",
            "SendStartTypingNotification",
            "SendStopTypingNotification"
        ],
        "comment": "Some chat comment text",
        "uri": "http: //localhost:8080/api/v2/smssessions/0000Na9B26EF003M"
    },
    "notificationType": "PropertiesUpdated",
    "messageType": "SMSsessionStateChangeMessage"
}
This page was last edited on November 4, 2016, at 17:53.

Feedback

Comment on this article:

blog comments powered by Disqus