This page covers the mechanism behind Yourcall’s outbound API.
An outbound call can either triggered instantly (ASAP) or at a specific time (SCHEDULED).
You need to specify a phone number to contact (phoneNumberTo) in international format.
You also must provide the agentId which is the Id of the AI agent you created for your use case, as well as some additional information on the person you are calling firstName, lastName and title.
We are allowing a metadata field which is a string that will be added to the prompt of our LLM. This metadata can be useful if you want to provide the agent with additional information.
For example, you might want the person being called to verify their address. You can pass that as a metadata. Or you might want the agent to behave differently with this specific user so you could pass something like “Speak in a very formal way” or ***“*Ask them how their dog Oreo is doing”. It’s your opportunity to make the prompt a bit more dynamic !
We do not guarantee any SLAs with outbound calls.
When you trigger or schedule a phone call, it will be put in a queue, which means that depending on the load of our infrastructure, they might be a slight delay for it to be processed.
We observe on average 7 seconds between the moment you send the request and the moment the phone rings.
If no one answers, the call will not be retried. So it’s up to you to then re-submit a request to call the person again at another time.
We might provide you with the opportunity to add a webhook in the future in order to get notified about the status changes of calls.
When the call ends up on voicemail, we cannot guarantee that the Agent won’t hangup straight away. We are working hard to provide you with options around this scenario where the agent would leave a voicemail or hangup straight away depending on what you want it to do. Still, at the moment we observe that the agent detects quite well on its own that it is on voicemail and tends to hang up straight away.