Call Forward Status

RATE THIS PAGE

A simple and easy way to know if calls to a number are routed to another number.

Overview

Call forwarding status is a powerful way to immediately know if calls to a certain number are being routed to another number. If you want to ensure that you are reaching the right customer, then you can use this API to predetermine if call forwarding is active. Combine this API with other APIs for a rich set of fraud prevention capabilities.

Specifications

Postman collection Swagger

POST client-credentials/accesstoken

https://staging.api.chenosis.io/client-credentials/accesstoken?grant_type=client_credentials

Overview

The OAuth2 request.

Header parameters

Content-Type application/x-www-form-urlencoded

Query parameters

grant_type string

Body parameters

client_id string required

The client id fromt your app.

client_secret string required

The client secret fromt your app.

Request


curl --location --request POST 'https://staging.api.chenosis.io/client-credentials/accesstoken?grant_type=client_credentials'
    --header 'Authorization: token // https://staging.api.chenosis.io/client-credentials/accesstoken?grant_type=client_credentials'
    --header 'Content-Type: application/x-www-form-urlencoded'
    --data-raw '{
        "client_id": "xxxxxxxxxxxxxxx",
        "client_secret": "xxxxxxxxxxxxxxx",
    }'

Responses

200OK

refresh_token_expires_in string

When the token will expire

api_product_list string

The products associated

api_product_list_json json

The products associated

organization_name string

The organisation that is beign called against

developer.email string

The developer email

token_type string

The type of authorization

issued_at string

When the token was issued

client_id string

The Client ID from the app

access_token string

The Client Secret from the app

application_name string

The application ID

scope string

What scope has been applied

expires_in string

When the token will expire

refresh_count string

How many refreshes available

status string

The status of the request

{
    "refresh_token_expires_in": "0",
    "api_product_list": "[product_verify_experience]",
    "api_product_list_json": [
        "product_verify_experience"
    ],
    "organization_name": "prod",
    "developer.email": "[email protected]",
    "token_type": "BearerToken",
    "issued_at": "1617003906435",
    "client_id": "HJFGT565435GGh87qi6n88zstxiL26BG",
    "access_token": "wwNJdSTHF54RD476HMI8plZuwLp3",
    "application_name": "7879798543g-98jh-6yg5-7876-876hg5df4sd2",
    "scope": "USER-VERIFICATION",
    "expires_in": "3599",
    "refresh_count": "0",
    "status": "approved"
}

GET mobile/subscriber/{phoneNumber}/call-forwarding-status

api.host.com/mobile/subscriber/{phoneNumber}/call-forwarding-status

Overview

Retrieve call-forwarding status from network operator of subscriber as identified by phoneNumber.

Auth type

oauth2 authorisation required

Please checkout the documentation to review how to access the endpoint via oAuth 2.

Header parameters

Content-Type application/json

URL variable parameters

phoneNumber string

ID of the subscriber is the MSISDN of the subscriber represented as International ITU-T E.164.

Request


curl --location --request GET 'https://api.host.com/mobile/subscriber/{phoneNumber}/call-forwarding-status'
    --header 'Authorization: token // https://staging.api.chenosis.io/client-credentials/accesstoken?grant_type=client_credentials'
    --header 'Content-Type: application/json'

Responses

200OK

statusCode string

HTTP error code extension

statusMessage string

Message.

phoneNumber string

phoneNumber provided in the input

data

callForwardingIsEnabled string

TRUE,FALSE,NONE

transactionId string

transaction ID for tracing.

{
    "statusCode": "string",
    "statusMessage": "string",
    "phoneNumber": "string",
    "data": {
        "callForwardingIsEnabled": "string"
    },
    "transactionId": "string"
}

400Bad Request

statusCode integer

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

{
    "statusCode": 1,
    "statusMessage": "string",
    "SupportMessage": "string"
}

401Unauthorized

statusCode integer

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

{
    "statusCode": 1,
    "statusMessage": "string",
    "SupportMessage": "string"
}

403Forbidden

statusCode integer

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

{
    "statusCode": 1,
    "statusMessage": "string",
    "SupportMessage": "string"
}

404Not Found

statusCode integer

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

{
    "statusCode": 1,
    "statusMessage": "string",
    "SupportMessage": "string"
}

405Method Not Allowed

statusCode integer

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

{
    "statusCode": 1,
    "statusMessage": "string",
    "SupportMessage": "string"
}

406Not Acceptable

statusCode integer

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

{
    "statusCode": 1,
    "statusMessage": "string",
    "SupportMessage": "string"
}

500Internal Server Error

statusCode integer

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

{
    "statusCode": 1,
    "statusMessage": "string",
    "SupportMessage": "string"
}

Pricing

100 Free Daily

A simple and easy way to know if calls to a number are routed to another number.

^$ 0 ^.00 PER
CALL

Other customer information products

One simple API to determine the most recent sim sw...

View

A simple API that allows you to know which country...

View

Easily retrieve detailed up to date information ab...

View

VIEW ALL

Product

Call Forward Status

Overview

Specifications

Overview

Header parameters

Content-Type application/x-www-form-urlencoded

Query parameters

grant_type string

Body parameters

client_id string required

client_secret string required

Request

Responses

200OK

refresh_token_expires_in string

api_product_list string

api_product_list_json json

organization_name string

developer.email string

token_type string

issued_at string

client_id string

access_token string

application_name string

scope string

expires_in string

refresh_count string

status string

Overview

Auth type

oauth2 authorisation required

Header parameters

Content-Type application/json

URL variable parameters

phoneNumber string

Request

Responses

200OK

statusCode string

statusMessage string

phoneNumber string

data

callForwardingIsEnabled string

transactionId string

400Bad Request

statusCode integer

statusMessage string

SupportMessage string

401Unauthorized

statusCode integer

statusMessage string

SupportMessage string

403Forbidden

statusCode integer

statusMessage string

SupportMessage string

404Not Found

statusCode integer

statusMessage string

SupportMessage string

405Method Not Allowed

statusCode integer

statusMessage string

SupportMessage string

406Not Acceptable

statusCode integer

statusMessage string

SupportMessage string

500Internal Server Error

statusCode integer

statusMessage string

SupportMessage string

Pricing

100 Free Daily

Other customer information products

SIM Swap Date

Home Location

Mobile Customer Information

Related recipes