Skip to content
Home/
REST API Reference
/Switch/
Create a 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

SchemasOperations

Articles

Everything about your Articles

SchemasOperations

Companies

Everything about your Companies

SchemasOperations

Contacts

Everything about your contacts

SchemasOperations

Conversations

Everything about your Conversations

SchemasOperations

Data Attributes

Everything about your Data Attributes

SchemasOperations

Data Events

Everything about your Data Events

SchemasOperations

Data Export

Everything about your Data Exports

SchemasOperations

Help Center

Everything about your Help Center

SchemasOperations

Messages

Everything about your messages

SchemasOperations

News

Everything about your News

SchemasOperations

Notes

Everything about your Notes

SchemasOperations

Segments

Everything about your Segments

SchemasOperations

Subscription Types

Everything about subscription types

SchemasOperations

Switch

Everything about Switch

Operations

Create a phone Switch

Request

You can use the API to deflect phone calls to the Intercom Messenger. Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified.

If custom attributes are specified, they will be added to the user or lead's custom data attributes.

Security
bearerAuth
Headers
Intercom-Versionstring(intercom_version)

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

Default 2.9
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example: 2.9
Bodyapplication/json
phonestringrequired

Phone number in E.164 format, that will receive the SMS to continue the conversation in the Messenger.

Example: "+1 1234567890"
custom_attributesobject(Custom Attributes)

An object containing the different custom attributes associated to the conversation as key-value pairs. For relationship attributes the value will be a list of custom object instance models.

curl -i -X POST \
  https://api.intercom.io/phone_call_redirects \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: 2.9' \
  -d '{
    "phone": "+353832345678",
    "custom_attributes": {
      "issue_type": "Billing",
      "priority": "High"
    }
  }'

Responses

successful

Bodyapplication/json
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"
Response
application/json
{
  "url": "http://via.intercom.io/msgr/12b27d11-b981-41a9-a922-886b54bf93b7",
  "type": "phone_call_redirect"
}

Tags

Everything about tags

SchemasOperations

Teams

Everything about your Teams

SchemasOperations

Ticket Type Attributes

Everything about your ticket type attributes

Operations

Ticket Types

Everything about your ticket types

Operations

Tickets

Everything about your tickets

SchemasOperations

Visitors

Everything about your Visitors

Operations

Models

Schemas