Jump to: navigation, search
(Auto-creation of topic Documentation:HTCC:API:ChatSendURL:8.5.2DRAFT via TOC Documentation:HTCC:APITOC8.5.2DRAFT)
 
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
= ChatSendURL=
+
=SendURL=
 +
__NOTOC__
 +
 
 +
This operation is part of the [[Chat|Chat API]] section of the [[Welcome|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
 +
|-
 +
 
 +
|}
 +
 
 +
 
 +
==Sample==
 +
 
 +
===HTTP Request===
 +
 
 +
<pre>
 +
POST api/v2/me/chats/0001Ea9Q8UVY000T
 +
{
 +
  "operationName": "SendUrl",
 +
  "url": "http://www.genesys.com"
 +
}
 +
</pre>
 +
 
 +
===HTTP Response===
 +
<pre>
 +
{
 +
  "statusCode": 0
 +
}
 +
</pre>
 +
 
 +
 
 +
===Notification===
 +
Notification with URL
 +
<pre>
 +
{
 +
    "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"
 +
}
 +
</pre>
 +
 
  
 
[[Category:V:HTCC:8.5.2DRAFT]]
 
[[Category:V:HTCC:8.5.2DRAFT]]

Latest revision as of 11:35, June 15, 2017

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


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"
}
This page was last edited on June 15, 2017, at 11:35.
Comments or questions about this documentation? Contact us for support!