Directly control and create new objects in your Hitrate dialer instance using our APIs.
Automate workflows or extract order or customer data directly to your other platforms with our simple to use APIs.

Authentication

Each request needs to be made with a bearer token.
Tokens can be generated by either admins or users with "manage token" permission in each dialer. The tokens inherit the permissions from the user they belong to. One token per user per dialer.

Error Codes

200 – success
Request made correctly
400 - bad request
Your request body has some form of syntax error in it
401- unauthenticated
Missing token or request is outside the scope for your token.
Tokens match your permissions as a user in each dialer instance, if this is the error contact your dialer admin.
404 – page not found
URL is wrong or API is deprecated, refer to the documentation.

413 - request entity too large

The dialer has a request limit on 10MB payloads, if larger split up the requests.

500 – server error
Server is offline or errors with the request, such as missing mandatory field.

URL structure

Each dialer has its own instance, meaning a unique url. To access your specific dialer you need to change the start of the request to match whichever dialer the API should be directed towards, followed with ":3007".
Example: the dialer "demodailer" requests would start with "https://demodailer.hitrate.tech:3007".

For the examples we'll be using the "QA" dialer,