Messages

Get messages by contacts

Changed on

REQUIRED SCOPES <code>['messages:read']</code><br>Returns an array of messages found by Contact ID and Inbox ID. If multiple Contact IDs are provided, this endpoint will search for group conversations with these IDs.

get/messages/contacts

Request

  • Base URL
    https://api.salesmessage.com/pub/v2.3
  • URL
    https://api.salesmessage.com/pub/v2.3/messages/contacts
  • Auth
    HTTP bearer

Query parameters

contacts[]integer[] required

Contacts

team_idinteger

Team ID

limitinteger

The number of items to return per page.

beforeinteger

Before

Response

OK

idinteger
conversation_idinteger
automatedboolean
statusstring
typestring
mms_statusstring
bodystring
body_rawstring
has_taggingboolean
iconstring
received_atstring
send_atstring
queued_atstring
sent_atstring
delivered_atstring
failed_atstring
failed_reasonstring
created_atstring
stop_on_responseboolean
is_hipaaboolean
manuallyTranscribeAvailableboolean

False when transcript_locked.

transcript_lockedboolean

Call made while HIPAA was enabled, HIPAA is off now: no transcript.

user_idinteger
source_idstring
sourcestring

Changes

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status