V1 - Send Message
Send and receive messages, to single contacts per request, on channels connected to CosmoBots
This document is intended to be used for developers using CosmoBots API to send and receive messages, to single contacts per request, on channels connected to CosmoBots.
To send messages to registered channels we are considering you already have connected the channel to your Bot on CosmoBots.
Endpoint
Authentication
Every request needs to have these two parameters on the header. You may retrieve both on the Integration section of the platform. Follow these steps:
Login into the platform
Choose the Bot
On the left sidebar menu, choose Integrations, then API
Choose the Send Message API
Click on Enable API
Now you can copy both token and channelId to use on the requests
Sending Message
Here are the body fields used during this request. The format is JSON.
Contact Object
Object
Session Object
Desk Object
Object
Message Array [Object]
Array [Object]
Message > Data (If Type is Text)
Message > Data (If Type is Buttons)
Message > Data (If Type is Cards)
Message > Data (If Type is Media)
Response Sync
Response Async
Examples Of Request
Sending Text Destination: Contact
Destination: Contact
Sending Text With Buttons Destination: Contact
Destination: Contact
Sending Media Destination: Contact
Destination: Contact
Receiving Message
To receive messages coming from CosmoBots, you have to register your endpoint on our webhook. You may find the webhook setup on the Channels section of the platform. Follow these steps:
Login into the CosmoBots platform
Choose the Bot
On the left sidebar menu, choose Channel, then the specific channel you are using
On the Webhook Url field, include the endpoint that will receive the requests
The Body fields are the same as the fields from the Body of the Sending Message request above.
Last updated