Call Forward Detection Add-on

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.

Example

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.

Request
application/json
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)
application/json
{
  "call_forward_detection": {
    "call_forward_enabled": "true",
    "call_forward_type": "conditional",
    "call_forward_condition": "busy",
    "status": {
      "code": 2800,
      "description": "Request successfully completed."
    }
  }
}

Schema

Request
object
addons
object

Indicates which add-ons you want to use with this request, and contains any other inputs for use with those add-ons.

required
consent
object

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

required
Response
object
call_forward_detection
object

Contains 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.