Starts the process of importing an address book from an online email provider
| Client Servlet | Server Servlet | HTTP Methods Supported | Requires Authentication |
|---|---|---|---|
| CRAddressBookAPI | None. | GET, POST | Yes. |
The methods: startOnlineAddressBookImport, addressBookImportOAuthCallback, getAddressBookImportJobStatus, and getAddressBookImportContacts methods use OAuth authentication to request a constituent's consent through a hosting provider such as Google Gmail or Yahoo to access the constituent's address book, and to download the contacts to Luminate Online.
The importAddressBookContacts method may be used to import a comma-separated list of addresses into the constituent's address book, whether downloaded from an online provider using the methods above or exported from an email applications such as Microsoft Outlook or Mozilla Thunderbird. The parseCsvContacts method allows you to easily upload, analyze and parse CSV files from such applications.
This method requires an import_source (either GOOGLE or YAHOO), and a callback_url pointing to a page in your app that will accept the job Id, OAuth token and verifier from the hosting provider when the constituent grants consent. This method returns a <jobId> for the import job and the <oauthUrl> to the page on the host provider that will verify the identity of the constituent and request permission to give your app access to their address book. Your app must redirect to or render the <oauthUrl> contents.
When the constituent grants access to their address book, the hosting provider will call the page you provided in the callback_url parameter. This page parses the import_job_id, oauth_token, and oauth_verifier parameters and calls addressBookImportOAuthCallback to begin downloading addresses from the hosting provider.
You can monitor the status of the download by calling getAddressBookImportJobStatus and specifying the job ID returned by this method. Once the download completes, your app must retrieve the downloaded addresses by calling getAddressBookImportContacts with the job ID, and then add the downloaded contacts to the constituent's address book using importAddressBookContacts.
See topic Common Parameters.
Required. The online email service providing the address book.
Type xsd:string.
Optional. The url that will handle the oauth callback.
Type xsd:string.
Optional. You must provide either this parameter or the sso_auth_token parameter. If using this parameter, you must specify an auth token generated by an embedded [[S86]] session tag in a Convio web page.
Optional. You must provide either this parameter or the auth parameter. If using this parameter, you must specify a valid session authentication token returned by login, authenticateUser, or getSingleSignOnToken.
See topic HTTP Status Codes.
XML response
<?xml version="1.0" encoding="UTF-8"?>
<startOnlineAddressBookImportResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<oauthUrl>http://www.google.com/oauth/49834908</oauthUrl>
<jobId>1001</jobId>
</startOnlineAddressBookImportResponse>
JSON response
{"startOnlineAddressBookImportResponse":{"jobId":"1001","oauthUrl":"http://www.google.com/oauth/49834908"}}