Conversation Manager APIs (3.0.0)

Download OpenAPI specification:Download

API Support: apisupport@egain.com URL: https://apidev.egain.com

This section provides the requisite APIs needed to create Conversation Manager accounts and to configure conversation workflows. To create the Conversation Manager acccount, use the Conversation APIs in this order when setting up a complete eGain application:

Authentication
Client Application
Participant
Channel
Orchestration
Account

After the account is created you can use the following APIs to send / receive messages.

Conversation
Asset

Note: You can configure your system to use third party Bots and third party Channels. The API instructions provided here assume you are using eGain's application setup.

Service Level Agreement (SLA)

This API has different rate limits and quotas based on your subscription plan.

Available Plans

Developer Plan

Cost: $1/month
Rate Limits:
- default:
  - POST: 0.16 requests per second
  - Burst: 1 concurrent requests
  - PUT: 0.16 requests per second
  - Burst: 1 concurrent requests
  - GET: 0.16 requests per second
  - Burst: 1 concurrent requests
  - DELETE: 0.16 requests per second
  - Burst: 1 concurrent requests
Quotas:
- default:
  - POST: 1000 requests per month
  - GET: 1000 requests per month
  - PUT: 1000 requests per month
  - DELETE: 1000 requests per month

Basic Plan

Cost: $1/month
Rate Limits:
- /conversations/messages:
  - POST: 1 requests per second
  - Burst: 3 concurrent requests
- /conversations/{id}:
  - GET: 1 requests per second
  - Burst: 3 concurrent requests
- /assets:
  - POST: 1 requests per second
  - Burst: 3 concurrent requests
- /assets/{id}:
  - GET: 1 requests per second
  - Burst: 3 concurrent requests
- default:
  - POST: 0.5 requests per second
  - Burst: 2 concurrent requests
  - PUT: 0.5 requests per second
  - Burst: 2 concurrent requests
  - GET: 0.5 requests per second
  - Burst: 2 concurrent requests
  - DELETE: 0.5 requests per second
  - Burst: 2 concurrent requests
Quotas:
- default:
  - POST: 100000 requests per month
  - GET: 100000 requests per month
  - PUT: 100000 requests per month
  - DELETE: 100000 requests per month

Enterprise Plan

Cost: $1/month
Rate Limits:
- /conversations/messages:
  - POST: 5 requests per second
  - Burst: 15 concurrent requests
- /conversations/{id}:
  - GET: 5 requests per second
  - Burst: 15 concurrent requests
- /assets:
  - POST: 5 requests per second
  - Burst: 15 concurrent requests
- /assets/{id}:
  - GET: 5 requests per second
  - Burst: 15 concurrent requests
- default:
  - POST: 1 requests per second
  - Burst: 30 concurrent requests
  - PUT: 1 requests per second
  - Burst: 30 concurrent requests
  - GET: 1 requests per second
  - Burst: 30 concurrent requests
  - DELETE: 1 requests per second
  - Burst: 30 concurrent requests
Quotas:
- default:
  - POST: 500000 requests per month
  - GET: 500000 requests per month
  - PUT: 500000 requests per month
  - DELETE: 500000 requests per month

Internal Plan

Cost: $1/month
Rate Limits:
- /conversations/messages:
  - POST: 5 requests per second
  - Burst: 15 concurrent requests
- /conversations/{id}:
  - GET: 5 requests per second
  - Burst: 15 concurrent requests
- /assets:
  - POST: 5 requests per second
  - Burst: 15 concurrent requests
- /assets/{id}:
  - GET: 5 requests per second
  - Burst: 15 concurrent requests
- default:
  - POST: 1 requests per second
  - Burst: 30 concurrent requests
  - PUT: 1 requests per second
  - Burst: 30 concurrent requests
  - GET: 1 requests per second
  - Burst: 30 concurrent requests
  - DELETE: 1 requests per second
  - Burst: 30 concurrent requests
Quotas:
- default:
  - POST: 500000 requests per month
  - GET: 500000 requests per month
  - PUT: 500000 requests per month
  - DELETE: 500000 requests per month