HTTPS Notifications

HTTPS method:

POST

Fields:

• author: author of the social contact.
• description: body of the social contact.
• id: datastore id of the social contact.
• link: unique id of the original social contact.
• notificationTag: the tag that fired off the notification rule.
• publishedDate: the publish date of the document.
• refURL: the REST id of the social contact. Applications can do a GET on this URL to get social contact detail.
• screenPopUrl: URL used to access the social contact in the Customer Collaboration Platform's UI.

• sourceType: the type of feed to which the social contact belongs. Valid values are

  • chat

  • push

  • callback

  • email

• status: string (case-sensitive) One of:
  • unread: The default state of a new social contact.
  • reserved: Reserved to be handled.
  • handled: This social contact has been handled and no further action is required.
  • discarded: This social contact does not require a response and is filed in the recycle bin.
  • queued: The callback request was successfully submitted to the contact center for routing.
• statusTimestamp: timestamp of the last status update.
• statusUserId: id of the agent who updated the status (initially this is empty).

• statusReason: the reason the contact was moved to the current status.

• tags/tag: one or more tags associated with the social contact—normally this is optional but for CCX integration this should contain the routing tag.
• extensionFields/extensionField: a collection of custom name and value pairs. The person submitting the social contact may specify up to 100 pairs and the entire collection can contain up to one megabyte of information.
• title: title of the social contact.
• replyTemplateRefURL: link to the reply template configuration. Present if reply template is configured for the contact.
• replyTemplateURL: link to the reply template. Present if reply template is configured for the contact.
• replyType: expected reply format (currently web, chat, or email). The URI below will be in a format compatible with the reply type.
• URI: for chat room.

Example https notification message:

<SocialContact>
    <author>Michael Littlefoot</author>
    <description>Web Chat</description>
    <extensionFields>
        <extensionField>
            <name>h_Name</name>
            <value>Michael Littlefoot</value>
        </extensionField>
        <extensionField>
            <name>h_chatOrigin</name>
            <value>FACEBOOK_MESSENGER</value>
        </extensionField>
        <extensionField>
            <name>h_chatRoom</name>
            <value>socialminer_chat.0@conference.127.0.0.1</value>
        </extensionField>
    </extensionFields>
    <id>7ED5E7C510000164000000000A4E5F26</id>
    <integrationAuthTokenExpirationTimestamp>1531157905093
    </integrationAuthTokenExpirationTimestamp>
    <integrationAuthTokenGUID>XXXXXXXXX</integrationAuthTokenGUID>
    <link>https://[Server]:[Port]/ccp/socialcontact/
     7ED5E7C510000164000000000A4E5F26 /link>
    <notificationTag>ccx_chat_req</notificationTag>
    <publishedDate>1531136305092</publishedDate>
    <refURL>https://[Server]:[Port]/ccp-webapp/ccp/socialcontact/
     7ED5E7C510000164000000000A4E5F26</refURL>
    <replyTemplateURL>https://[Server]:[Port]/multisession/ui/
    templates/reply/cisco_agent_ms_chat.jsp</replyTemplateURL>
    <screenPopUrl>https://[Server]:[Port]/results.jsp?scID= 
    \7ED5E7C510000164000000000A4E5F26&amp;campaignID=
    CCX_Chat_Campaign</screenPopUrl>
    <sourceType>chat</sourceType>
    <status>unread</status>
    <statusReason>unknown</statusReason>
    <statusTimestamp>1531136305095</statusTimestamp>
    <statusUserId></statusUserId>
    <tags>
        <tag>ccx_chat_req</tag>
    </tags>
    <title>Chat from Facebook Messenger</title>
</SocialContact>

HTTPS response headers:

A 200 OK http header is returned on success.