Home
/
REST API Reference
/
Models
/
Phone Switch

Intercom API (2.9)

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

Ticket Type Attributes

Everything about your ticket type attributes

Operations

Ticket Types

Everything about your ticket types

Operations

Tickets

Everything about your tickets

Operations

Visitors

Everything about your Visitors

Operations

Models

Part attachment

The file attached to a part

typestring

The type of attachment

Example: "upload"
namestring

The name of the attachment

Example: "example.png"
urlstring

The URL of the attachment

Example: "https://picsum.photos/200/300"
content_typestring

The content type of the attachment

Example: "image/png"
filesizeinteger

The size of the attachment

Example: 100
widthinteger

The width of the attachment

Example: 100
heightinteger

The height of the attachment

Example: 100
{
  "type": "upload",
  "name": "example.png",
  "url": "https://picsum.photos/200/300",
  "content_type": "image/png",
  "filesize": 100,
  "width": 100,
  "height": 100
}

Phone Switch

Phone Switch Response

typestring
Default "phone_call_redirect"
Value"phone_call_redirect"
Example: "phone_call_redirect"
phonestring

Phone number in E.164 format, that has received the SMS to continue the conversation in the Messenger.

Example: "+1 1234567890"
{
  "type": "phone_call_redirect",
  "phone": "+1 1234567890"
}

redact_conversation_request

One of:

Payload of the request to redact a conversation part

typestringrequired

The type of resource being redacted.

Value"conversation_part"
Example: "conversation_part"
conversation_idstringrequired

The id of the conversation.

Example: "19894788788"
conversation_part_idstringrequired

The id of the conversation_part.

Example: "19381789428"
{
  "type": "conversation_part",
  "conversation_id": "19894788788",
  "conversation_part_id": "19381789428"
}