Message Share Links

Get list of Message Share Links by Message ID's (Up to 500 messages each request)

post/message-sharelinks/by-message-ids

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/message-sharelinks/by-message-ids
  • Auth: one of:
    • API key in header pxtoken
    • OAuth 2 (implicit, authorization URL https://api.carbonvoice.app/oauth/authorize)

Request body

message_idsstring[] required

List of Message IDs, Max allowed is 500

start_datestring date-time

Start Date range

end_datestring date-time

End Date range

Example request

{
  "start_date": "2024-01-01T04:25:00.000Z",
  "end_date": "2024-01-10T04:25:00.000Z"
}

Response

message_idstring required

Message ID

is_public_sharedboolean

Is the message shared publicly

Example response

[
  {
    "sharelinks": [
      {
        "created_at": 1694313500106,
        "last_updated_at": 1694313500106,
        "revoked_at": 1694313500106
      }
    ]
  }
]

Changes

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