Expand All Collapse All

/icws/{sessionId}/social-media/twitter/account/{accountId}/channel

POST

/icws/{sessionId}/social-media/twitter/account/{accountId}/channel

Creates Twitter channel.
Feature Version
social-media 5

Request

Parameters
Type
Name
Comments
Header
ININ-ICWS-CSRF-Token

Required

The ININ session token necessary for all calls that require a security or user context.

    Header
    Cookie

    Required

    The session cookie. With the exception of the connection request, all requests must provide a session cookie.

      Template
      sessionId

      Required

      The ININ session ID necessary for all calls that require a security or user context.

        Template
        accountId

        Required

        The Facebook/Twitter/WhatsApp account identifier.

          Representations
          twitterChannelRequest
          Expand AllCollapse All
          Property
          Value
          Comments
          name
          String

          Required

          The Twitter account name.
          keywords
          List [Unbounded]: String

          Required

          List of Twitter keywords for which conversations and direct messages will be routed.
          handles
          List [Unbounded]: String

          Required

          List of Twitter handles for which conversations and direct messages will be routed.
          socialConversationWorkgroup
          String

          Required

          The workgroup to direct Social Media conversations to.
          socialDirectMessageWorkgroup
          String
          The workgroup to direct Social Media direct messages to.
          Feature Version
          social-media 5
          botConfiguration
          Boolean
          Flag to indicate whether chatbot is enabled for this channel.
          Feature Version
          social-media 6
          botHandle
          String
          The bot handle to direct Social Media direct messages to.
          Feature Version
          social-media 6

          Response

          201 - Created
          The Twitter channel was successfully created. Returns information about the Twitter channel.
          twitterChannelResponse
          Expand AllCollapse All
          Property
          Value
          Comments
          accountId
          String

          Required

          The Twitter account name.
          channelId
          String

          Required

          The Twitter channel identifier.
          name
          String

          Required

          The Twitter account name.
          keywords
          List [Unbounded]: String

          Required

          List of Twitter keywords for which conversations and direct messages will be routed.
          handles
          List [Unbounded]: String

          Required

          List of Twitter handles for which conversations and direct messages will be routed.
          socialConversationWorkgroup
          String

          Required

          The workgroup to direct Social Media conversations to.
          socialDirectMessageWorkgroup
          String
          The workgroup to direct Social Media direct messages to.
          Feature Version
          social-media 5
          botConfiguration
          Boolean
          Flag to indicate whether chatbot is enabled for this channel.
          Feature Version
          social-media 6
          botHandle
          String
          The bot handle to direct Social Media direct messages to.
          Feature Version
          social-media 6
          403 - Forbidden
          You do not have rights to the Social Media configuration on this IC server.
          error
          Provides additional detail for an error.
          Expand AllCollapse All
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.
          400 - Bad Request
          The request was invalid. This can occur when the message body is malformed or missing required items. This will also occur if a required header or query string parameter is missing or invalid.
          error
          Provides additional detail for an error.
          Expand AllCollapse All
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.
          401 - Unauthorized
          The specified session token is missing, invalid, or has expired.
          Parameters
          Type
          Name
          Comments
          Header
          WWW-Authenticate

          Required

          Indicates that the client needs to authenticate using a custom ICWS scheme, which supports a realm of type ICWS and a location which is the URL at which the client can authenticate. A typical example would be the following.

          WWW-Authenticate: ICWS realm="ICWS" location="/ICWS/connection"

            error
            Provides additional detail for an error.
            Expand AllCollapse All
            Property
            Value
            Comments
            errorId
            String
            The error identifier that describes the current error.
            message
            String

            Required

            A message that describes the current error.
            410 - Gone
            This resource has been deprecated and removed from the API.
            error
            Provides additional detail for an error.
            Expand AllCollapse All
            Property
            Value
            Comments
            errorId
            String
            The error identifier that describes the current error.
            message
            String

            Required

            A message that describes the current error.
            500 - Internal Server Error
            An unexpected error occurred while processing the request.
            error
            Provides additional detail for an error.
            Expand AllCollapse All
            Property
            Value
            Comments
            errorId
            String
            The error identifier that describes the current error.
            message
            String

            Required

            A message that describes the current error.