Difference between revisions of "API Method MessageCompose"

From Updox API
Jump to: navigation, search
Line 2: Line 2:
 
Provide appropriate credentials for the user who will be sending the message:
 
Provide appropriate credentials for the user who will be sending the message:
 
[[File:MessageCompose1.png]]
 
[[File:MessageCompose1.png]]
 +
  
  
Line 9: Line 10:
  
  
== Request / Response JSON
+
 
 +
== Request and Response JSON
 
Sending this transaction consists of the following request JSON and response JSON and returns a token:
 
Sending this transaction consists of the following request JSON and response JSON and returns a token:
 
[[File:MessageCompose3.png]]
 
[[File:MessageCompose3.png]]
 +
  
  
Line 22: Line 25:
  
  
== Message Compose ==
+
 
 +
== Compose Message ==
 
Browsing to this url will show the following '''''one-use-only''''' Direct message compose screen:
 
Browsing to this url will show the following '''''one-use-only''''' Direct message compose screen:
 
[[File:MessageCompose4.png]]
 
[[File:MessageCompose4.png]]

Revision as of 16:46, 8 April 2014

Contents

Credentials

Provide appropriate credentials for the user who will be sending the message: MessageCompose1.png


Attachments, Prepopulation, Metadata

Provide any relevant additional parameters. If an attachment is to be sent, it must be specified here: MessageCompose2.png


== Request and Response JSON Sending this transaction consists of the following request JSON and response JSON and returns a token: MessageCompose3.png


Build URL

Use this token to construct a url in the following manner: https://{environment}/sso/messageCompose/{vendorId}/{token}

which for this example would look like this: https://updoxqa.com/sso/messageCompose/updox/611e840357c9dd58625436996cc2631910188c61


Compose Message

Browsing to this url will show the following one-use-only Direct message compose screen: MessageCompose4.png