Care Messenger Documentation

Release v2.0.

User Guide

A brief overview of the Care Messenger platform.

• Introduction
  • Overview
  • Hierachy

REST API

• API Overview
  • REST
  • Base URL
• Authentication
  • Obtaining the API token for a user
  • Making Requests
• API Serialization Formats
  • JSON
  • XML
• Schema and Resource Layout
  • Viewing the Schema
  • List and Detail Endpoints on Resources

Quickstart Guide

• Building Message Sets
  • Examples
  • Message Options
  • Message Choice Options
• Sending a Message Set
  • Javascript Example
• Revoking a Message Set
• Escalating a Message Set Over IVR (Interactive Voice Response)
• Scheduling a Message Set
  • One Time Delivery
  • Recurring Delivery
  • One Time Delivery Example
  • Recurring Delivery Example
  • Deleting a Scheduled Message Set

Webhooks

• Webhooks
  • Event Types
  • Registering a Webhook
  • Example Request
  • Example Response
  • Events, Responses and Retries
  • Webhook POST
  • Example Webhook POST

Assistance

• Assistance Requests
  • Assistance Providers
  • Creating an Assistance Provider
  • Response Format
  • Email Notifier Attributes
  • Webhook Notifier Attributes

Indices and tables

• Index

• Module Index

• Search Page