Messages
Documentation for Conversations API
Export messages by location ID
Export messages for a specific location with cursor-based pagination support.
Get message by message id
Get message by message id.
Get messages by conversation id
Get messages by conversation id.
Send a new message
Post the necessary fields for the API to send a new message.
Add an inbound message
Post the necessary fields for the API to add a new inbound message. <br /><br />**Note:** Either `conversationId` or `contactId` is required
Add an external outbound call
Post the necessary fields for the API to add a new outbound call.
Cancel a scheduled message.
Post the messageId for the API to delete a scheduled message. <br />
Upload file attachments
Post the necessary fields for the API to upload files. The files need to be a buffer with the key 'fileAttachment'. <br /><br /> <b>Note:</b> One of conversationId or contactId must be provided. <br /><br /> <b>File Size Limits:</b> <ul><li>Maximum file size: 5 MB</li><li>Maximum files per upload: 5</li></ul> <br /> <b>Allowed file types:</b> <br /><br /> <b>Images:</b> JPG, JPEG, PNG, GIF, SVG, HEIC, AI <br /><br /> <b>Videos:</b> MP4, MPEG, 3GP <br /><br /> <b>Audio:</b> MP3, WAV, WAVE, AIFF, AIF, AIFC, GSM, ULAW, OGG, AAC, M4A, AMR <br /><br /> <b>Documents:</b> PDF, DOC, DOCX, TXT, CSV, XLS, XLSX, PPT, PPTX, ODT <br /><br /> <b>Archives:</b> ZIP, RAR <br /><br /> <b>Other:</b> VCF, VCARD (contact files), ICS (calendar files) <br /><br /> The API will return an object with the URLs <br /><br /> <b>File-service storage:</b> Attachments are stored in the files service, and every response includes <code>uploadedFileDetails</code>. The returned file-service URLs are publicly accessible for one hour after upload. After that window, the attachment becomes private. To render, download, or retry access, extract the `{slug}` from the returned `/files/d/{slug}` URL and call <a href='https://marketplace.gohighlevel.com/docs/ghl/files/get-file-by-slug' target='_blank'>`GET /files/d/{slug}`</a> with a bearer token that includes the `files.readonly` OAuth scope. The Files API returns a short-lived signed download URL.
Update message status
Post the necessary fields for the API to update message status.
Add message attachments
Set attachments on an existing message (replaces existing). Maximum 5 URLs. Supported for Custom Call message type.
Get Recording by Message ID
Get the recording for a message by passing the message id
Get transcription by Message ID
Get the recording transcription for a message by passing the message id
Download transcription by Message ID
Download the recording transcription for a message by passing the message id