Has Pending Dialogue

This method is used to know if there is any pending dialogue active at any moment for an user. It should always be called before performing any steps of voice process.

Has Pending Dialogue

GET https://api.biometrid.com/api/1.1/users/:userId/voice/is-pending

Check if User has already an active dialogue.

Path Parameters

Name	Type	Description
userId	string	BiometrID user ID

Headers

Name	Type	Description
x-biometrid-key	string	Application client key.
x-biometrid-secret	string	Application client secret.

200 Success types

HTTP/1.1 200 OK

//Has Pending Dialogue
{
    "status": true,
    "data": {
      "dialogueId": "e99766b5-9b28-4f0e-99dc-30eaa5b4c33d",
      "promptCode": "0653",
      "promptCodeText": "zero six five three"
    }
}
//No Pending Dialogue
{
    "status": true,
}

400 Missing Headers

HTTP/1.1 400 Bad Request

{
    "status": false,
    "data": {
        "message": "AUTHENTICATION_HEADERS_MISSING"
    }
}

401 Invalid Headers.

HTTP/1.1 401 Unauthorized

{
    "status": false,
    "data": {
        "message": "INVALID_AUTHENTICATION_HEADERS"
    }
}

402 Request Limit Reached for Client Plan.

HTTP/1.1 402 Payment Required

{
    "status": false,
    "data": {
        "message": "REQUEST_LIMIT_REACHED"
    }
}

404 Not found types

HTTP/1.1 404 Not Found

//User's id not exists in biometrid environment.
{
    "status": false,
    "data": {
        "message": "USERID_NOT_EXISTS"
    }
}
// Client not found by given key.
{
    "status": false,
    "data": {
        "message": "CLIENT_NOT_FOUND/CHECK_AUTHENTICATION_HEADERS"
    }
}