Common API Status Codes in Convoso
| Code | Meaning |
|---|---|
| 200 | Success – request processed correctly. |
| 401 | Unauthorized – missing or invalid token. |
| 403 | Forbidden – token is invalid for the office. |
| 500 | Internal Server Error – failed to process data. |
Common API Terms
|
Term |
Definition |
|
API |
Stands for Application Programming Interface; allows different software systems to communicate with each other. |
|
API Key |
A unique code used to authenticate requests to the API. |
|
Authentication |
Verifying the identity of the user or system making the request (e.g., API key, token). |
|
Authorization |
Determines what a user or system is allowed to do after authentication. |
|
Authorization Header |
The HTTP header used to pass API keys or bearer tokens for secure access. |
|
Call Log API |
(If available) Used to fetch call history data including duration, agent, outcome, etc. |
|
Campaign |
A structured outbound dialing program within Convoso, containing leads and dialing rules. |
|
Compliance API |
Refers to endpoints or integrations ensuring calls comply with TCPA, STIR/SHAKEN, and other regulations. |
|
Contact Center Integration |
External platforms (CRM, DNC provider, etc.) connected via API to sync data and call outcomes. |
|
DELETE |
Used to delete data. |
|
Disposition |
The final outcome of a call (e.g., Sale, No Answer, Callback) — can be posted or retrieved via API. |
|
DNC (Do Not Call) |
Convoso uses API integrations to filter leads against national/state DNC lists automatically. |
|
Endpoint |
A specific URL path where an API can access a resource (e.g., /users, /leads). |
|
GET |
Used to retrieve data from the server. |
|
Header |
Metadata included in an API request or response (e.g., authorization info, content type). |
|
HTTP Method |
Defines the action to take. Common ones are: GET, POST, PUT, DELETE. |
|
JSON |
JavaScript Object Notation; a common data format used in API requests/responses. |
|
Latency |
The time it takes for an API to process a request and send a response. |
|
leadData |
JSON object containing lead information (e.g., name, phone, email) passed via API or webhook. |
|
leadID |
Unique identifier for a specific lead in Convoso's database. |
|
List ID |
Identifier that groups a set of leads under a specific campaign. |
|
officeAcronym |
A short identifier for the office (or tenant) using the API — often required in authorization. |
|
Payload |
The data sent in a request (usually in POST or PUT). |
|
POST |
Used to send new data to the server. |
|
POST /convoso-webhook |
The primary webhook endpoint used to send lead data to integrated platforms. |
|
PUT |
Used to update existing data. |
|
Query Parameter |
Extra data added to the URL to filter or modify the request (e.g., ?status=active). |
|
Rate Limit |
The maximum number of API requests allowed in a given time period to prevent system overload. |
|
Request |
The message sent by a client to an API asking for some action (e.g., GET data). |
|
Response |
The message the API sends back after processing a request, usually with data or a status. |
|
Response Code |
Status code returned by the API indicating success or error (200, 401, 403, 500, etc.). |
|
REST API |
A common API design style using standard HTTP methods. |
|
RND Scrubbing |
API-enabled filtering of reassigned numbers (Reassigned Numbers Database compliance). |
|
Status Code |
A number returned in a response indicating the result (e.g., 200 OK, 404 Not Found). |
|
Token |
A string of characters used to identify and authenticate a user/session. |
|
Webhook |
A POST endpoint (/convoso-webhook) used by Convoso to send real-time data (like lead info) to external systems. |
Convoso Post URLs
-
https://api.convoso.com/v1/leads/insert
-
https://api.convoso.com/v1/log/retrieve
-
https://api.convoso.com/v1/campaigns/search
-
https://api.convoso.com/v1/leads/update
-
https://api.convoso.com/v1/leads/delete
-
https://api.convoso.com/v1/leads/search
-
https://api.convoso.com/v1/lists/insert
-
https://api.convoso.com/v1/lists/update
-
https://api.convoso.com/v1/lists/delete
-
https://api.convoso.com/v1/lists/search
-
https://api.safesoft.io/v1/users/recordings
-
https://api.convoso.com/v1/campaigns/status
-
https://api.convoso.com/v1/leads/insert
-
https://api.convoso.com/v1/log/retrieve
-
https://api.convoso.com/v1/campaigns/search
-
https://api.convoso.com/v1/leads/update
-
https://api.convoso.com/v1/leads/delete
-
https://api.convoso.com/v1/leads/search
-
https://api.convoso.com/v1/lists/insert
-
https://api.convoso.com/v1/lists/update
-
https://api.convoso.com/v1/lists/delete
-
https://api.convoso.com/v1/lists/search
-
https://api.safesoft.io/v1/users/recordings
-
https://api.convoso.com/v1/campaigns/status