Jump to: navigation, search
(Auto-creation of topic Documentation:HTCC:API:TwitterCreate:8.5.2 via TOC Documentation:HTCC:APITOC8.5.2)
 
(Update with the copy of version: 8.5.2DRAFT)
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
= TwitterCreate=
+
=Create=
 +
__NOTOC__
 +
This operation is part of the [[Twitter|Twitter API]] section of the [[Welcome|Web Services API]].
 +
==Overview==
 +
Creates a new empty Twitter interaction.
 +
{|
 +
! Request URL
 +
| /api/v2/me/tweets
 +
|-
 +
! HTTP Method
 +
| POST
 +
|-
 +
! Required Features
 +
| api-multimedia
 +
|}
 +
 
 +
==Parameters==
 +
{|
 +
! Parameter
 +
! Value
 +
|-
 +
| operationName
 +
| Create
 +
|-
 +
| queuePath
 +
|  The URI of the queue where Web Services should place this Twitter interaction.
 +
|-
 +
| userData
 +
| The key value data to attach. (optional)
 +
|}
 +
 
 +
==Samples==
 +
===Request===
 +
<source lang="text">
 +
POST /api/v2/me/tweets
 +
{
 +
  "operationName": "Create",
 +
  "queuePath": "/queues/995655ec-81a5-46b0-82d0-3f2c5eca263d"
 +
}
 +
</source>
 +
 
 +
===HTTP Response===
 +
<source lang="text">
 +
{
 +
  "statusCode": 0,
 +
  "referenceId":10,
 +
}
 +
</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/tweet/01QQQG2MU214P05G"
 +
  }
 +
}
 +
</source>
 +
 
 +
{|
 +
! '''Field'''
 +
! '''Description'''
 +
|-
 +
| messageType
 +
| The category of message.
 +
|-
 +
| notificationType
 +
| The purpose of the notification.
 +
|-
 +
| twitter
 +
| The element containing all Twitter-specific data.
 +
|}
  
 
[[Category:V:HTCC:8.5.2]]
 
[[Category:V:HTCC:8.5.2]]

Latest revision as of 09:32, June 24, 2020

Create

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

Overview

Creates a new empty Twitter interaction.

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

Parameters

Parameter Value
operationName Create
queuePath The URI of the queue where Web Services should place this Twitter interaction.
userData The key value data to attach. (optional)

Samples

Request

POST /api/v2/me/tweets
{
  "operationName": "Create",
  "queuePath": "/queues/995655ec-81a5-46b0-82d0-3f2c5eca263d"
}

HTTP Response

{
  "statusCode": 0, 
   "referenceId":10,
}

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/tweet/01QQQG2MU214P05G"
   }
}
Field Description
messageType The category of message.
notificationType The purpose of the notification.
twitter The element containing all Twitter-specific data.
This page was last edited on June 24, 2020, at 09:32.
Comments or questions about this documentation? Contact us for support!