RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://developers.intercom.com/docs/references/unstable/rest-api/api.intercom.io/messages below:

Intercom API (Unstable) Copy Copy for LLM Copy page as Markdown for LLMs View as Markdown Open this page as Markdown Open in ChatGPT Get insights from ChatGPT Open in Claude Get insights from Claude

Intercom API (Unstable)

The intercom API reference.

Download OpenAPI description

The production API server The european API server

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

The australian API server

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

Admins

Everything about your Admins

AI Content

With the AI Content APIs, you can create and manage External Pages and Content Import Sources for your Fin Content Library.

External Pages are pages that you want Fin to be able to answer questions about. The API for External Pages is a great way to ingest into your Fin Content Library pages that are not publicly accessible and hence can't be crawled by Intercom.

Content Import Sources are the sources of those pages, and they are used to determine the default audience for the pages (configured via the UI). You should create a Content Import Source for each source of External Pages that you want to ingest into your Fin Content Library.

You can then iterate through the content from that source via its API and POST it to the External Pages endpoint. That endpoint has an external_id parameter which allows you to specify the identifier from the source. The endpoint will then either create a new External Page or update an existing one as appropriate.",

Articles

Everything about your Articles

Away Status Reasons

Everything about your Away Status Reasons

Companies

Everything about your Companies

Conversations

Everything about your Conversations

Custom Channel Events

With the "Custom Channel" integration, you can bring Fin and Intercom capabilities to your own platform via API, enabling powerful custom integrations.

Intercom treats your integration like any other Intercom channel, allowing your application and Intercom to exchange events seamlessly. This makes it possible, for example, for your users to interact with Fin directly within your own application’s UI.

Note: "Fin over API" is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

Custom Object Instances

Everything about your Custom Object instances.

Permission Requirements

From now on, to access this endpoint, you need additional permissions. Please head over to the Developer Hub app package authentication settings to configure the required permissions.

Data Attributes

Everything about your Data Attributes

Data Events

Everything about your Data Events

Data Export

Everything about your Data Exports

Help Center

Everything about your Help Center

Internal Articles

Everything about your Internal Articles

Macros

Operations related to saved replies (macros) in conversations

Messages

Everything about your messages

Message

Message are how you reach out to contacts in Intercom. They are created when an admin sends an outbound message to a contact.

The id representing the message.

Example: "1488971108"

created_atinteger(date-time)required

The time the conversation was created.

Example: 1667560812

The subject of the message. Only present if message_type: email.

Example: "Greetings"

The message body, which may contain HTML.

Example: "Hello"

message_typestringrequired

The type of message that was sent. Can be email, inapp, facebook, twitter, sms or whatsapp.

Enum"email""inapp""facebook""twitter""sms""whatsapp"

Example: "inapp"

The associated conversation_id

Example: "64619700005570"

{ "type": "user_message", "id": "1488971108", "created_at": 1667560812, "subject": "Greetings", "body": "Hello", "message_type": "inapp", "conversation_id": "64619700005570" }

Request

You can create a message that has been initiated by an admin. The conversation can be either an in-app message, an email, sms or whatsapp.

🚧 Sending for visitors

There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case.

This will return the Message model that has been created.

🚧 Retrieving Associated Conversations

As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.

Headers Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default Unstable

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: Unstable

Bodyapplication/json

Any of:

message_typestringrequired

The kind of message being created. Values: in_app, email, sms or whatsapp.

Enum"in_app""email""sms""whatsapp"

Example: "in_app"

Example: "Thanks for everything"

The content of the message. HTML and plaintext are supported.

Example: "Hello there"

The style of the outgoing message. Possible values plain or personal.

Example: "plain"

The sender of the message. If not provided, the default sender will be used.

Always admin.

Value"admin"

Example: "admin"

The identifier for the admin which is given by Intercom.

Example: 394051

toRecipient (object) or Array of Recipient (objects)required

One of:

The role associated to the contact - user or lead.

Enum"user""lead"

Example: "user"

The identifier for the contact which is given by Intercom.

Example: "536e564f316c83104c000020"

ccRecipient (object) or Array of Recipient (objects) bccRecipient (object) or Array of Recipient (objects)

The time the message was created. If not provided, the current time will be used.

Example: 1590000000

create_conversation_without_contact_replyboolean

Whether a conversation should be opened in the inbox for the message without the contact replying. Defaults to false if not provided.

Default false

Example: true

The production API server https://api.intercom.io/messages
The european API server https://api.eu.intercom.io/messages
The australian API server https://api.au.intercom.io/messages

curl
Node.js
Ruby
PHP
Python
Java
Go
C#
R

curl -i -X POST \
  https://api.intercom.io/messages \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: Unstable' \
  -d '{
    "from": {
      "type": "user",
      "id": "6762f2341bb69f9f2193bc17"
    },
    "body": "heyy",
    "referer": "https://twitter.com/bob"
  }'

Bodyapplication/json

The id representing the message.

Example: "1488971108"

created_atinteger(date-time)required

The time the conversation was created.

Example: 1667560812

The subject of the message. Only present if message_type: email.

Example: "Greetings"

The message body, which may contain HTML.

Example: "Hello"

message_typestringrequired

The type of message that was sent. Can be email, inapp, facebook, twitter, sms or whatsapp.

Enum"email""inapp""facebook""twitter""sms""whatsapp"

Example: "inapp"

The associated conversation_id

Example: "64619700005570"

{ "type": "user_message", "id": "403918396", "created_at": 1734537780, "body": "heyy", "message_type": "inapp", "conversation_id": "613" }

Get statuses of all messages sent based on the specified ruleset_id Request

Retrieves statuses of messages sent from the Outbound module. Currently, this API only supports WhatsApp messages.

This endpoint returns paginated status events for WhatsApp messages sent via the Outbound module, providing information about delivery state and related message details.

Query

The unique identifier for the set of messages to check status for

Number of results per page (default 50, max 100)

Default 50

Cursor for pagination, used to fetch the next page of results

Headers Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default Unstable

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: Unstable

The production API server https://api.intercom.io/messages/status
The european API server https://api.eu.intercom.io/messages/status
The australian API server https://api.au.intercom.io/messages/status

curl
Node.js
Ruby
PHP
Python
Java
Go
C#
R

curl -i -X GET \
  'https://api.intercom.io/messages/status?ruleset_id=string&per_page=50&starting_after=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: Unstable'

Bodyapplication/json pages.per_pageintegerrequired

Number of results per page

pages.total_pagesintegerrequired

Information for fetching next page (null if no more pages)

total_countintegerrequired eventsArray of objectsrequired events[].idstringrequired events[].conversation_idstringrequired events[].statusstringrequired

Current status of the message

Enum"sent""delivered""read""failed"

events[].typestringrequired

Value"broadcast_outbound"

events[].created_atintegerrequired events[].updated_atintegerrequired events[].whatsapp_message_idstringrequired

WhatsApp's message identifier

events[].template_namestring

Name of the WhatsApp template used

{
  "type": "list",
  "ruleset_id": 12345,
  "pages": {
    "type": "pages",
    "per_page": 50,
    "total_pages": 3,
    "next": { … }
  },
  "total_count": 125,
  "events": [
    { … },
    { … }
  ]
}

News

Everything about your News

Notes

Everything about your Notes

Reporting Data Export

Everything about Reporting Data Export

Segments

Everything about your Segments

Subscription Types

Everything about subscription types

Teams

Everything about your Teams

Ticket States

Everything about your ticket states

Ticket Type Attributes

Everything about your ticket type attributes

Ticket Types

Everything about your ticket types

Tickets

Everything about your tickets

Visitors

Everything about your Visitors

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4