Difference between revisions of "API Method MessageCompose"
From Updox API
(Created page with "Provide appropriate credentials for the user who will be sending the message: File:MessageCompose1.png Provide any relevant additional parameters. If an attachment is to...") |
|||
| Line 1: | Line 1: | ||
| − | Provide appropriate credentials for the user who will be sending the message: | + | == Credentials ==Provide appropriate credentials for the user who will be sending the message: |
[[File:MessageCompose1.png]] | [[File:MessageCompose1.png]] | ||
| + | |||
| + | == Attachments, Prepopulation, Metadata == | ||
Provide any relevant additional parameters. If an attachment is to be sent, it must be specified here: | Provide any relevant additional parameters. If an attachment is to be sent, it must be specified here: | ||
[[File:MessageCompose2.png]] | [[File:MessageCompose2.png]] | ||
| + | |||
| + | == Request / 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]] | ||
| + | |||
| + | == Build URL == | ||
Use this token to construct a url in the following manner: | Use this token to construct a url in the following manner: | ||
https://{environment}/sso/messageCompose/{vendorId}/{token} | https://{environment}/sso/messageCompose/{vendorId}/{token} | ||
| Line 14: | Line 20: | ||
https://'''updoxqa.com'''/sso/messageCompose/'''updox'''/'''611e840357c9dd58625436996cc2631910188c61''' | https://'''updoxqa.com'''/sso/messageCompose/'''updox'''/'''611e840357c9dd58625436996cc2631910188c61''' | ||
| + | |||
| + | == Message Compose == | ||
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:43, 8 April 2014
== Credentials ==Provide appropriate credentials for the user who will be sending the message:
Attachments, Prepopulation, Metadata
Provide any relevant additional parameters. If an attachment is to be sent, it must be specified here:
== Request / Response JSON
Sending this transaction consists of the following request JSON and response JSON and returns a token:
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
Message Compose
Browsing to this url will show the following one-use-only Direct message compose screen:
