Skip to content
Home/
/Switch

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.14"
Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example:2.14
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. System-defined attributes such as "CX Score rating" and "CX Score explanation" may also be included.

Example:
{
  "paid_subscriber": true,
  "monthly_spend": 155.5,
  "team_mates": 9,
  "start_date_iso8601": "2023-03-04T09:46:14Z",
  "end_date_timestamp": 1677923174,
  "CX Score rating": 4,
  "CX Score explanation": "The conversation was resolved quickly and the customer expressed satisfaction with the outcome."
}
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.14' \
  -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
{
  "url": "http://via.intercom.io/msgr/1add3dd1-a75e-4a96-96fd-984d16aba059",
  "type": "phone_call_redirect"
}