Clarabridge Developers | Qualtrics Social Connect

`GET https://api.engagor.com/{account_id}/publisher/add`

Description

Returns a list of services, and associated configuration options, for publishing new messages on your social profiles.

Note: The action_links property of a mention contains a "link" (type "api" with eg. key "reply") that has the parameters for this API call prefilled.

Note 2: We cannot expose real publishing functionality in our API per third-party terms of service agreements (eg. Twitter Api Rules), so only creating drafts, or queueing messages for approval is exposed to non-Engagor applications.

Required Access Token Scope

accounts_read

GET Parameters

Param	Description	Required	Default Value
`type`	The type of action you want to do. To publish a new tweet or message use 'post', other options include 'reply' (eg. Twitter replies), 'privatemessage', 'comment' (eg. Facebook comments), 'like', 'favorite', 'retweet', 'reblog', 'submit' (Tumblr).	No	"post"
`topic_id`	The topic's id of the mention you want to reply to.	No
`mention_id`	The id of the mention you want to reply to.	No

Result

Object with:

a list of possible services to post to (including details about the rights for that profile, the displayname and avatar of the profile, and whether or not certain features like photo uploading are available or not),
some configuration options regarding the message's length, cursor position, default text
and, if applicable, details of the mention you're reply to.

(See examples below.)

Examples

List profiles to publish a new post with

This API call returns a list of profiles (and their configuration), with which you can publish, created drafts, etc. (The list of profiles returned is trimmed to 1 for brevity.)

Parameters	Value plain-text formatted
`type`	post "post"

Example Response plain-text formatted
{"meta":{"code":200},"response":{"services":{"count":21,"data":[{"id":"18715","type":"facebook","service_id":"395919933833585","managed":true,"displayname":"Ken test","url":"http:\\\/\\\/facebook.com\\\/395919933833585","avatar":"https:\\\/\\\/graph.facebook.com\\\/395919933833585\\\/picture","provider":"SearchProviderFacebook","rights":{"publish":false,"draft":true,"sendapproval":true},"configuration":{"default_selected":true,"message":{"max_length":5000,"placeholder":"What's going on, Ken test?","short_url_length":null,"short_url_length_https":null},"features":{"uploads":{"enabled":true,"characters_reserved_per_media":null,"max_media_per_upload":1},"targeting":{"enabled":true},"attachments":{"enabled":true}}}},[]]},"configuration":{"message":{"editable":true,"default":" ^JP","cursor_position":[0,0]},"submit_label":"Publish"},"mention":null}} array(2) "meta" => array(1) "code" => (int) 200 "response" => array(3) "services" => array(2) "count" => (int) 21 "data" => array(2) 0 => array(10) "id" => "18715" "type" => "facebook" "service_id" => "395919933833585" "managed" => true "displayname" => "Ken test" "url" => "http:\/\/facebook.com\/395919933833585" "avatar" => "https:\/\/graph.facebook.com\/395919933833585\/picture" "provider" => "SearchProviderFacebook" "rights" => array(3) "publish" => false "draft" => true "sendapproval" => true "configuration" => array(3) "default_selected" => true "message" => array(4) "max_length" => (int) 5000 "placeholder" => "What's going on, Ken test?" "short_url_length" => null "short_url_length_https" => null "features" => array(3) "uploads" => array(3) "enabled" => true "characters_reserved_per_media" => null "max_media_per_upload" => (int) 1 "targeting" => array(1) "enabled" => true "attachments" => array(1) "enabled" => true 1 => array(empty) "configuration" => array(2) "message" => array(3) "editable" => true "default" => " ^JP" "cursor_position" => array(2) 0 => (int) 0 1 => (int) 0 "submit_label" => "Publish" "mention" => null

List services to reply to a mention with

`POST https://api.engagor.com/{account_id}/publisher/add`

Description

Publishes a new message to one or more social profiles (or creates drafts and sends messages for approval).

Note: The action_links property of a mention contains a "link" (type "api" with eg. key "reply") that has the parameters for this API call prefilled.

Note 2: Directly publishing a reply is possible for private messages only but requires your API application to be allow-listed for this. Please reach out to your CSM with a detailed use case to obtain this functionality.

Note 3: For public publishing & public replies only creating drafts or sending messages for approval is allowed via this endpoint. We cannot expose real publishing functionality in our API per third-party terms of service agreements (eg. Twitter Api Rules), so only creating drafts, or queueing messages for approval is exposed.

Required Access Token Scope

accounts_write

POST Parameters

Param	Description	Required
`type`	The type of action you want to do. To publish a new tweet or message use 'post', other options include 'reply' (eg. Twitter replies), 'privatemessage', 'comment' (eg. Facebook comments), 'like', 'favorite', 'retweet', 'reblog', 'submit' (Tumblr).	Yes
`services`	A JSON encoded array of items with properties 'type' and 'service_id'. One or more services you want to publish to (any of the services retrieved by GET /:account_id/publisher/add). Eg. '[{"type":"facebook","service_id":"999999999999"}]'	Yes
`to`	For emails only: A JSON encoded array of items with property 'id'. Eg. '[{"id":"[email protected]"},{"id":"[email protected]"}]'	No
`subject`	For emails only: The text of the subject to post.	No
`message`	The text of the message to post. Typically required, unless a canned_response_id is provided (then we'll take the default message defined in the canned response if none provided), or when media is attached.	No
`status`	The status the message will be in (possible values are 'draft', 'awaitingapproval' or empty '' for direct publishing).	No
`date_publish`	ISO 8601 formatted date to publish the item. (Leave empty for 'now'.)	No
`topic_id`	Topic id of the mention you're replying to, retweeting...	No
`mention_id`	Id of the mention you're replying to, retweeting...	No
`media`	A JSON encoded array of the ids returned from the media/add endpoint.	No
`canned_response_id`	Id of a canned response (The id is required for canned responses of the type CSAT, NPS® or Buttons). If the id is given, the number of usages will increase. If you use a canned response, the message of the response should be given in the message field and images should be added to the media field.	No

Result

An object contain both an array of message items and the publisher_mention item that was just created.

Examples

Creating a draft for a Facebook post

This API call will add a draft for a Facebook post on page with ID '265529716851684' with the message 'Creating a draft!'

Parameters	Value plain-text formatted
`type`	post "post"
`services`	[{"type":"facebook","service_id":"265529716851684"}] array(1) 0 => array(2) "type" => "facebook" "service_id" => "265529716851684"
`message`	Creating a draft! "Creating a draft!"
`status`	draft "draft"

Example Response plain-text formatted
{"meta":{"code":200},"response":{"messages":[{"level":"success","description":"Your draft has been saved."}],"publisher_mention":{"id":"123456789","author":{"id":"123","name":"Folke Lemaitre","company":"Qualtrics Social Connect","email":"folke@clarabridge.com","avatar":"https:\/\/www.gravatar.com\/avatar\/625cddf4091f04909026d38ece469541?s=60&d=mm"},"message":{"title":"","content":"Creating a draft!","type":"post","attachments":[],"permalink":"https:\/\/app.engagor.com\/inbox\/28\/publish\/?action=edit&id=1192911&status=draft","status":"draft"},"tags":[],"date":1401287550,"published":false,"action_links":[{"key":"publish","type":"web","link":"https:\/\/app.engagor.com\/inbox\/28\/publish\/?action=edit&id=1192911"}],"services":{"type":"facebook","service_id":"265529716851684","diplay_name":"Facebook page name","avatar":"https:\/\/graph.facebook.com\/999999999999\/picture"}}}} array(2) "meta" => array(1) "code" => (int) 200 "response" => array(2) "messages" => array(1) 0 => array(2) "level" => "success" "description" => "Your draft has been saved." "publisher_mention" => array(8) "id" => "123456789" "author" => array(5) "id" => "123" "name" => "Folke Lemaitre" "company" => "Qualtrics Social Connect" "email" => "[email protected]" "avatar" => "https://www.gravatar.com/avatar/625cddf4091f04909026d38ece469541?s=60&d=mm" "message" => array(6) "title" => "" "content" => "Creating a draft!" "type" => "post" "attachments" => array(empty) "permalink" => "https://app.engagor.com/inbox/28/publish/?action=edit&id=1192911&status=draft" "status" => "draft" "tags" => array(empty) "date" => (int) 1401287550 "published" => false "action_links" => array(1) 0 => array(3) "key" => "publish" "type" => "web" "link" => "https://app.engagor.com/inbox/28/publish/?action=edit&id=1192911" "services" => array(4) "type" => "facebook" "service_id" => "265529716851684" "diplay_name" => "Facebook page name" "avatar" => "https://graph.facebook.com/999999999999/picture"

Sending a Twitter reply for approval

This API call will send a reply by Twitter profile '265529716851684' on mention in topic 2109 with id 3891110078048108718 for approval.

Parameters	Value plain-text formatted
`type`	reply "reply"
`services`	[{"type":"twitter","service_id":"372818847"}] array(1) 0 => array(2) "type" => "twitter" "service_id" => "372818847"
`message`	Replying and sending for approval! "Replying and sending for approval!"
`status`	awaitingapproval "awaitingapproval"
`topic_id`	2109 "2109"
`mention_id`	3891110078048108718 "3891110078048108718"

Example Response plain-text formatted
{"meta":{"code":200},"response":{"messages":[{"level":"success","description":"Your message is sent for approval."}],"publisher_mention":{"id":"123456789","author":{"id":"123","name":"Folke Lemaitre","company":"Qualtrics Social Connect","email":"folke@clarabridge.com","avatar":"https:\/\/www.gravatar.com\/avatar\/625cddf4091f04909026d38ece469541?s=60&d=mm","account_role":"admin"},"message":{"title":"","content":"Replying and sending for approval!","type":"reply","attachments":[],"permalink":"https:\/\/app.engagor.com\/inbox\/28\/publish\/?action=edit&id=1192911&status=awaitingapproval","status":"draft"},"tags":[],"date":{"added":1401287550,"published":0},"action_links":[],"services":{"type":"twitter","service_id":"372818847","diplay_name":"EngagorTest2","avatar":"http:\/\/a1.twimg.com\/sticky\/default_profile_images\/default_profile_2_normal.png"}}}} array(2) "meta" => array(1) "code" => (int) 200 "response" => array(2) "messages" => array(1) 0 => array(2) "level" => "success" "description" => "Your message is sent for approval." "publisher_mention" => array(7) "id" => "123456789" "author" => array(6) "id" => "123" "name" => "Folke Lemaitre" "company" => "Qualtrics Social Connect" "email" => "[email protected]" "avatar" => "https://www.gravatar.com/avatar/625cddf4091f04909026d38ece469541?s=60&d=mm" "account_role" => "admin" "message" => array(6) "title" => "" "content" => "Replying and sending for approval!" "type" => "reply" "attachments" => array(empty) "permalink" => "https://app.engagor.com/inbox/28/publish/?action=edit&id=1192911&status=awaitingapproval" "status" => "draft" "tags" => array(empty) "date" => array(2) "added" => (int) 1401287550 "published" => (int) 0 "action_links" => array(empty) "services" => array(4) "type" => "twitter" "service_id" => "372818847" "diplay_name" => "EngagorTest2" "avatar" => "http://a1.twimg.com/sticky/default_profile_images/default_profile_2_normal.png"

Replying on an email

Replying on a case or email

Parameters	Value plain-text formatted
`type`	email "email"
`services`	[{"type":"mailservice","service_id":"catchall_sdasgxsdq15468q.38734684@mails.engagor.com"}] array(1) 0 => array(2) "type" => "mailservice" "service_id" => "[email protected]"
`to`	[{"id":"alicia.farmer@mail.com"}] array(1) 0 => array(1) "id" => "[email protected]"
`subject`	Case #12 "Case #12"
`message`	Dear, thank you very much for your patience. Kind regards, Abstergo Store "Dear, thank you very much for your patience. Kind regards, Abstergo Store"
`topic_id`	2109 "2109"
`mention_id`	3891110078048108718 "3891110078048108718"

Example Response plain-text formatted
{"meta":{"code":200},"response":{"meta":{"code":200},"response":{"messages":[{"level":"success","description":"The mail was successfully sent to the contact."}],"publisher_mention":{"id":"53438","author":{"id":"867678","name":"John Doe","company":"Abstergo Store","email":"john.doe@abstergostore.com","avatar":"https:\\\/\\\/www.gravatar.com\\\/avatar\\\/307d66a09d7a7817d017c230f8d046c5?s=60&d=mm"},"message":{"content":"Dear, thank you very much for your patience. Kind regards, Abstergo Store","type":"email","permalink":"https:\\\/\\\/app.engagor.com\\\/inbox\\\/16063\\\/publish\\\/mailservice\\\/email\\\/2109\\\/3891110078048108718\\\/?action=edit&id=53438&status=posted","status":"posted"},"date":{"added":1513680324,"published":0},"action_links":[{"key":"note","type":"api","link":"https:\\\/\\\/api.engagor.com\\\/2109\\\/inbox\\\/mention\\\/867678\\\/","http_method":"POST"},{"key":"tags","type":"api","link":"https:\\\/\\\/api.engagor.com\\\/2109\\\/inbox\\\/mention\\\/867678\\\/","http_method":"POST"}],"services":[{"type":"mailservice","service_id":"catchall_sdasgxsdq15468q.38734684@mails.engagor.com","displayname":"info@abstergostore.com","avatar":""}],"actions":[{"user":{"id":"867678","name":"John Doe"},"type":"publish","description":"John Doe published post.","date":{"added":1513680325}}]}}}} array(2) "meta" => array(1) "code" => (int) 200 "response" => array(2) "meta" => array(1) "code" => (int) 200 "response" => array(2) "messages" => array(1) 0 => array(2) "level" => "success" "description" => "The mail was successfully sent to the contact." "publisher_mention" => array(7) "id" => "53438" "author" => array(5) "id" => "867678" "name" => "John Doe" "company" => "Abstergo Store" "email" => "[email protected]" "avatar" => "https:\/\/www.gravatar.com\/avatar\/307d66a09d7a7817d017c230f8d046c5?s=60&d=mm" "message" => array(4) "content" => "Dear, thank you very much for your patience. Kind regards, Abstergo Store" "type" => "email" "permalink" => "https:\/\/app.engagor.com\/inbox\/16063\/publish\/mailservice\/email\/2109\/3891110078048108718\/?action=edit&id=53438&status=posted" "status" => "posted" "date" => array(2) "added" => (int) 1513680324 "published" => (int) 0 "action_links" => array(2) 0 => array(4) "key" => "note" "type" => "api" "link" => "https:\/\/api.engagor.com\/2109\/inbox\/mention\/867678\/" "http_method" => "POST" 1 => array(4) "key" => "tags" "type" => "api" "link" => "https:\/\/api.engagor.com\/2109\/inbox\/mention\/867678\/" "http_method" => "POST" "services" => array(1) 0 => array(4) "type" => "mailservice" "service_id" => "[email protected]" "displayname" => "[email protected]" "avatar" => "" "actions" => array(1) 0 => array(4) "user" => array(2) "id" => "867678" "name" => "John Doe" "type" => "publish" "description" => "John Doe published post." "date" => array(1) "added" => (int) 1513680325

Replying to a private message

Parameters	Value plain-text formatted
`type`	privatemessage "privatemessage"
`services`	[{"type":"facebook","service_id":"facebook-page-id"}] array(1) 0 => array(2) "type" => "facebook" "service_id" => "facebook-page-id"
`message`	Thank you for contacting us via Facebook, we will be in touch very soon. "Thank you for contacting us via Facebook, we will be in touch very soon."
`topic_id`	2109 "2109"
`mention_id`	3891110078048108718 "3891110078048108718"

Sending a CSAT question to a user.

Parameters	Value plain-text formatted
`type`	privatemessage "privatemessage"
`services`	[{"type":"facebook","service_id":"facebook-page-id"}] array(1) 0 => array(2) "type" => "facebook" "service_id" => "facebook-page-id"
`message`	We hope your experience with BRAND was a pleasant one. Would you mind answering this short question about your experience? "We hope your experience with BRAND was a pleasant one. Would you mind answering this short question about your experience?"
`topic_id`	2109 "2109"
`mention_id`	3891110078048108718 "3891110078048108718"
`canned_response_id`	123 "123"

Replying with media

Qualtrics Social Connect API

Endpoints » /{account_id}/publisher/add

`GET https://api.engagor.com/{account_id}/publisher/add`

Description

Required Access Token Scope

GET Parameters

Result

Examples

`POST https://api.engagor.com/{account_id}/publisher/add`

Description

Required Access Token Scope

POST Parameters

Result

Examples