Product documentation

Channels & deploy

Web widget, messaging, voice, and provider integrations.

Channels (Operate → Channels) and Deploy (/app/assistants/{id}/deploy) connect your assistant to users. Convoship supports an embeddable web widget plus provider-backed channels (WhatsApp, SMS, email, voice, helpdesk handoffs, and custom webhooks).

Deploy page

  • Lists active deployments with token prefix, allowed origins, last used.
  • Revoke — invalidates cdp_* token immediately.
  • Copy embed snippet — script tag + ConvoshipQueue init.
  • Theme JSON — primary color, launcher, header copy.

Web widget (embed)

  1. Click New deployment under Web widget.
  2. Set allowed origins — exact browser origins that may load the widget (e.g. http://localhost:5500).
  3. Copy the cdp_* token (shown once) and the embed snippet.
  4. Add the script to your site; the widget calls the public runtime API.
<script src="https://YOUR_HOST/embed/v1.js"></script>
<script>
  ConvoshipQueue.push(['init', {
    agentId: 'AGENT_UUID',
    token: 'cdp_...',
    channel: 'web',
    apiUrl: 'https://YOUR_API_HOST'
  }]);
</script>

Widget appearance

Configure launcher color, position, greeting, and avatar in the deployment config panel. Changes apply on next page load for embed visitors.

Provider channels

ChannelPurpose
WhatsApp (Meta Cloud API)Native two-way messaging plus proactive templates via Meta's Graph API.
SMS (Twilio)Text message conversations.
EmailInbound email is auto-answered and replied through your email provider (SendGrid, Mailgun, or a generic HTTP relay).
Voice (Twilio)Phone calls with Twilio voice number.
Voice gatewaySIP / streaming gateway for real-time audio.
SIP trunk (BYOC)Bring your own carrier — point your SIP trunk at Convoship for carrier-direct real-time voice.
Zendesk / Genesys / ServiceNowHelpdesk and CCaaS handoff integrations.
Custom webhookBring your own inbound/outbound HTTP bridge.

Voice channel settings

When you connect a voice channel (Twilio Voice, Voice gateway, or SIP trunk) you can tune how the agent sounds and behaves on the call — no code required:

SettingWhat it does
Voice & tonePick the speaking voice and tune steadiness, expressiveness, and speed.
LanguageThe spoken and recognized language for the call.
GreetingAn optional line spoken when the call connects.
Response speedUse a faster model for the lowest latency, or the default for best quality.
Turn-taking (VAD)How quickly the agent decides the caller has finished speaking.
Barge-in & interruption sensitivityLet the caller talk over the agent, and how eagerly it yields.
Thinking phraseAn optional filler spoken while the agent looks something up.
End-of-call messageAn optional line spoken before the call ends.
No-input handlingHow long to wait, how many times to re-prompt, and the maximum call length.
Record callsCapture the caller and agent audio for the call. Recording may require notifying the caller (consent) depending on your jurisdiction.
Recording consent announcementWhen recording is on, a spoken notice (pre-filled with a standard line) played automatically at the start of each call, before the greeting. Edit or clear it as needed.

When recording is on, finished calls appear under Call recordings on the Channels page — play them back or download them right there. Each recording is a stereo file with the caller on the left channel and the agent on the right.

SIP trunk (bring your own carrier)

Enterprises with their own carrier can connect a SIP trunk directly to Convoship, with no third party in the media path. Pick the SIP trunk (BYOC) channel, then point your carrier's SIP trunk at the endpoint shown during setup; the agent answers in real time with the same voice settings above. Your operations team handles the one-time SIP setup — reach out if you'd like help.

Channel connections vs deployments

  • Deployments — bearer tokens for the web embed (cdp_*).
  • Connections — persistent provider links with inbound secrets and encrypted credentials.

CORS & origins

If the widget shows a 403 on session start, the page origin must exactly match an allowed origin on the deployment — check for trailing slashes or http vs https mismatches.