Jump to: navigation, search
(Created Fix blank page For Version: HTCC:8.5.2)
 
(Update with the copy of version: 8.5.2DRAFT)
Line 1: Line 1:
−
<!-- Creation of the fix page -->
+
= SendUrl=
 +
__NOTOC__
 +
This operation is part of the [[FacebookPM|Facebook Private Messaging API]] section of the [[Welcome|Genesys Web Services REST API]].
 +
 
 +
<h2> Overview </h2>
 +
This request sends a URL to all Facebook session participants.
 +
{| class="wikitable"
 +
|-
 +
! scope="row"| Request URL
 +
| /api/v2/me/facebooksession/''{id}''
 +
|-
 +
! scope="row"| HTTP Method
 +
| POST
 +
|-
 +
! scope="row" | Required Features
 +
| api-multimedia
 +
|}
 +
<h2>Parameters</h2>
 +
 
 +
{|
 +
|-
 +
! Parameter
 +
! Value
 +
|-
 +
|operationName
 +
|SendUrl
 +
|-
 +
|url
 +
|The URL to send to the customer.
 +
|}
 +
 
 +
<h2>Sample</h2>
 +
 
 +
<h3>Request</h3>
 +
 
 +
<source lang="text">
 +
POST api/v2/me/facebooksession/0001Ea9Q8UVY000T
 +
{
 +
  "operationName": "SendUrl",
 +
  "url": "http://www.genesys.com"
 +
}
 +
</source>
 +
 
 +
<h3>Response</h3>
 +
 
 +
<source lang="text">
 +
{
 +
  "statusCode": 0
 +
}
 +
</source>
 +
 
 +
<h3>Notification</h3>
 +
 
 +
 
 +
<source lang="text">
 +
{
 +
    "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/facebooksession/0001Ea9Q8UVY000T"
 +
}
 +
</source>
 +
 
 +
 
 +
[[Category:V:HTCC:8.5.2]]

Revision as of 19:44, October 23, 2015

SendUrl

This operation is part of the Facebook Private Messaging API section of the Genesys Web Services REST API.

Overview

This request sends a URL to all Facebook session participants.

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

Parameters

Parameter Value
operationName SendUrl
url The URL to send to the customer.

Sample

Request

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

Response

{
  "statusCode": 0
}

Notification


{
    "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/facebooksession/0001Ea9Q8UVY000T"
}
Comments or questions about this documentation? Contact us for support!