Phone ID - Identity attributes: Call Forwarding

Use this identity attribute 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.

Example

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

Request

POST https://rest-ww.telesign.com/v1/phoneid/15555551212 HTTP/1.1
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."
    }
  }
}

Schema

Request

Parameter

Type

Description

Example

Validations

Required?

addons

object

Indicates which identity attributes you want to use with this request, and contains any other inputs for use with those identity attributes.

y

addons.call_forward_detection

object

Serves as a flag to enable the Call Forwarding identity attribute. The value should be an empty object.

y

consent

object

A record of how and when you obtained consent to query this phone number.

y

consent.method

integer

A 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
  • 4 = OTHER

1

Allowed Values: 1,2,3,4

n

consent.timestamp

string

A timestamp indicating the date and time when you collected consent to query this phone number.

2018-05-01T00:30:30Z

Format: date-time

y

Response

Property

Type

Description

Example

call_forward_detection

object

Contains call forwarding status details for this phone number. Only present if you included the flag for the Call Forwarding identity attribute in your request and Telesign has enabled this identity attribute for your account.

call_forward_detection.call_forward_enabled

string

Whether this phone number has call forwarding enabled.

  • "true" = It is enabled.
  • "false" = It is not enabled.

"true"

call_forward_detection.call_forward_type

string

The 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_condition

string

The 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

status

object

Contains properties related to the delivery status of this package. For a list of possible statuses, see Phone ID - Get started with identity attributes.

status.code

code

A numeric code indicating the delivery status of this package.

2800

status.description

string

A short description of the delivery status of this package.

Request successfully completed.


Did this page help you?