What’s new in the REST API v2?
The new REST API includes major improvements:
- ✅ RESTful design with predictable, resource-oriented URLs
- ✅ Standard HTTP verbs (GET, POST, DELETE, etc.)
- ✅ Clean JSON request/response formats
- ✅ Consistent object schemas aligned with Callr Actions
- ✅ Authentication with API keys via standard headers
- ✅ Full OpenAPI 3.1 support — autocompletion in Postman, Swagger, Insomnia, etc.
- ✅ Simplified number ordering
No more cryptic area code IDs — just use simple query parameters like:prefix
(e.g.,+33
)area
(e.g.,paris
orlyon
)
Attention
Make sure you read Introduction and REST API v2 is Here!
🪨 Rosetta Stone
JSON-RPC | REST API v2 |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
📌 Migration Notes
-
hash
is nowsid
Unique IDs previously namedhash
(e.g.ABCDEF12
) are now referred to assid
in the REST API. They use the same value, but in lowercase (abcdef12
). -
DID
is nowPhone number
-
Phone numbers no longer have a unique ID distinct from the number itself
For example, to manage+33199001020
, simply callPATCH /numbers/+33199001020
. No morehash
to remember! -
Constant values are now lowercase
Enum values (likesms.status
) are now lowercase:SENT
→sent
,FAILED
→failed
, etc. -
Only Callr Actions are supported
REST API v2 only supports scenarios built with Callr Actions (formerly called apps). If you were using legacy apps likeCALLTRACKING10
,CLICKTOCALL10
, orREALTIME10
, you must migrate to Callr Actions. -
Date format changed to RFC 3339
JSON-RPC used:YYYY-MM-DD HH:MM:SS.sss
REST API uses:YYYY-MM-DDTHH:MM:SS.sssZ
(ISO 8601 / RFC 3339, section 5.6) -
Jobs are now called Tasks
JSON-RPC "jobs" are now referred to as tasks in REST v2. See the/tasks
endpoint for details. -
Media library items are now called Audio Files
Tags are no longer supported. -
No official SDKs (yet)
We currently do not provide SDKs for the REST API. You can:- Use our OpenAPI spec to generate your own SDKs
- Or call the REST endpoints directly with any HTTP client
❓ FAQ
Is there a 1:1 feature mapping between theJSON-RPC
and REST
APIs?
JSON-RPC
and REST
APIs?No, and that’s intentional.
The REST API was designed to be simpler and more consistent — not a direct mirror of the JSON-RPC structure.
- We’ve removed some legacy fields (like
hash
identifiers for phone numbers) - Methods like number ordering have been greatly streamlined
- Dates are now consistently formatted using RFC 3339 (
YYYY-MM-DDTHH:MM:SSZ
) - Several feature names and parameters have been renamed for clarity
The result is a more modern, predictable, and human-friendly API.
Are "real-time" (REALTIME10) apps deprecated?
Yes. Real-time apps are deprecated and replaced by Callr Actions.