Jump to: navigation, search
(Auto-creation of topic Documentation:HTCC:API:TwitterCreate:8.5.2DRAFT via TOC Documentation:HTCC:APITOC8.5.2DRAFT)
 
Line 1: Line 1:
= TwitterCreate=
+
=Create=
 +
__NOTOC__
 +
This operation is part of the [[Twitter|Twitter API]] section of the [[Welcome|Genesys Web Services REST API]].
 +
==Overview==
 +
Creates a new empty Twitter interaction.
 +
{|
 +
! Request URL
 +
| /api/v2/me/twitter
 +
|-
 +
! HTTP Method
 +
| POST
 +
|-
 +
! Required Features
 +
| api-multimedia
 +
|}
  
 +
==Parameters==
 +
{|
 +
! Parameter
 +
! Value
 +
|-
 +
| operationName
 +
| Create
 +
|-
 +
| queueUri
 +
| The queues URI for Twitter.
 +
|-
 +
| userData
 +
| The key value data to attach. (optional)
 +
|}
 +
 +
==Samples==
 +
===Request===
 +
<source lang="text">
 +
POST /api/v2/me/twitter
 +
{
 +
  “operationName”: “Create”,
 +
  "queueUri": "http://localhost:8080/api/v2/queues/995655ec-81a5-46b0-82d0-3f2c5eca263d"
 +
}
 +
</source>
 +
===HTTP Response===
 +
<source lang="text">
 +
{
 +
"statusCode": 0
 +
}
 +
</source>
 +
===CometD Response===
 +
<source lang="text">
 +
{"messageType": "TwitterStateChangeMessage",
 +
"notificationType": "StatusChange",
 +
"referenceId": 10,
 +
"twitter": {"capabilities": ["Cancel",
 +
                                "Send",
 +
                                "AddComment",
 +
                                "AttachUserData",
 +
                                "UpdateUserData",
 +
                                "DeleteUserData",
 +
                                "SetDisposition",
 +
                                "SetInFocus",
 +
                                "Transfer"],
 +
              "id": "01QQQG2MU214P05G",
 +
              "state": "Composing",
 +
              "twitterType": "Outbound",
 +
              "uri": "http://192.168.83.25:8080/api/v2/twitters/01QQQG2MU214P05G"}}
 +
</source>
 
[[Category:V:HTCC:8.5.2DRAFT]]
 
[[Category:V:HTCC:8.5.2DRAFT]]

Revision as of 14:32, March 5, 2015

Create

This operation is part of the Twitter API section of the Genesys Web Services REST API.

Overview

Creates a new empty Twitter interaction.

Request URL /api/v2/me/twitter
HTTP Method POST
Required Features api-multimedia

Parameters

Parameter Value
operationName Create
queueUri The queues URI for Twitter.
userData The key value data to attach. (optional)

Samples

Request

POST /api/v2/me/twitter
{
  “operationName”: “Create”,
  "queueUri": "http://localhost:8080/api/v2/queues/995655ec-81a5-46b0-82d0-3f2c5eca263d"
}

HTTP Response

{
 "statusCode": 0
}

CometD Response

{"messageType": "TwitterStateChangeMessage",
 "notificationType": "StatusChange",
 "referenceId": 10,
 "twitter": {"capabilities": ["Cancel",
                                "Send",
                                "AddComment",
                                "AttachUserData",
                                "UpdateUserData",
                                "DeleteUserData",
                                "SetDisposition",
                                "SetInFocus",
                                "Transfer"],
              "id": "01QQQG2MU214P05G",
              "state": "Composing",
              "twitterType": "Outbound",
              "uri": "http://192.168.83.25:8080/api/v2/twitters/01QQQG2MU214P05G"}}
Comments or questions about this documentation? Contact us for support!