PhoneID API - Add-ons: Call Forward Detection

Use this add-on to get details related to the call forwarding status of a given phone number. These details include:

  • Whether call forwarding is enabled
  • Whether call forwarding is conditional
  • The conditions under which calls will be forwarded

You must include a consent record in your request indicating how and when you received consent to obtain information related to this phone number.


A full request with this add-on is shown in the example below, as well as the extra package that the add-on includes in the response body.


Authorization: Basic 12345678-9ABC-DEF0-1234-56789ABCDEF0:vjE/ZDfPvDkuGNsuqCFFO4neYIs=
Date: Thu, 12 Oct 2019 14:11:09 GMT
Content-Type: application/json 
  "addons": {
    "call_forward_detection": {}
  "consent": {
     "method": 1,
     "timestamp": "2018-05-01T00:30:30Z"

Response (body only)

  "call_forward_detection": {
    "call_forward_enabled": "true",
    "call_forward_type": "conditional",
    "call_forward_condition": "busy",
    "status": {
      "code": 2800,
      "description": "Request successfully completed."



addonsobjectIndicates which add-ons you want to use with this request, and contains any other inputs for use with those add-ons.y
addons.call_forward_detectionobjectServes as a flag to enable the Call Forward Detection add-on. The value should be an empty object.y
consentobjectA record of how and when you obtained consent to query this phone number.y
consent.methodintegerA numeric code indicating how you collected consent to query this phone number. The default value is 1.

1 = Terms and conditions (TCO)
2 = Mobile app (MA)
3 = SMS
1Allowed Values: 1,2,3,4n
consent.timestampstringA timestamp indicating the date and time when you collected consent to query this phone number.2018-05-01T00:30:30ZFormat: date-timey


call_forward_detectionobjectContains call forwarding status details for this phone number. Only present if you included the flag for the Call Forward Detection add-on in your request and TeleSign has enabled this add-on for your account.
call_forward_detection.call_forward_enabledstringWhether this phone number has call forwarding enabled.

"true" = It is enabled.
"false" = It is not enabled.
call_forward_detection.call_forward_typestringThe type of call forwarding enabled for this phone number. Conditional forwarding causes incoming calls to go to another phone line only when the initial destination phone number cannot be reached.conditional
call_forward_detection.call_forward_conditionstringThe conditions under which calls will be forwarded for this number. If the phone number uses unconditional call forwarding or has no call forwarding at all, the value will be "None".busy
statusobjectContains properties related to the delivery status of this package. For a list of possible statuses, see Get Started with Add-ons.
status.codecodeA numeric code indicating the delivery status of this package.2800
status.descriptionstringA short description of the delivery status of this package.Request successfully completed.

Did this page help you?