---
title: "Get Message Share Link with Shared Message"
method: GET
path: "/v3/message-sharelinks/{share_link_id}"
tags: ["Message Share Links"]
deprecated: true
---

# Get Message Share Link with Shared Message

`GET /v3/message-sharelinks/{share_link_id}`

## Request

- Base URL: `https://api.carbonvoice.app`
- URL: `https://api.carbonvoice.app/v3/message-sharelinks/{share_link_id}`
- Auth: one of:
  - API key in header `pxtoken`
  - OAuth 2 (implicit, authorization URL `https://api.carbonvoice.app/oauth/authorize`)

> **Deprecated.**

## Path parameters

- `share_link_id` string, required

## Response `200`

- MessageShareLinkWithMessage
  - `_id` string, required: Unique Identifier of share link
  - `created_by` string, required: Identifier of the User who created the share/forward
  - `channel_id` string, nullable: Channel ID where forwarded message was sent to
  - `message_id` string, nullable: Message ID that has the share_link_id attached to
  - `created_at` number, required
  - `last_updated_at` number, required
  - `end_access_at` number, nullable: Date when the access to shared message ends
  - `revoked_at` number, nullable
  - `revoked_by` string, nullable
  - `share_type` 'forward' | 'link', required: What is the ShareType of the MessageShareLink
  - `access_type` 'public' | 'specified' | 'forward', required: What is the access type for the MessageShareLink
  - `specified_access` SpecifiedAccess[]: List of Specified Access for the MessageShareLink
    - `type` 'channel' | 'workspace' | 'workspace_group' | 'user', required: What is the Specified access type for the MessageShareLink
    - `ids` string[], required: List of IDs that have access to the MessageShareLink
  - `reply_type` 'shared' | 'private_only', required: How replies to this share link behave. Legacy links without the field are private_only.
  - `reply_conversation_id` string, nullable: Conversation holding the shared replies to this link, if one was already created
  - `shared_message` MessageV2, required
    - `message_id` string, required
    - `creator_id` string, required
    - `created_at` string, date-time, required
    - `deleted_at` string, date-time, nullable
    - `last_updated_at` string, date-time, required
    - `workspace_ids` string[], required
    - `channel_ids` string[], required
    - `parent_message_id` string, nullable
    - `heard_ms` number, nullable: The number of ms of audio listened to by the user requesting the message
    - `utm_data` UtmData
      - `utm_source` string
      - `utm_medium` string
      - `utm_campaign` string
      - `utm_term` string
      - `utm_content` string
    - `attachments` Attachment[], required
      - `_id` string, required
      - `client_id` string, nullable
      - `creator_id` string, required
      - `created_at` string, date-time, required
      - `type` 'link' | 'file' | 'location' | 'ai-response-id' | 'ai-prompt-id' | 'action-item-id' | 'ask-id', required
      - `link` string, required
      - `active_begin` string, date-time, nullable
      - `active_end` string, date-time, nullable
      - `filename` string, nullable
      - `mime_type` string, nullable
      - `length_in_bytes` number, nullable
      - `location` LatLon
        - `latitude` number, double, required
        - `longitude` number, double, required
      - `status` 'Initializing' | 'Uploading' | 'Uploaded' | 'Failed'
      - `percent_complete` number, nullable
    - `notes` string, required
    - `notify` boolean, required: Has the logged in user cleared the notification for this message
    - `last_heard_update` string, date-time, required: Last time we listened/updated notify bit
    - `reaction_summary` ReactionSummary, required
      - `reaction_counts` object, required
      - `top_user_reactions` UserReaction[], required
        - `user_id` string, required
        - `reaction_id` string, required
      - `top_user_emojis` TopUserEmoji[]: Optional: summaries persisted before this field existed lack it — clients must tolerate absence.
        - `reaction` string, required: Canonical unicode emoji (e.g. ❤️, 🎉)
        - `count` number, required: Authoritative total number of distinct users with this reaction (never capped)
        - `user_ids` string[], required: A capped preview of users who reacted with this emoji — a sample, not the full list
    - `name` string, nullable
    - `is_text_message` boolean, required
    - `status` 'offline' | 'paused' | 'processing' | 'scheduled' | 'active' | 'deleted' | 'account-deleted' | 'initializing' | 'inprogress' | 'canceled' | 'failed', required
    - `label_ids` string[], required
    - `audio_models` AudioModelV2[], required
      - `_id` string, required
      - `url` string, required
      - `extension` string, nullable, required
      - `streaming` boolean, required
      - `language` string, required
      - `duration_ms` number, required
      - `waveform_percentages` number[], required
      - `is_original_audio` boolean, required
    - `text_models` TextModel[], required
      - `type` 'transcript' | 'transcript_with_timecode' | 'summary' | 'topic' | 'bullet_list', required
      - `audio_id` string, nullable, required
      - `language_id` string, required
      - `value` string, required
      - `timecodes` TimedText[], required
        - `t` string, required: The text
        - `s` number, required: The start time in ms
        - `e` number, required: The end time in ms
    - `source_message_id` string, nullable, required
    - `cache_key` string, required
    - `audio_delivery` 'recording' | 'streaming', required
    - `users_not_allowed_to_receive_notifications` UsersNotAllowedReceiveNotifications[]
      - `user_id` string, required
      - `phone` string, required
    - `users_not_allowed_to_receive_notifications_v2` UsersNotAllowedReceiveNotificationsV2[]
      - `user_id` string, required
      - `phone` string, nullable
      - `email` string, nullable
    - `duration_ms` number, required: The length of the message in milliseconds
    - `total_heard_ms` number, required: The number of ms of audio listened to by all users
    - `notified_users` number, required: Then number of users who have a notification for this message and have not listened to the audio.
    - `users_caught_up` 'all' | 'some' | 'none', required: The number of users that listened to the audio or removed the notification
    - `forward_id` string, nullable: The ID of a forwarded message (Deprecated, for new implementations we should start using share_link_id
    - `share_link_id` string, nullable: The ID of a Share Link to a message
    - `stream_key` string, nullable: The stream key used to add audio to the message
    - `socket_disconnects_while_streaming` number, required: The number of times the socket disconnected while the creator was sending audio
    - `type` 'channel' | 'prerecorded' | 'voicememo' | 'stored' | 'welcome', required: Message type
    - `channel_sequence` number, required: The sequencial id of the message within the channel
    - `last_heard_at` string, date-time, required: The last time anyone listened or cleared notified on this message
    - `folder_id` string, nullable: Folder ID, only present when the message type is one of: voicememo,prerecorded
    - `tagged_user_ids` string[], required: IDs of users tagged in the message
  - `has_channel_access` boolean, required

## Other responses

- `403`

---

[API](https://skmtc.dev/carbonvoice/apis/carbon-voice-api.md) · [All operations](https://skmtc.dev/carbonvoice/apis/carbon-voice-api/llms.txt) · [OpenAPI document](https://skmtc.dev/carbonvoice/apis/carbon-voice-api/revisions/b91c5c845122?raw)