Conversations

Check for new messages on a lead

Polling helper: given a reference message id and type, returns whether any newer messages exist for the lead. Used by embedded surfaces (Salesforce, etc.) that need to refresh the timeline without re-downloading it. When same_type is true, only messages on the same channel as message_type are considered.

post/api/v1/conversations/leads/{id}/messages/check-new

Request

  • Base URL: https://api.talkfurther.com
  • URL: https://api.talkfurther.com/api/v1/conversations/leads/{id}/messages/check-new
  • Auth: one of:
    • API key in header Authorization
    • API key in header Authorization

Path parameters

idinteger required

Request body

message_type'email' | 'sms' | 'null' nullable required

Channel of the reference message. Pass null to check across all channels.

  • email - email
  • sms - sms
message_idinteger nullable required

Identifier of the last message the caller has seen. Pass null to check from the beginning.

same_typeboolean

If true, only count new messages whose channel matches message_type.

Response

new_messagesboolean required

true if there are messages newer than the reference message; otherwise false.

Changes

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