/api/v1/channels (POST)
const url = 'https://api.endless.zaia.app/api/v1/channels';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"delay":1,"description":"example","detail":{"initialMessage":"example","responseWebhookUrl":"https://example.com","type":"api"},"maxAssistantMessagesPerChatOwner":1,"name":"example","prompt":"example","responderId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","showSenderName":true,"status":"active","useVoice":"on-audio/without-transcription"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.endless.zaia.app/api/v1/channels \ --header 'Content-Type: application/json' \ --data '{ "delay": 1, "description": "example", "detail": { "initialMessage": "example", "responseWebhookUrl": "https://example.com", "type": "api" }, "maxAssistantMessagesPerChatOwner": 1, "name": "example", "prompt": "example", "responderId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "showSenderName": true, "status": "active", "useVoice": "on-audio/without-transcription" }'Creates a new channel.
Request Bodyrequired
Seção intitulada “Request Bodyrequired”object
The delay between the last user message and the beginning of the response generation.
The internal description of the channel.
object
The initial message to be displayed when the API is used.
The webhook URL that receives responses produced through the API channel.
The channel subtype represented by this detail payload.
object
Whether registering tools from the widget’s parent page is allowed.
The initial message to be displayed when the widget is opened.
The level of detail to be included in the loading message when the widget is opened.
Whether the widget should be opened automatically when the page is loaded.
The widget theme palette configuration for the channel.
object
object
object
The channel subtype represented by this detail payload.
object
The backing connection ID used by this channel, when one exists.
The reaction-based takeover policy configured for the channel.
object
The emojis that will handover the chat back to the agent.
Whether the reaction takeover is enabled.
Weather longer messages should be split when delivering them to the connected Waha (WhatsApp) account.
The channel subtype represented by this detail payload.
object
The backing connection ID used by this channel, when one exists.
The reaction-based takeover policy configured for the channel.
object
The emojis that will handover the chat back to the agent.
Whether the reaction takeover is enabled.
Weather longer messages should be split when delivering them to the connected WhatsApp account.
The channel subtype represented by this detail payload.
object
The backing connection ID used by this channel, when one exists.
The reaction-based takeover policy configured for the channel.
object
The emojis that will handover the chat back to the agent.
Whether the reaction takeover is enabled.
Weather longer messages should be split when delivering them to the connected Instagram account.
The channel subtype represented by this detail payload.
object
The backing connection ID used by this channel, when one exists.
Whether longer messages should be split when delivering them to the connected Telegram account.
The channel subtype represented by this detail payload.
The display name of the channel.
A prompt to be passed down to the agent in the context of this channel.
The super identity of the responder (agents or squads) of the channel
Whether to display sender names in chat messages.
The lifecycle status of the channel.
The voice behavior mode configured for the channel.
Responses
Seção intitulada “Responses”The channel was created.
object
A UUID v4 string that identifies an entity.
The delay between the last user message and the beginning of the response generation.
The internal description of the channel.
object
The initial message to be displayed when the API is used.
The webhook URL that receives responses produced through the API channel.
The channel subtype represented by this detail payload.
object
Whether registering tools from the widget’s parent page is allowed.
The initial message to be displayed when the widget is opened.
The level of detail to be included in the loading message when the widget is opened.
Whether the widget should be opened automatically when the page is loaded.
The widget theme palette configuration for the channel.
object
object
object
The channel subtype represented by this detail payload.
object
The backing connection ID used by this channel, when one exists.
The reaction-based takeover policy configured for the channel.
object
The emojis that will handover the chat back to the agent.
Whether the reaction takeover is enabled.
Weather longer messages should be split when delivering them to the connected Waha (WhatsApp) account.
The channel subtype represented by this detail payload.
object
The backing connection ID used by this channel, when one exists.
The reaction-based takeover policy configured for the channel.
object
The emojis that will handover the chat back to the agent.
Whether the reaction takeover is enabled.
Weather longer messages should be split when delivering them to the connected WhatsApp account.
The channel subtype represented by this detail payload.
object
The backing connection ID used by this channel, when one exists.
The reaction-based takeover policy configured for the channel.
object
The emojis that will handover the chat back to the agent.
Whether the reaction takeover is enabled.
Weather longer messages should be split when delivering them to the connected Instagram account.
The channel subtype represented by this detail payload.
object
The backing connection ID used by this channel, when one exists.
Whether longer messages should be split when delivering them to the connected Telegram account.
The channel subtype represented by this detail payload.
The display name of the channel.
A prompt to be passed down to the agent in the context of this channel.
The super identity of the responder (agents or squads) of the channel
Whether to display sender names in chat messages.
The lifecycle status of the channel.
The voice behavior mode configured for the channel.
The workspace ID that owns the channel.
Example
{ "detail": { "type": "api" }, "status": "active", "useVoice": "on-audio/without-transcription"}Invalid channel configuration.
The description of a known exception.
object
The error code.
The error call-to-action.
object
The error feedback.
object
The error message.
The error name.
Example
{ "cta": { "type": "support-contact" }}Unauthorized.
The description of a known exception.
object
The error code.
The error call-to-action.
object
The error feedback.
object
The error message.
The error name.
Example
{ "cta": { "type": "support-contact" }}Plan limit exceeded.
The description of a known exception.
object
The error code.
The error call-to-action.
object
The error feedback.
object
The error message.
The error name.
Example
{ "cta": { "type": "support-contact" }}Resource not found.
The description of a known exception.
object
The error code.
The error call-to-action.
object
The error feedback.
object
The error message.
The error name.
Example
{ "cta": { "type": "support-contact" }}A channel for this connection already exists.
The description of a known exception.
object
The error code.
The error call-to-action.
object
The error feedback.
object
The error message.
The error name.
Example
{ "cta": { "type": "support-contact" }}