Home
/
REST API Reference
/
Switch
/
Create a phone Switch

Create a phone Switch

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.

SecurityHTTP: bearerAuth
Request
header Parameters
Intercom-Version
string (intercom_version)
Default: 2.10

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

Enum: "1.0" "1.1" "1.2" "1.3" "1.4" "2.0" "2.1" "2.2" "2.3" "2.4" "2.5" "2.6" "2.7" "2.8" "2.9" "2.10" "Unstable"
Example: 2.10
Request Body schema: application/json
phone
required
string

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

object (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.

post
/phone_call_redirects
Request samples
application/json
{
"phone": "+353832345678",
"custom_attributes": {
"issue_type": "Billing",
"priority": "High"
}
}
Responses

200

successful

Response Schema: application/json
type
string
Default: "phone_call_redirect"
Value: "phone_call_redirect"
phone
string

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

400

bad request - invalid number

401

Unauthorized

422

unprocessable entity

Response samples
application/json
{
"url": "http://via.intercom.io/msgr/ce9c9f4a-c77c-492f-92fd-3bfe29efb497",
"type": "phone_call_redirect"
}