Message Share Links

Get or create the shared-replies conversation for a share link

Idempotent get-or-create-and-join. The first caller creates a named conversation owned by the share link creator, seeded with the shared voice memo; later callers are joined to the existing conversation and get it back. Joining is gated by the share link's own access rules (revoked, expired, public/specified), and rejected with SHARED_MESSAGE_PRIVATE_REPLIES_ONLY when the link only allows private replies.

post/channels/sharelink/{share_link_id}

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/channels/sharelink/{share_link_id}
  • Auth: one of:
    • API key in header pxtoken
    • OAuth 2 (implicit, authorization URL https://api.carbonvoice.app/oauth/authorize)

Path parameters

share_link_idstring required
Example:fd546db4b648d6b1fa

MessageShareLink ID

Response

workspace_guidstring required
channel_guidstring required
channel_namestring required
channel_kind'standard' | 'derived' required
source_channel_idsstring[] required
channel_descriptionstring nullable
bg_rrggbbstring nullable
txt_rrggbbstring nullable
channel_settingsstring required
image_urlstring nullable
is_privatestring required
post_rulestring nullable
dm_hashstring nullable
last_updated_tsnumber required
sort_orderstring date-time required
created_tsnumber required
deleted_atnumber nullable
owner_namestring required
sms_phonestring nullable
joined_tsnumber nullable
is_favorite'N' | 'Y' required
last_heard_tsnumber nullable
last_posted_tsnumber nullable
last_viewed_atstring date-time nullable
workspace_namestring required
workspace_image_urlstring nullable
type'directMessage' | 'customerConversation' | 'namedConversation' | 'asyncMeeting' required
imagesstring[] required
moreCountnumber required
unread_cntnumber required
createdNewboolean required
settingsobject required
visibility'private' | 'workspace' | 'public' required
total_messagesnumber required
total_duration_millisecondsnumber required
is_asyncboolean required
retention_daysnumber nullable
engagement_percentagenumber
max_sequence_numbernumber required
default_role'admin' | 'owner' | 'creator' | 'member' | 'guest' required
seen_seqnumber nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.