Documentation:HTCC:API:ChatSendNicknameUpdatedNotice:8.5.2DRAFT

SendNicknameUpdatedNotice

This operation is part of the Chat API section of the Web Services API.

Overview

With this request, an agent can notify other chat participants that he changed his chat nickname.

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

Parameters

Parameter	Value
operationName	SendNicknameUpdatedNotice
noticeText	The new nickname of the agent.
text	(Optional) The text to send to the customer.
messageType	(Optional) Defines the message type. Note that this parameter must be provided together with the text parameter.
treatAs	(Optional) Specifies how the message should be treated: Normal or System. Note that this parameter must be provided together with the text parameter.

Sample

Request

POST api/v2/me/chats/0000RaB4Q006001A
{
  "operationName": "SendNicknameUpdatedNotice",
  "noticeText": "NewNickname"
}

Response

{
  "statusCode": 0
}

Notification

{
    "chatPath": "/chats/0000RaB4Q006001A",
    "messages": [
        {
            "index": 5,
            "noticeText": "NewNickname",
            "from": {
                "participantId": "0093564DA4BB0039",
                "type": "Agent",
                "uri": "http://localhost:8090/api/v2/users/4ff5b43c856d4cb2a3d6c20a88740257",
                "visibility": "All",
                "path": "/users/4ff5b43c856d4cb2a3d6c20a88740257",
                "nickname": "NewNickname",
                "id": "0093564DA4BB0039"
            },
            "timestamp": "2017-03-27 12:47:05.000+0300",
            "visibility": "All",
            "type": "NicknameUpdated",
            "timestampSeconds": 1490608025000L
        }
    ],
    "notificationType": "NewMessages",
    "messageType": "MessageLogUpdated",
    "chatUri": "http://localhost:8090/api/v2/chats/0000RaB4Q006001A"
}