GET

Gets status and detail for the specified social contact.

The <objectId> attribute required for this command is found in campaign results, in the feed/entry/link rel="socialcontact" element. For example: <link rel="socialcontact" href="https://<ServerIP>:<Port>/ccp-webapp/ccp/socialcontact/22E00F5310000129460A1EB40A568DDE" />

URL:

https://<ServerIP>:<Port>/ccp-webapp/ccp/socialcontact/<objectId>

HTTPS method:

GET

Example responses:

Results are returned as XML.

<SocialContact>
    <author>Michael Littlefoot</author>
    <createdDate>1531136305099</createdDate>
    <description>some description</description>
    <draftAction>draft_action_reply</draftAction>
    <draftResponse/>
    <extensionFields>
        <extensionField>
            <name>h_chatRoom</name>
            <value>socialminer_chat.0@conference.127.0.0.1</value>
        </extensionField>
        <extensionField>
            <name>h_Name</name>
            <value>Michael Littlefoot</value>
        </extensionField>
    </extensionFields>
    <id>7ED5E7C510000164000000000A4E5F26</id>
    <inviteStatus>none</inviteStatus>
    <isInvited>false</isInvited>
    <isSoftLocked>false</isSoftLocked>
    <link>
        https://[Server]:[Port]/ccp-webapp/ccp/socialcontact
       /7ED5E7C510000164000000000A4E5F26
    </link>
    <publishedDate>1531136305092</publishedDate>
    <refURL>
        https://[Server]:[Port]/ccp-webapp/ccp/socialcontact
       /7ED5E7C510000164000000000A4E5F26
    </refURL>
    <replyTemplateRefURL>
        https://[Server]:[Port]/ccp-webapp/ccp/template/reply/303
    </replyTemplateRefURL>
    <replyTemplateURL>
        https://[Server]:[Port]/multisession/ui/templates/reply/cisco_agent_ms_chat.jsp
    </replyTemplateURL>
    <replyToId/>
    <shortUrlIds/>
    <sourceType>chat</sourceType>
    <status>unread</status>
    <statusReason>unknown</statusReason>
    <statusTimestamp>1531136306619</statusTimestamp>
    <statusUserId>admin</statusUserId>
    <tags>
        <tag>tag1</tag>
        <tag>tag2</tag>
    </tags>
    <title>Chat from Website</title>
    <transcriptRefURL>
        https://[Server]:[Port]/ccp-webapp/ccp/socialcontact/
        7ED5E7C510000164000000000A4E5F26/transcript
    </transcriptRefURL>
</SocialContact>

Note

If statusUserId is blank and the status is unread, then this social contact has never had a status change.

If the social contact is associated with a feed that supports reply templates, then the replyTemplateRefURL and replyTemplateURL fields are included. These fields cannot be changed by the social contact API.

You can set the QUEUED status from the API. However, currently it is only set internally by Customer Collaboration Platform. Customer Collaboration Platform sets the social contact status to QUEUED when a social contact is to be or has been routed to some external entity.