Channels
Refer to our channel definition for more information.
#
ListPOST /channels.list
Sample request
Sample response
#
InfoPOST /channels.info
Sample request
Sample response
#
UpdatePOST /channels.update
Update a channel's name or image URL.
Sample request
Sample response
#
Connecting channels#
Airy Live Chat PluginConnects a Chat Plugin source to Airy Core.
name
is a unique identifier of your choice.
Sample response
#
FacebookConnects a Facebook page to Airy Core.
page_id
is the Facebook page IDpage_token
is the page Access Tokenname
is the custom name for the connected pageimage_url
is the custom image URL
Sample request
Sample response
#
InstagramConnects an Instagram account to Airy Core.
page_id
is ID of the Facebook page connected to the Instagram accountpage_token
is the Access Token of the Facebook pageaccount_id
is the ID of the Instagram accountname
is the custom name for the connected pageimage_url
(optional) is the custom image URL
Sample request
Sample response
#
FacebookConnects a Whatsapp cloud phone number to Airy.
phone_number_id
the whatsapp phone number connected to your business accountuser_token
your user access tokenname
is the custom name for the connected pageimage_url
is a custom image url for displaying this channel on the UI
Sample request
Sample response
#
GoogleConnects a Google Business Account to Airy Core.
gbm_id
is the ID of your Google Business Message agentname
is the custom name for the connected businessimage_url
is the custom image URL
Sample response
#
SMSphone_number
The phone number as listed in your Twilio dashboard. It must not contain spaces and must include the country code.name
is the custom name for the connected phone numberimage_url
is the custom image URL
Sample request
Sample response
#
Whatsappphone_number
The phone number as listed in your Twilio dashboard. It must not have spaces and must include the country code.name
is the custom name for the connected phone numberimage_url
is the custom image URL
Sample request
Sample response
#
Disconnecting channels#
Airy Live Chat PluginA synchronous endpoint that makes a request to the source to disconnect the channel. It marks the channel as disconnected and deletes the auth token.
This action is idempotent, so if the channel is disconnected, the request
returns status code 202
. If the channel is unknown, the request returns status
code 400
.
Sample request
#
FacebookDisconnects a Facebook page from Airy Core.
A synchronous endpoint that makes a request to the source to disconnect the channel. It marks the channel as disconnected and deletes the auth token.
This action is idempotent, so if the channel is disconnected, the request
returns status code 202
. If the channel is unknown, the request returns status
code 400
.
Sample request
#
InstagramDisconnects an instagram account from Airy Core.
A synchronous endpoint that makes a request to the source to disconnect the channel. It marks the channel as disconnected and deletes the auth token.
This action is idempotent, so if the channel is disconnected, the request
returns status code 202
. If the channel is unknown, the request returns status
code 400
.
Sample request
#
GoogleA synchronous endpoint that makes a request to the source to disconnect the channel. It marks the channel as disconnected and deletes the auth token.
This action is idempotent, so if the channel is disconnected, the request
returns status code 202
. If the channel is unknown, the request returns status
code 400
.
Sample request
#
SMS - TwilioA synchronous endpoint that makes a request to the source to disconnect the channel. It marks the channel as disconnected and deletes the auth token.
This action is idempotent, so if the channel is disconnected, the request
returns status code 202
. If the channel is unknown, the request returns status
code 400
.
Sample request
#
Whatsapp - TwilioA synchronous endpoint that makes a request to the source to disconnect the channel. It marks the channel as disconnected and deletes the auth token.
This action is idempotent, so if the channel is disconnected, the request
returns status code 202
. If the channel is unknown, the request returns status
code 400
.
Sample request
#
Exploring available channels#
FacebookPOST /channels.facebook.explore
A synchronous endpoint that makes a request to Facebook
to list the available Facebook pages. Some of those pages may already
be connected, which is accounted for in the boolean field connected
. Due to
the nature of the request, the response time may vary.
Sample request
Sample response