Initiate Consent API
API to initiate consent on a phone number or to check the consent status of a phone number, independent of a Trip.
This API checks
the existing consent status and initiates if a consent request is not already present in the system
triggers all internal processes to fetch the latest consent info from the telco provider
makes sure the FT database is updated with the latest info
We would recommend keeping a time gap of 5 min between consent initiate call and consent status call for a particular number to fetch latest consent info
Initiate consent API flow:
When a consent initiate API call is made, we will check with the Telecom provider for the latest consent status. Based on the response, we will update the database and send the response to the client.
Without the customer explicitly calling the consent initiate API, whenever there is an open trip - the FT system automatically checks for the latest consent status by calling the consent initiate API internally to ensure the trip is tracked.
By calling consent initiate API, Customer always gets the latest info as we check the status with the Telecom provider.
API Endpoint:
Latest URL https://api.freighttiger.com/api/consent/initiate - Production Environment
Request Parameters:
Name | Type | Location | Description | Example |
---|---|---|---|---|
Authorization | string | headers | JWT token required to authenticate API call. | Authorization: Bearer eyJhbGciOiJIUzI1Ni |
mobile | string | parameters | Driver Phone Number for consent |
|
Responses:
{
"mobile_number": "8897122356",
"trip_id": null,
"devices": [
{
"country_code": "91",
"mobile_number": "8897122356",
"carrier": "jio",
"missed_call_timestamp": null,
"missed_call_received": false,
"consent_status": null,
"consent_initiated_timestamp": 1672832647110,
"consent_completed_timestamp": null,
"bypass_missed_call": false,
"tracking_status": "supported"
}
]
}
{
"error": "invalid phone number",
"error_description": "Please pass valid phone number as 'mobile' header"
}
{
"message": "Unauthorized"
}
Post your questions in the comment box to get answers from the experts who watch this page.
For engineering support: visit FT Support