getChatCredentials

POST public/getChatCredentials

Returns the credentials the SC//AcuVigil mobile app uses to start a chat session with Scale Computing Support, along with your name and company.

Important: The response contains secret credentials. Don't log, share, or store them.

Request syntax

curl https://apiv2.acumera.net/public/getChatCredentials \
  --cookie av_session.txt

The username, password, and tfa_token parameters are also accepted, and are required only if the client hasn't already signed in with login. See Getting started with the SC//AcuVigil API.

Request parameters

This function takes no parameters of its own.

Response syntax

{
    "success": "string",
    "data": {
        "chat_credentials": {
            "key_id": "string",
            "secret_key": "string",
            "contact_flow_id": "string",
            "instance_id": "string",
            "region": "string",
            "username": "string",
            "company": "string"
        }
    }
}

Response parameters

If the call succeeds, success is "1" and the following data is returned. All values are strings.

Field Description
chat_credentials.key_id The access key ID for the chat service.
chat_credentials.secret_key The secret key for the chat service.
chat_credentials.contact_flow_id The ID of the chat contact flow.
chat_credentials.instance_id The ID of the chat service instance.
chat_credentials.region The chat service region, for example us-east-1.
chat_credentials.username Your name, as shown to Support in the chat.
chat_credentials.company Your company's name.

Errors

If the call fails, success is "0", and returnCode and returnMessage describe the problem. The HTTP status is still 200.

Return code Message Cause
CHAT_CREDENTIALS_NOT_FOUND One or more of the chat credentials could not be found. A credential isn't configured on the server. Contact Scale Computing Support.
INVALID_LOGIN We were unable to log you in. Make sure you entered the correct username, password and 2FA code. You haven't signed in, your session has ended, or the credentials sent with the call are wrong.

Examples

Example: Get the chat credentials

curl https://apiv2.acumera.net/public/getChatCredentials \
  --cookie av_session.txt

Response (values replaced with placeholders):

{
    "success": "1",
    "data": {
        "chat_credentials": {
            "key_id": "<key_id>",
            "secret_key": "<secret_key>",
            "contact_flow_id": "<contact_flow_id>",
            "instance_id": "<instance_id>",
            "region": "us-east-1",
            "username": "Pat Example",
            "company": "Example Company"
        }
    }
}