Background

The Carbon Voice URL API provides a way to deep-link into the Carbon Voice application to kick-off an experience. This also helps in creating experiences where the user may start to interact with CarbonVoice content within a 3rd party app and then needs to transition to the Carbon Voice app (web or mobile) to complete the interaction.

In some situations, when that task is completed the desired experience is to redirect back to the 3rd party application when things are done.

URL Entry-points

All of these entry-points work for carbonvoice.app or cv.chat. All entry-points support auto-login process.

Route	Destination
/c/	Go to a Conversation
/m/	Go to a Message
/w/	Go to a Workspace
/a/record	Start recording
/a/recordmemo	Start recording a voice memo
/a/meeting	Starts a meeting creation
/a/notify/meet
/a/notify/msg
/[vanityName]	Personalized CarbonLink landing page
/a/carbonlink	Create a CarbonLink

URL API Parameters

Parameters	Values
a=	Auth Token
u=	User ID to match
m=	Mode for playback & player. Valid Values are:

“s” - Start playback (on supported platforms)
“d” - Opens in distracted ode

DEPRECATED: ~~* ”p” - Loads message but doesn’t start playing. (Note, some OS or browsers won’t allow auto-play, so they will also open as paused even without this parameter).

“c” - Open message in Conversation feed.
“cp” - Open in Conversation feed paused.~~ | | t= | Timestamp duration in seconds. | | attach= | URL to attach | | cid= | Conversation id | | mid= | Message id | | wid= | Workspace id | | uid= | Comma separated List of userIDs for addressing | | email= | Comma separated list of email addresses | | phone= | Comma separated list of a E.164 formatted phone numbers. | | ctype= | Conversation Type. Valid values:
dm - Direct Message
named - Named Conversation | | c_name= | Conversation Name to use when creating new name. | | visibility= | Visibility setting. Valid values:
any - Anyone with link can join
workspace - Anyone in workspace can join
private - Only added people can join | | end_date= | a UTC date and time for meeting ending. | | redirect_url= | URL for redirect. | | status= | Status information that can be used by the respective entry-point. | | joined= | |

Background

URL Entry-points

URL API Parameters

Entry-Point Usage

Auto-Login

Go to Conversation (/c/<cid>)

Go to Message (/m/<mid>)

Go to Workspace (/w/<wid> or /a/space)

Go to Workspace Joinable Conversations (/a/space_joinable_conversations)

Start Recording (/a/record)

Start Recording (/a/recordmemo)

Start Meeting Creation (/a/meeting)

Meeting Notify (/a/notify/meet)

Message Notify (/a/notify/msg)