Phone.ai API Documentation

Resources

Authentication

To authenticate with the Phone.ai API, you must use a Bearer Authentication token. This token should be included in the Authorization header of your HTTP requests.

Obtaining Access Tokens

To obtain an access token, send an email request to developer@adhoclabs.co. Include your application details and the reason for your token request. Upon approval, you will receive a token that you can use in your API requests.

Using the Token in Requests

Include the obtained Bearer token in the Authorization header of your HTTP requests. Here's an example using the curl command:

curl -X POST 'https://phone.ai/api/call/create' \
	-H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
	-H 'Content-Type: application/json' \
	-d '{ "data": "your_request_data" }'
			

Error Handling

Understanding and properly handling errors is crucial for a robust integration with the Phone.ai API. The API uses standard HTTP response codes to indicate the success or failure of a request.

Common HTTP Status Codes

• 200 OK: The request was successful.
• 400 Bad Request: The request was invalid or cannot be served. Check the message for details.
• 401 Unauthorized: Authentication failed or user does not have permissions for the requested operation.
• 403 Forbidden: The request is understood, but it has been refused or access is not allowed.
• 500 Internal Server Error: An error occurred on the server side.

Handling a 403 Forbidden Error in Python

Below is an example of how to handle a 403 Forbidden error in Python. This code checks the status code of the response and prints a message if a 403 error occurs:

import requests

url = 'https://phone.ai/api/your_endpoint'
headers = {'Authorization': 'Bearer YOUR_ACCESS_TOKEN'}

response = requests.get(url, headers=headers)

if response.status_code == 403:
	print("Access denied. Check your permissions and token.")
else:
	# Handle other statuses or successful response
pass
			

Rate Limits

The Phone.ai API enforces rate limits to ensure fair usage and maintain the stability and reliability of the service. These limits are in place to prevent abuse and overload of the system.

Understanding Rate Limits

Rate limits are applied based on the number of requests made within a certain time frame. If you exceed these limits, your requests will be temporarily throttled, and you will receive a 429 Too Many Requests response.

Rate Limit Guidelines

• Standard Limit: 100 requests per minute per user.
• Exceeding Limits: If you exceed the rate limit, you must wait until the limit resets before making additional requests.

Monitoring Your Usage

Your current rate limit and remaining requests are communicated via the X-RateLimit-Limit and X-RateLimit-Remaining headers in each API response. It's important to monitor these headers to avoid hitting the rate limit.

Best Practices

To avoid hitting rate limits, consider implementing efficient request strategies such as caching responses where appropriate, staggering requests, and using bulk data endpoints if available.