RESTful API

Register Twitter App

Previous Versions

Tag 34

Overview

To post a message on your Twitter's timeline you will need a Twitter app, you could use the Twitter's fabric to do so. Once you have it you need to register it with the Campaign Manager to make it able to post messages in your name.

URL

Parameters on the following URL are inside braces { } 

{base_url}/rest/api/tools/registerTwitterApplication/{instanceId}/{appName}/{twAppId}/{twAppSecret}/{redirectURL}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
appName Your Twitter App's name which will post your messages. This parameter must be Base64 encoded.
twAppId Your Twitter App's identifier, if you don't know it you can check it using the Twitter Developer Site
twAppSecret Your Twitter App's secret, if you don't know it you can check it using the Twitter Developer Site
redirectURL The URL that users will be redirected to from Twitter after registration finished. This parameter must be Base64 encoded.
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example

Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts. 

<input>registerTwitterApplication</input>
<status>OK</status>
<description>Completed</description>
<result>
      <application>
         <name>MessangiTest</name>
         <platform>TWITTER</platform>
         <clientId>AS23DERx5RsXcKllmjiO</clientId>
         <info>
            <entry>
               <key>consumer_key</key>
               <value>eKLr232Eaksajd</value>
            </entry>
            <entry>
               <key>consumer_secret</key>
               <value>YDWRTYCSFVBNJ4D7dfGtsD</value>
            </entry>
            <entry>
               <key>reg_redirect_url</key>
               <value>https://staging.ogangitest.com/test/</value>
            </entry>
         </info>
      </application>
</result>
Result parameters
Parameter Name Description Possible Values
application.name Your Twitter App's name Text
application.platform Platform of the application TWITTER
application.clientId The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login Text
application.info Info of the application Text