Agents
Calls
Phone Number Management (U.S. Only)
Campaigns
Call (Deprecated)
curl --request GET \
--url https://my.cald.ai/client/api/v1/agents \
--header 'Authorization: <api-key>'{
"agents": [
{
"name": "<string>",
"maxCallDuration": 10,
"recordingSettings": {
"enable": false
},
"instructions": "<string>",
"greeting": "<string>",
"transferSettings": {
"enable": false,
"rule": "always",
"phoneNumber": "<string>"
},
"machineSettings": {
"enable": false
},
"voicemailSettings": {
"enable": false,
"voicemail": "<string>"
},
"webhookSettings": {
"enable": false,
"url": "<string>"
},
"smsSettings": {
"enable": false,
"rule": "always",
"message": "<string>"
},
"voice": "standard_male",
"agentId": "<string>"
}
]
}Get Agents
Get a list of available agents that you can use for the call.
curl --request GET \
--url https://my.cald.ai/client/api/v1/agents \
--header 'Authorization: <api-key>'{
"agents": [
{
"name": "<string>",
"maxCallDuration": 10,
"recordingSettings": {
"enable": false
},
"instructions": "<string>",
"greeting": "<string>",
"transferSettings": {
"enable": false,
"rule": "always",
"phoneNumber": "<string>"
},
"machineSettings": {
"enable": false
},
"voicemailSettings": {
"enable": false,
"voicemail": "<string>"
},
"webhookSettings": {
"enable": false,
"url": "<string>"
},
"smsSettings": {
"enable": false,
"rule": "always",
"message": "<string>"
},
"voice": "standard_male",
"agentId": "<string>"
}
]
}Authorizations
Your API key, e.g. caldLiveDe39a3accb206dd615f30d118e519df0
Response
List of available agents
Show child attributes
Show child attributes
The name given to the agent in the MyCald Dashboard
The maximum duration of a call in minutes, between 1 and 60
The instructions for the agent, for example, Hi, convince the prospect to buy the product
The greeting for the agent, for example, Hi there!
Show child attributes
Show child attributes
Whether to enable transfer of the calls
The rule to use for transferring the calls, for example: transfer the call if the prospect would like to have more information or the AI is unable to answer the question
The phone number to transfer the call to
Show child attributes
Show child attributes
Whether to enable saying a voicemail message if the call is picked up by a voicemail
The message to say, only available if enable is set to true, for example, Hi, this is the AI assistant calling on behalf of John Smith. I was curious if you would be interested in our product. Please call us back at 123-456-7890.
Show child attributes
Show child attributes
Whether to enable sending of a webhook to a URL of your choice when the call is completed
The webhook needs to be an HTTP or HTTPS callback URL. Upon completion of the call, we'll transmit the call ID, transcript, etc. to this URL. This feature is beneficial for receiving real-time notifications at the conclusion of calls.
Show child attributes
Show child attributes
Whether to enable sending of text messages
The rule to use for sending text messages, for example: send a text message if the prospect is interested in the offer
The message to send, only available if enable is set to true, for example, Hi, please visit our website at https://www.example.com for more information.`
The voice ID of the voice to use for the agent, for example, standard_male
The agent ID of the agent