Documentation:HTCC:API:ChatSendURL:8.5.2DRAFT

SendURL

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

Overview

This operation will send a URL to all chat participants.

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

Parameters

Parameter	Value
operationName	SendUrl
url	URL to send to customer
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

HTTP Request

POST api/v2/me/chats/0001Ea9Q8UVY000T
{
  "operationName": "SendUrl",
  "url": "http://www.genesys.com"
}

HTTP Response

{
  "statusCode": 0
}

Notification

Notification with URL

{
    "messages": [
        {
            "index": 3,
            "from": {
                "nickname": "TestName",
                "type": "Agent",
                "uri": "http://10.10.15.212:9090/api/v2/users/90cc5439ff6848748e5e67811273f266",
                "visibility": "All",
                "participantId": "00AF537487AF0004"
            },
            "url": "http://google.com",
            "timestamp": "2014-05-1502:24:00.000-0700",
            "visibility": "All",
            "type": "PushUrl",
            "timestampSeconds": 1400145840000L
        }
    ],
    "notificationType": "NewMessages",
    "messageType": "MessageLogUpdated",
    "chatUri": "http://10.10.15.212:9090/api/v2/chats/0001Ea9Q8UVY000T"
}