Home
/
REST API Reference
/
Models
/
Conversation Rating

Intercom API (2.7)

The intercom API reference.

Download OpenAPI description
api.intercom.io.json
api.intercom.io.yaml
Overview
URL

https://developers.intercom.com

License

MIT

Languages
Servers
The production API server

https://api.intercom.io/

The european API server

https://api.eu.intercom.io/

The australian API server

https://api.au.intercom.io/

Admins

Everything about your Admins

Operations

Articles

Everything about your Articles

Operations

Companies

Everything about your Companies

Operations

Contacts

Everything about your contacts

Operations

Conversations

Everything about your Conversations

Operations

Data Attributes

Everything about your Data Attributes

Operations

Data Events

Everything about your Data Events

Operations

Data Export

Everything about your Data Exports

Operations

Help Center

Everything about your Help Center

Operations

Messages

Everything about your messages

Operations

News

Everything about your News

Operations

Notes

Everything about your Notes

Operations

Segments

Everything about your Segments

Operations

Subscription Types

Everything about subscription types

Operations

Switch

Everything about Switch

Operations

Tags

Everything about tags

Operations

Teams

Everything about your Teams

Operations

Visitors

Everything about your Visitors

Operations

Models

Conversation Parts

A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts.

typestring
Value"conversation_part.list"
Example: "conversation_part.list"
conversation_partsArray of objects(Conversation Parts)

A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts.

total_countinteger
Example: 2
{
  "type": "conversation_part.list",
  "conversation_parts": [
    { … }
  ],
  "total_count": 2
}

Conversation Rating

The Conversation Rating object which contains information on the rating and/or remark added by a Contact and the Admin assigned to the conversation.

ratinginteger

The rating, between 1 and 5, for the conversation.

Example: 5
remarkstring

An optional field to add a remark to correspond to the number rating

Example: ""
created_atinteger(date-time)

The time the rating was requested in the conversation being rated.

Example: 1671028894
contactobject(Contact Reference)

reference to contact object

teammateobject(Reference)

reference to another object

{
  "rating": 5,
  "remark": "",
  "created_at": 1671028894,
  "contact": {
    "type": "contact",
    "id": "5ba682d23d7cf92bef87bfd4",
    "external_id": "f3b87a2e09d514c6c2e79b9a"
  },
  "teammate": {
    "type": "contact",
    "id": "1a2b3c"
  }
}

Conversation source

The type of the conversation part that started this conversation. Can be Contact, Admin, Campaign, Automated or Operator initiated.

typestring

This includes conversation, email, facebook, instagram, phone_call, phone_switch, push, sms, twitter and whatsapp.

Enum"conversation""email""facebook""instagram""phone_call""phone_switch""push""sms""twitter""whatsapp"
Example: "conversation"
idstring

The id representing the message.

Example: "3"
delivered_asstring

The conversation's initiation type. Possible values are customer_initiated, campaigns_initiated (legacy campaigns), operator_initiated (Custom bot), automated (Series and other outbounds with dynamic audience message) and admin_initiated (fixed audience message, ticket initiated by an admin, group email).

Example: "operator_initiated"
subjectstring

Optional. The message subject. For Twitter, this will show a generic message regarding why the subject is obscured.

Example: ""
bodystring

The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured.

Example: "<p>Hey there!</p>"
authorobject(Conversation part author)

The object who initiated the conversation, which can be a Contact, Admin or Team. Bots and campaigns send messages on behalf of Admins or Teams. For Twitter, this will be blank.

attachmentsArray of objects(Part attachment)

A list of attachments for the part.

urlstring or null

The URL where the conversation was started. For Twitter, Email, and Bots, this will be blank.

Example: null
redactedboolean

Whether or not the source message has been redacted. Only applicable for contact initiated messages.

Example: false
{
  "type": "conversation",
  "id": "3",
  "delivered_as": "operator_initiated",
  "subject": "",
  "body": "<p>Hey there!</p>",
  "author": {
    "type": "admin",
    "id": "274",
    "name": "Operator",
    "email": "operator+abcd1234@intercom.io"
  },
  "attachments": [
    { … }
  ],
  "url": null,
  "redacted": false
}