Get Trackers

🚧

In Beta

This feature is in Beta. If you have questions or comments, email [email protected].

We're working to improve this content! :star:

You can GET Trackers in the following ways:

You can also create, view, edit and delete Trackers via the Trackers Management UI. To access this feature, log in to theSymbl Platform and see the Management API.

GET All Trackers

Use this request to get all the Trackers registered to the Management API for your account.

API Endpoint

GET https://api.symbl.ai/v1/manage/trackers

Request Headers

Header NameRequiredDescription
AuthorizationYesBearer <token> The token you get after completing the Authenticate process.
Content-TypeYesapplication/json
x-api-keyNoDEPRECATED.

Response Body

{
    "tracker": {
        "id": "4476908732794496",
        "name": "Voice Message",
        "vocabulary": [
              "At the tone please record",
            "Please leave message after tome",
            "Call back during normal office hours",
            "If you are calling about an emergency",
            "Our offices are currently closed",
            "Our repesentatives are unavailable at this time",
            "Please leave message",
            "start recording message",
            "Begin recording message",
            "sending you to his voicemail",
            "Leave Name and contact info",
            "Leave name and number",
            "I can call after",
            "Leave message with name",
            "leave message with number",
            "press to listen",
            "press to record",
            "press to send",
            "Record your message",
            "Return call ASAP",
            "return your call as soon as possible",
            "get back soon",
            "get back as quickly as possible",
            "Sorry we missed your call",
            "sorry we missed you",
            "You have reached office"
        ]
    }
}

GET Trackers by ID

Use this request to get the Trackers for the given trackerId.

API Endpoint

GET https://api.symbl.ai/v1/manage/tracker/{trackerId}

Request Headers

Header NameRequiredDescription
AuthorizationYesBearer <token> The token you get from our authentication process.
Content-TypeYesapplication/json
x-api-keyNoDEPRECATED.

Request Parameter

The trackerId is the unique identifier of the Trackers to be fetched, and is accepted as a request parameter (path-param).

Response Body

{
    "tracker": {
        "id": "4476908732794496",
        "name": "Promotion Mention",
        "vocabulary": [
            "We have a special promotion going on if you book this before",
            "I can offer you a discount of 10 20 percent you being a new customer for us",
            "We have our month special this month",
            "We have a sale right now on"
        ]
    }
}

Error Codes

If the operation fails, it returns one of the following error codes:

Error CodeDescriptionResolution
404 - Not FoundThe 404 response code specifies that the Tracker with that specific trackerId does not exist.Check the trackerId and ensure that it is valid and exists.
400 - Bad RequestThe 400 response code specifies that the request body or the parameters have incorrect key names or their values have types that are different than the ones expected.Please read the message returned in the response to fix this error.
500 - Internal Server ErrorThe 500 response code specifies that the server failed to handle the request.Please reach out to [email protected] if it persists even after multiple attempts.
502 - Bad GatewayThe 502 response code specifies that the server failed to acknowledge the request. This may happen due to multiple reasons.Please reach out to [email protected] if it persists even after multiple attempts.
504 - Gateway TimeoutThe 504 response code specifies that the server failed to respond within the timeout duration.Please reach out to [email protected] if it persists even after multiple attempts.

Get Trackers by Name

Use this request to get all the Trackers for the given name parameter.

API Endpoint

GET https://api.symbl.ai/v1/manage/trackers?name={trackerName}

Request Headers

Header NameRequiredDescription
AuthorizationYesBearer <token> The token you get after completing the Authenticate process.
Content-TypeYesapplication/json
x-api-keyNoDEPRECATED.

Request Parameters

The following request parameter (query-param) is accepted in the URI:

name- This query parameter specifies the unique name against which the Tracker was created.

🚧

If no query-params are passed, then this API will return all the Trackers available in that account.

Sample Response

trackers is an array of JSON Objects containing a Tracker entity that meets the criteria specified by the query-params.

{
    "trackers": [{
        "id": "4476908732794496",
        "name": "Promotion Mention",
        "vocabulary": [
            "We have a special promotion going on if you book this before",
            "I can offer you a discount of 10 20 percent you being a new customer for us",
            "We have our month special this month",
            "We have a sale right now on"
        ]
    }]
}

Error Codes

If the operation fails, it returns one of the following error codes:

Error CodeDescriptionResolution
400 - Bad RequestThe 400 response code specifies that the request body or the parameters have incorrect key names or their values have types that are different than the ones expected.Please read the message returned in the response to fix this error.
500 - Internal Server ErrorThe 500 response code specifies that the server failed to handle the request.Please reach out to [email protected] if it persists after multiple attempts.
502 - Bad GatewayThe 502 response code specifies that the server failed to acknowledge the request. This may happen due to multiple reasons.Please reach out to [email protected] if it persists even after multiple attempts.
504 - Gateway TimeoutThe 504 response code specifies that the server failed to respond within the timeout duration.Please reach out to [email protected] if it persists even after multiple attempts.