Troubleshooting

Use this guide to quickly identify and resolve common issues encountered when integrating with the Advanced Dialer APIs.

Common Issues & Solutions

1. Missing Required Headers

The Issue: The request fails because a mandatory versioning or security header is missing.
Error Message: X-Api-Version header is required
The Solution: Ensure that X-Api-Version: 2.0 is included in the header of every request.

curl --request GET \
     --url 'https://api.talkdeskapp.com/Advanced Dialer/api/agent' \
     --header 'X-Api-Version: 2.0' \
     --header 'Ocp-Apim-Subscription-Key: YOUR_API_KEY'

2. Invalid JSON Format

The Issue: The API gateway cannot parse the request body.
Error Message: Request body contains invalid JSON
The Solution: Use a JSON linter to validate your structure. Common culprits include trailing commas, missing quotes around keys, or unescaped special characters in strings.

3. Field Validation Errors

The Issue: Data being sent violates the constraints defined in the system.
Error Message: Value exceeds maximum length for field or Required field missing
The Solution: Before sending data, query the Field Definitions endpoint for your specific prefix to verify:

• Max Length: Ensure strings do not exceed character limits.
• Data Type: Ensure you aren't sending a string to a numeric field.
• Required Status: Verify all mandatory fields are present in the payload.

4. Authentication Failures

The Issue: The system does not recognize the provided credentials.
Error Message: Subscription key is invalid
The Solution: 1. Verify the key in your developer dashboard.
2. Ensure the key is "Active."
3. Confirm the key is associated with the Advanced Dialer product.

Error Quick Reference

💡

Need More Help?

If your issue is not listed here, please check the Standard Response Format page for a full list of status codes or contact our technical support team with your request logs.