Introduction to Campaign API

Welcome to the Adviser.ai API documentation overview. This guide will help you understand how to integrate with the Adviser.ai platform programmatically to send various types of campaigns. Adviser.ai offers a JSON-based OAuth2 API, ensuring secure and efficient interactions with its services. Here’s a summary of the key aspects and functionalities:

Overview

API Protocol: JSON-based, using OAuth2 for authentication.

Base URL: All API requests should be made to https://adviser.ai/api/v3/.

Security: All requests must be secure (HTTPS).

Types of Campaigns

The Adviser.ai API supports multiple types of campaigns that you can send. Below are some examples,

Live DataDescription
Typical use

To support and compliment a “live” outbound strategy (such as where enquiries are still being called).
DescriptionSends one email (and/or) SMS message. Message content for each repeated message changes according to pre-set templates each time a send is made.
Further Requests24 hour block on repeated sends
Dead DataDescription
Typical use
To nurture and contact customers who are not being actively contacted by any other means (such as for remarketing and uncontactable enquiries where enquiries are no longer being called )
DescriptionSends 6 different email / sms messages to a customer with predetermined time gaps (every week, two weeks or monthly) between each message.
Further RequestsNo further requests allowed during campaign
Adviser
Single		Description
Typical useTo engage a customer before the first attempted call or before set appointments
DescriptionSends one message only
Further
Requests		No blocks