List your active voice agents
curl --request GET \
--url https://api.voice.mergenlab.ai/v1/agents \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.voice.mergenlab.ai/v1/agents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.voice.mergenlab.ai/v1/agents"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)[
{
"id": "agt_credfin_dpd_8_30_m",
"name": "Credfin DPD 8-30 (male)",
"language": "Hindi",
"required_variables": [
"case_id",
"borrower_first_name",
"call_stage",
"emi_amount",
"original_due_date",
"dpd",
"late_charges",
"total_overdue",
"max_ptp_days",
"min_part_payment"
],
"optional_variables": [
"lender_name",
"customer_salutation",
"preferred_language",
"support_email_spoken",
"user_name",
"attempt_number",
"prior_ptp_status",
"legal_stage",
"settlement_eligible",
"last_outcome",
"last_contact_date",
"prior_ptp_date",
"prior_ptp_amount",
"days_to_90",
"settlement_offer",
"customer_care_number",
"due_date",
"agent_name"
],
"calling_window": {
"start": "08:00",
"end": "19:00",
"timezone": "Asia/Kolkata"
},
"max_attempts": 1
},
{
"id": "agt_credfin_predue_f",
"name": "Credfin pre-due (female)",
"language": "Hindi",
"required_variables": [
"case_id",
"borrower_first_name",
"emi_amount",
"due_date"
],
"optional_variables": [
"lender_name",
"customer_salutation",
"preferred_language",
"support_email_spoken",
"user_name",
"call_stage",
"attempt_number",
"max_ptp_days",
"min_part_payment",
"prior_ptp_status",
"agent_name"
],
"calling_window": {
"start": "08:00",
"end": "19:00",
"timezone": "Asia/Kolkata"
},
"max_attempts": 1
}
]Account
List your active voice agents
Active agents of your account, ordered by id. Not paginated.
GET
/
v1
/
agents
List your active voice agents
curl --request GET \
--url https://api.voice.mergenlab.ai/v1/agents \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.voice.mergenlab.ai/v1/agents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.voice.mergenlab.ai/v1/agents"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)[
{
"id": "agt_credfin_dpd_8_30_m",
"name": "Credfin DPD 8-30 (male)",
"language": "Hindi",
"required_variables": [
"case_id",
"borrower_first_name",
"call_stage",
"emi_amount",
"original_due_date",
"dpd",
"late_charges",
"total_overdue",
"max_ptp_days",
"min_part_payment"
],
"optional_variables": [
"lender_name",
"customer_salutation",
"preferred_language",
"support_email_spoken",
"user_name",
"attempt_number",
"prior_ptp_status",
"legal_stage",
"settlement_eligible",
"last_outcome",
"last_contact_date",
"prior_ptp_date",
"prior_ptp_amount",
"days_to_90",
"settlement_offer",
"customer_care_number",
"due_date",
"agent_name"
],
"calling_window": {
"start": "08:00",
"end": "19:00",
"timezone": "Asia/Kolkata"
},
"max_attempts": 1
},
{
"id": "agt_credfin_predue_f",
"name": "Credfin pre-due (female)",
"language": "Hindi",
"required_variables": [
"case_id",
"borrower_first_name",
"emi_amount",
"due_date"
],
"optional_variables": [
"lender_name",
"customer_salutation",
"preferred_language",
"support_email_spoken",
"user_name",
"call_stage",
"attempt_number",
"max_ptp_days",
"min_part_payment",
"prior_ptp_status",
"agent_name"
],
"calling_window": {
"start": "08:00",
"end": "19:00",
"timezone": "Asia/Kolkata"
},
"max_attempts": 1
}
]Authorizations
Authorization: Bearer vg_live_<32 hex characters>. Keys are issued by Mergen admins and shown once.
Missing or invalid key: 401 unauthorized. Suspended account: 403 tenant_suspended.
Response
The agents.
Example:
"agt_credfin_dpd_8_30_m"
Main language of the agent, for example Hindi.
Variables that must be set for a call (in variables or by the agent's defaults).
Other variables the agent uses; most have defaults.
Hours in which this agent dials (end exclusive; start after end = overnight; equal = always open).
Show child attributes
Show child attributes
Dial attempts per call, including retries on no_answer/busy.
Required range:
x >= 1