Get help request status

GET /internal/admin/comms/v1/help/request/status

Operation id: get__internal_admin_comms_v1_help_request_status

Description

This API retrieves the status of a help request for a specified tenant and user.

Below is the map of status codes and what they represent:

1 - Quota Met
3 - Escalated
4 - Stopped
5 - No Ring
6 - Completed By Escalation

Tags: Assistant

Parameters

Query parameters

Name	Type	Required	Description
`has_active_help_request`	boolean	No	Flag to check if the user has an active help request
`help_id`	integer (int64)	No	Help request ID
`tenant_id`	string	Yes	Tenant ID of the request
`user_login`	string	Yes	UserLogin

Security

BearerAuth (http / bearer)
- Enter the token

Responses

`200` — Status retrieved successfully

Content type: application/json

`400` — Bad request

Content type: application/json

`404` — Not Found

Content type: application/json

`500` — Internal Server Error

Content type: application/json

Response models

`200` — Status retrieved successfully

Content type: application/json

Schema

Property	Type	Required	Description
`helpId`	integer (int64)	No
`user_logins`	array	No
`isQuotaReached`	boolean	No
`status`	integer (int16)	No
`quota`	integer (int16)	No
`respondents`	integer (int16)	No
`rejections`	integer (int16)	No
`responders_user_logins`	array	No
`responses`	array	No

{
  "type": "object",
  "properties": {
    "helpId": {
      "type": "integer",
      "format": "int64"
    },
    "user_logins": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "isQuotaReached": {
      "type": "boolean"
    },
    "status": {
      "type": "integer",
      "format": "int16"
    },
    "quota": {
      "type": "integer",
      "format": "int16"
    },
    "respondents": {
      "type": "integer",
      "format": "int16"
    },
    "rejections": {
      "type": "integer",
      "format": "int16"
    },
    "responders_user_logins": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "responses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "userLogin": {
            "type": "string"
          },
          "timestamp": {
            "type": "integer",
            "format": "int64",
            "description": "Unix timestamp of when the response was recorded"
          }
        }
      }
    }
  }
}

`400` — Bad request

Content type: application/json

Schema

Property	Type	Required	Description
`code`	integer	No
`errors`	array	No

{
  "type": "object",
  "properties": {
    "code": {
      "type": "integer"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

`404` — Not Found

Content type: application/json

Schema

Property	Type	Required	Description
`code`	integer	No
`errors`	array	No

{
  "type": "object",
  "properties": {
    "code": {
      "type": "integer"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

`500` — Internal Server Error

Content type: application/json

Schema

Property	Type	Required	Description
`code`	integer	No
`errors`	array	No

{
  "type": "object",
  "properties": {
    "code": {
      "type": "integer"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}