curl -X POST 'https://app.reddy.io/api/v1/call/start' \
-H 'Authorization: Bearer your_api_key' \
-H 'Content-Type: application/json' \
-d '{
"conversation_id": "12345",
"agent_email": "agent@company.com",
"metadata": {
"source": "inbound",
"queue": "support"
}
}'
{
"success": true
}
Call Endpoints
Start Call
Starts a call for a given conversation and agent.
POST
/
api
/
v1
/
call
/
start
curl -X POST 'https://app.reddy.io/api/v1/call/start' \
-H 'Authorization: Bearer your_api_key' \
-H 'Content-Type: application/json' \
-d '{
"conversation_id": "12345",
"agent_email": "agent@company.com",
"metadata": {
"source": "inbound",
"queue": "support"
}
}'
{
"success": true
}
Starts a call for a given conversation and agent.
Conversations are unique by the combination of user and conversation ID together.
This is a beta endpoint and not yet recommended for production use.
Request Body
string
required
The unique identifier for the conversation
string
required
The email address of the agent handling the call. Matched without regard to
capitalisation, so send it exactly as your directory stores it.
object
Additional metadata to associate with the call
Response
boolean
Indicates if the call was successfully started
Error Responses
object
More than one active user in your company has this
agent_email. Reddy will
not choose between them, so the request is rejected and nothing is recorded.
The body carries agent_email and conflicting_user_ids. Merge the duplicate
accounts, then resend.string
Error message when the user does not exist
curl -X POST 'https://app.reddy.io/api/v1/call/start' \
-H 'Authorization: Bearer your_api_key' \
-H 'Content-Type: application/json' \
-d '{
"conversation_id": "12345",
"agent_email": "agent@company.com",
"metadata": {
"source": "inbound",
"queue": "support"
}
}'
{
"success": true
}
Was this page helpful?