Base URL: https://demo-api.incodesmile.com — Incode demo environment
Use this endpoint to check user's position in waiting queue. Once the index in the response is 0, users can connect to the conference call. Use endpoint Get position in queue. Once the index becomes 0, the customer can connect to the interview. Call Connect to fetch connection data.
Path & query parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
queueName |
query | string | The name of the queue the user is entering in case a conference call will be used. If not set, the default queue will be used. Possible values: aristotle, buddha, confucius, diogenes. Same value for queueName needs to be used across all requests in one onboarding session. | |
api-version |
header | string | yes |
Responses
200
OK
Response body (application/json):
| Field | Type | Required | Description |
|---|---|---|---|
index |
integer (int32) |
400
Bad Request
Response body (application/json):
| Field | Type | Required | Description |
|---|---|---|---|
timestamp |
integer (int64) | UTC timestamp in milliseconds | |
status |
integer (int32) | Custom error code or HTTP status code | |
error |
string | HTTP status error | |
message |
string | Custom error message | |
path |
string | Endpoint path | |
details |
object | Custom error details |