If you implement, or plan on implementing, Interact integration in your app, please drop us a line and let us know, we’d be happy to help.
Interact supports for integration with other apps via the x-callback-url protocol. Interact registers the following URL scheme:
- Interact: interact://
x-callback-url Actions
All URLs should begin with the base URL "interact://x-callback-url/[action]" where action is one of the actions listed below.
/scratchpad
- Action: scratchpad
- Parameters:
- text [string, optional] : URL encoded text to be used in the scratchpad.
- Description: Opens Interact directly to the Contact Scratchpad to parse plain text to contact data. Supports x-callback x-success and x-cancel parameters.
- Examples
- open scratchpad with the text “Hello World”:
interact://x-callback-url/scratchpad?text=Hello%20World
- open scratchpad with the text “Hello World”:
/createContext
- Action: createContext
- Parameters:
- text [string, optional] : text to fill in the body of the context.
- subject [string, optional] : text to fill in the subject of the context.
- Description: This will open Interact with the provided text and subject filled in the context ready to be used in Interact mail and messaging.
- Examples
- open Interact with "Hello World" in context body:
interact://x-callback-url/createContext?text=Hello%20World
- open Interact with "Hello World" in context body:
/group
- Action: group
- Parameters:
- name [string, required] : Name of a valid contact group to load in the contact list.
- Description: This will open Interact and load the named group into the contact list.
- Examples
- open Interact with group "Family" in contact list:
interact://x-callback-url/group?name=Family
- open Interact with group "Family" in contact list:
/search
- Action: search
- Parameters:
- text [string, optional] : Text to prefill search field.
- Description: This will open Interact and focus the contact search field ready for search.
- Examples
- open Interact with group "Joe" in contact search:
interact://x-callback-url/search?text=Joe
- open Interact with group "Joe" in contact search:
Callbacks
All Interact URL actions support x-callback-url formatted callback parameters, as follows:
- x-success [url, optional] : URL will be opened after the action is successfully completed.
- x-error [url, optional] : When used in conjunction with the ‘action’ parameter, this URL will be opened if the action generates an error and cannot be completed successfully.
- x-cancel [url, optional] : URL opened if requested action is canceled.
Comments
0 comments
Please sign in to leave a comment.