Below are answers to the most common questions about the Talkroute API. For step-by-step setup instructions, see our Getting Started API article.
Access & Eligibility
How do I get access to the Talkroute API?
Complete the Request API Access form with your account details and a description of your use case. Our team reviews each request and follows up with next steps once your access is approved.
Is the API available on all plans?
API access is enabled on a per-account basis after your request is reviewed. For details on what is included with your plan, please contact our team.
Is there a test or sandbox environment?
The API operates against your live Talkroute account. There is no separate sandbox environment, so use caution when testing requests that create, update, or delete data.
Authentication & API Keys
How does authentication work?
The API uses Bearer token authentication. You include your API key in the Authorization header of every request. Keys are issued in the format tr_live_ followed by a string of characters.
What should I do if my API key is compromised?
Treat your API key like a password. If you believe a key has been exposed, please reach out to our support team so we can revoke it and generate a new one. Never share your key publicly, store it in client-side code, or commit it to source control.
Why am I getting a 401 Unauthorized error?
A 401 response means your API key is missing, malformed, or invalid. Confirm that you are sending the key as a Bearer token in the Authorization header and that the key has not been revoked.
What the API Can Do
What resources can I access with the API?
The API provides programmatic access to Talkroute resources, including contacts, text conversations and messages, voicemail, call history, users, extensions, virtual numbers, menus, ring groups, forwarding numbers, forwarding schedules, and business hours.
Can I make or receive voice calls through the API?
No. The public API does not provide direct access to voice calling. It is focused on non-voice resources such as contacts, messaging, voicemail, call activity, and account configuration.
Can I send and receive text messages with the API?
Yes. You can access text conversations and their messages and mark messages as read or unread. To send text messages using our API, an enabled bulk texting plan is needed.
Can I manage call routing, menus, and business hours?
Yes. The API includes endpoints for managing menus and menu options, ring groups and their members, forwarding numbers and schedules, extensions, and business hours, so you can configure call handling programmatically.
Can I retrieve voicemail and call recordings?
Yes. You can retrieve voicemail box and voice message details and request a URL for the voicemail's audio file. Call history records can also be retrieved and filtered.
Can I build CRM integrations?
Yes. The API is well suited for connecting Talkroute with CRM platforms, help desks, reporting systems, and custom internal tools. You can sync contacts and communication history across the systems your team already uses.
Usage, Limits & Reliability
How does pagination work?
List endpoints that can return large result sets, such as call history, are paginated. Use the page and pageSize query parameters to move through results.
Are there usage limits?
Yes, there is a default limit of 120 requests per minute for each account. If you require a higher limit for your account, please contact our team.
Text messaging has additional limits beyond the account request limit. Outbound text messages are rate limited per minute and are subject to a daily cap that depends on your registered campaign type. Please let us know if you have any questions about the limits that apply to your campaign.
Does the API support webhooks?
Yes. You can create webhook subscriptions so Talkroute notifies your application when a specific event occurs, rather than requiring your integration to poll for changes. Available events can change between releases, so check the API documentation for the current list.
Data & Security
Is the connection secure?
Yes. All API requests are made over HTTPS, so data is encrypted in transit.
Does deleting data through the API permanently remove it?
Yes. Delete operations through the API remove the data from your account. Because there is no separate sandbox environment, use caution when sending requests that delete contacts, messages, voicemail, or recordings.
Does API messaging follow the same registration requirements as the apps?
Yes. Business text messaging is subject to the same carrier registration standards regardless of whether messages are sent through the Talkroute apps or the API. For more on improving message deliverability, see our messaging verification resources.
Versioning & Support
What version of the API is current?
The current version of the API uses /v2/ endpoints. The base URL for requests is https://api.talkroute.com/api.
Where can I find the full API reference?
The complete reference, including every endpoint, request and response format, and field-level detail, is available in the API documentation.
How do I get help with the API?
If you have questions or run into an issue, contact our team and we will be glad to help.
Need Help or Ready to Get Started?
Whether you're already using Talkroute or just exploring, we're here to help.