Difference between revisions of "API Method MessageCompose"
(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...") |
(→Compose Message) |
||
| (7 intermediate revisions by one user not shown) | |||
| Line 1: | Line 1: | ||
| + | == Credentials == | ||
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]] | ||
| + | |||
| + | |||
| + | == 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 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]] | ||
| + | |||
| + | |||
| + | == 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} |
which for this example would look like this: | which for this example would look like this: | ||
| − | https:// | + | https://updoxqa.com/sso/messageCompose/updox/611e840357c9dd58625436996cc2631910188c61 |
| − | Browsing to this url will show the following '''''one-use-only''''' Direct message compose screen | + | Note that as this token has already been used, browsing to this exact link will result in a 404 error. |
| + | |||
| + | == Compose Message == | ||
| + | Browsing to this url will show the following '''''one-use-only''''' Direct message compose screen. Note that the From address is the specified user's directAddress and is pre-populated and unchangeable. The other pre-populated items are changeable at compose-time. | ||
[[File:MessageCompose4.png]] | [[File:MessageCompose4.png]] | ||
| + | |||
| + | When the user hits Send, this window will execute an API call behind the scenes. | ||
Latest revision as of 16:51, 8 April 2014
Contents |
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 and 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
Note that as this token has already been used, browsing to this exact link will result in a 404 error.
Compose Message
Browsing to this url will show the following one-use-only Direct message compose screen. Note that the From address is the specified user's directAddress and is pre-populated and unchangeable. The other pre-populated items are changeable at compose-time.
When the user hits Send, this window will execute an API call behind the scenes.
