Connect an agent and a contact on one phone call, started by your own software. Aloware dials both sides (the two legs) and joins them, so nobody has to dial by hand.
Method: POST
Auth: your account API token, sent in the body as api_token
Format: JSON in, JSON out
Agent side: a user (user_id plus user_phone_number) or an inbox (ring_group_id)
Contact side:contact_phone_number or contact_id
Billed: Calls started through the API count as automated, paid usage under Aloware's billing terms.
Where teams use it
Automated outbound calling in a call center
Hook the API into your call center software and let it place the calls. Agents get connected to customers without dialing, which saves time on every call, and you can still track call data such as duration and outcome for reporting.
Appointment reminders
Businesses that run on bookings, such as medical clinics or salons, can link the API to their scheduling software and call customers as an appointment gets close. A pre-recorded message plays, so fewer people miss appointments and staff stop making reminder calls themselves.
Those are two examples. The Two-Legged Call API fits any workflow where an agent and a contact need to be put on a direct call automatically.
Endpoint
POST /api/v1/webhook/two-legged-call
Fields
Required
api_token
Your Aloware account API token.
user_id or ring_group_id
Either the ID of the user or the inbox involved in the call.
contact_phone_number or contact_id
The phone number or ID of the contact you want to establish the call with.
line_phone_number or line_id
The phone number or ID of the Aloware line to initiate the call from.
Optional
user_phone_number
The phone number of the user if user_id is selected.
The call couldn't start. The errors object lists each field that is missing or wrong.
{
"message": "The given data was invalid.",
"errors": {
"contact_phone_number": [
"The contact_phone_number field is required when contact_id is empty."
],
"contact_id": [
"The contact_id field is required when contact_phone_number is empty."
],
"line_phone_number": [
"The line_phone_number field is required when line_id is empty."
],
"line_id": [
"The line_id field is required when line_phone_number is empty."
],
"user_id": [
"The user_id field is required."
]
}
}
