Jump to Content

Guides API Reference Webhooks

API Reference

Guides API Reference Webhooks

All

Pages

Start typing to search…

Core API

Social Accounts
- Get the list of social accountsget
Global variables
- Get global scenario variablesget
- Set a global scenario variableput

Subbot Webhooks

Configuration
- Describe configurationget
Runtime

OAuth 2.0 Client Credentials Grant

Authentication
- Get an OAuth2 access tokenpost

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
Summarization
- Summarize textpost
Translation
- Ask for a translation of a text to a language for a support agent.post
Invoke AI Bot V2
- Ask for an AI generated answer to send to a social network user (V2)post

AI

/ai/answer
- Send AI generated answerpost
/ai/suggest-answer
- Send AI generated suggestionpost
/ai/summary
- Send AI generated summarypost
/ai/translation
- Send AI generated translationpost
/ai/v2/answer
- Send AI generated answer (V2)post

Initiate a conversation API

Whatsapp
- Send a Whatsapp message using a templatepost
Kakaotalk

Embed (Alpha)

/embed
- Generate Embed Urlpost

Send Answer API

Answer
- Send an answer messagepost
Attachment
- Upload an attachmentpost

Optins

Optins
User Optins
User Optouts

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

: