GET /voice/healthcheck

voice health check endpoint.

This endpoint will return a simple json including service status and API version.

Responses

200

OK.
Hide response attributes Show response attributes object
- status string
  
  Values are Running, Warnings, or Critical.
- message string
  
  Health check message. Returns OK if running without problem.
- version string
  
  API version.
400

This response means that server could not understand the request due to invalid syntax.
Hide response attributes Show response attributes object
- status string Required
  
  HTTP response status code.
- detail string Required
  
  Message explaining the issue.
- title string
  
  Error message title.
- type string
  
  Error type.
401

Authentication is needed to get requested response. This is similar to 403, but in this case, authentication is possible.
Hide response attributes Show response attributes object
- status string Required
  
  HTTP response status code.
- detail string Required
  
  Message explaining the issue.
- title string
  
  Error message title.
- type string
  
  Error type.
403

Client does not have access rights to the content so server is rejecting to give proper response.
Hide response attributes Show response attributes object
- status string Required
  
  HTTP response status code.
- detail string Required
  
  Message explaining the issue.
- title string
  
  Error message title.
- type string
  
  Error type.
405

The request method is known by the server but has been disabled and cannot be used.
Hide response attributes Show response attributes object
- status string Required
  
  HTTP response status code.
- detail string Required
  
  Message explaining the issue.
- title string
  
  Error message title.
- type string
  
  Error type.
429

The user has sent too many requests in a given amount of time ("rate limiting").
Hide response attributes Show response attributes object
- status string Required
  
  HTTP response status code.
- detail string Required
  
  Message explaining the issue.
- title string
  
  Error message title.
- type string
  
  Error type.
500

The server has encountered a situation it doesn't know how to handle.
Hide response attributes Show response attributes object
- status string Required
  
  HTTP response status code.
- detail string Required
  
  Message explaining the issue.
- title string
  
  Error message title.
- type string
  
  Error type.

curl \
 -X GET https://api.amerandish.com/v1/voice/healthcheck \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "status": "Running",
  "message": "OK.",
  "version": "1.0.5"
}

Response examples (200)

{
  "status": "Running",
  "message": "string",
  "version": "string"
}

Response examples (400)

{
  "code": 400,
  "message": "Bad Request. Invalid JSON object."
}

Response examples (400)

{
  "status": "string",
  "detail": "string",
  "title": "string",
  "type": "string"
}

Response examples (401)

{
  "code": 401,
  "message": "Unautherized. Invalid Authorization Token."
}

Response examples (401)

{
  "status": "string",
  "detail": "string",
  "title": "string",
  "type": "string"
}

Response examples (403)

{
  "code": 403,
  "message": "Forbidden. Do not have access right to resource."
}

Response examples (403)

{
  "status": "string",
  "detail": "string",
  "title": "string",
  "type": "string"
}

Response examples (405)

{
  "code": 405,
  "message": "Method Not Allowed."
}

Response examples (405)

{
  "status": "string",
  "detail": "string",
  "title": "string",
  "type": "string"
}

Response examples (429)

{
  "code": 429,
  "message": "Too Many Requests. Your request is blocked due to exceeding rate limiting."
}

Response examples (429)

{
  "status": "string",
  "detail": "string",
  "title": "string",
  "type": "string"
}

Response examples (500)

{
  "code": 500,
  "message": "Internal Server Error. Please retry later."
}

Response examples (500)

{
  "status": "string",
  "detail": "string",
  "title": "string",
  "type": "string"
}