Jump to Content

Home Guides API Reference Changelog Webhooks

API Reference

Home Guides API Reference Changelog Webhooks

Core API

Social Accounts
- Get the list of social accountsget

Subbot Webhooks

Configuration
- Describe configurationget
Runtime

OAuth 2.0 Client Credentials Grant

Authentication
- Get an OAuth2 access token.post

User Provisionning

Roles
- Listget
Teams
- Listget
Accounts

Subbot API

/uploaded-tabular-data
- Return uploaded dataget
/subbot/continue
- Continue interaction with userpost

InMessage

Authenticate
- Custom identificationget
- Anonymouslyget
Conversation
- Send a messagepost
- List messagesget
Media
- Uploadpost
- Downloadget
File

Actions

List
- List a conversation's actionsget
- List actionsget
Notify
- Notify a webhookpost

Exports

Exports
- List allget
- Download oneget

Custom Fields

User
Conversation
- Set conversation fieldsput
- Return conversation fieldsget
Fields
- Get metadata for a custom fieldget
- Get metadata for all custom fieldsget

Scenarios

/start-scenario
- Start Scenariopost

Application Management

Errors
- List recent errorsget
Webhook status
- Get webhook statusget
- Set webhook statuspost

AI Webhooks

Invoke AI Bot
- Ask for an AI generated answer to sent to a social network userpost
Suggest Answer
- Ask for a suggestion answer for a support agentpost
Suggest Statistics
- Provide statistics about a suggested answerpost

AI

/ai/answer
- Send AI generated answerpost
/ai/suggest-answer
- Send AI generated suggestionpost

Kakaotalk Send API

Templates
- Get the list of Kakaotalk templatespost
Message history
- Get the list of Kakaotalk sent messagesget
Send a template
- Send a KakaoTalk message using a templatepost

Embed (Alpha)

/embed
- Generate Embed Urlpost

Powered by

Get metadata for a custom field

get https://api.alcmeon.com/custom-field/users/fields/{custom_field_id}

Return the metadata for the given custom field id

Language

Credentials

Basic

base64

: