Intercom API (unofficial showcase)
POST/phone_call_redirects

Create a phone call redirect

Triggers a phone call redirect by sending an SMS with a Messenger link to the specified phone number. Supply phone in E.164 format; you can also include custom_attributes to add caller-set attributes to the contact or lead. The SMS directs the recipient to continue the conversation in Messenger.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 2 body fields
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

Phone call redirect details. phone is required; custom_attributes can contain caller-set key-value attributes.

phonestringrequired
Phone number in E.164 format, that will receive the SMS to continue the conversation in the Messenger.
custom_attributesobjectoptional
The custom attributes which are set on this object, as key-value pairs. For relationship attributes the value should be a list of custom object instance models. Only attributes a caller may set are accepted here — attributes Intercom generates are returned in responses only.

4 status codes
200Returns a phone call redirect object with the phone number that received the SMS.
typestringoptional
Allowed:phone_call_redirectDefault:phone_call_redirect
phonestringoptional
Phone number in E.164 format, that has received the SMS to continue the conversation in the Messenger.
400Returned when the phone number is invalid.
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
422Returned when the request cannot be processed.

Error handling

A 400 is returned for an invalid phone number. A 401 is returned when the request is unauthorized, and a 422 is returned when the request cannot be processed. phone must use E.164 format.