<aside> 💡 This page describes the steps to integrate the Toneling API into your platform.

</aside>

1. Getting Started

If you haven’t done so already, the first step is to create a new admin account in the Tonelingo App at https://app.tonelingo.com/sign-up.

Your account then needs to be verified by Speeqo before you can log into the app or start using any features.

2**:** Generating Tokens

GET /reviews/api_token/{api_key}

Parameters

Name Type Description
api_key* string Required. The user's API key to authenticate the request. The api_key provided maybe be found in the settings page.

Headers

Header Value Description
Authorization Bearer <user_token> Required. The user's API token to authenticate the request. This token should be prefixed with Bearer and a space. The <user_token> placeholder should be replaced with the actual api_token provided in the settings page.
Origin <origin_url> Required. This header is used for Cross-Origin Resource Sharing (CORS) purposes. The <origin_url> placeholder should be replaced with the URL set with creating your organisation on the Tonelingo platform.

Responses

Code Description Links
200 Review API token generate success.
Media type application/json

• Example Value | Schema

{ "statusCode": 200, "message": "Success", "errors": [ { "message": "string" } ], "data": { "token": "string" } } | No links | | 401 | Provided token invalid or no token provided. Media type application/json

• Example Value | Schema

{ "statusCode": 401, "message": "UNAUTHORIZED", "errors": [ { "message": "string" } ], "data": {} } | No links | | 500 | Unexpected server error. Media type application/json

• Example Value | Schema

{ "statusCode": 500, "message": "INTERNAL_SERVER_ERROR", "errors": [ { "message": "string" } ], "data": {} } | |

3: Submitting a Recording

POST /reviews/recording

Headers

Header Value Description
Authorization Bearer <user_token> Required. The user's JWT token to authenticate the request. This token should be prefixed with Bearer and a space. The <user_token> placeholder should be replaced with the actual token generated in the previous section .
Origin <origin_url> Required. This header is used for Cross-Origin Resource Sharing (CORS) purposes. The <origin_url> placeholder should be replaced with the URL set with creating your organisation on the Tonelingo platform.

Request body multipart/form-data

email string
name string
anonymousId string
productId string
idSource string
phoneNumber string
purpose* string
questionId string
campaignId string
file* string($binary)
metadata string
country string

Responses