Set overflow forward number
Set the agent's OVERFLOW FORWARD number, where a caller is transferred when every voice runtime machine is already on a call (the fleet answers and forwards instead of leaving them ringing). Resolution at call time: this number first, then the transfer_to_human destination, then an apology + hangup. Pass number: null to clear it. Agent-scoped (applies across versions), stored on agents.settings.overflowForwardNumber. Use when the user says 'send overflow calls to my mobile', 'set the busy fallback number', or 'clear the overflow number'.
Authorization
bearerAuth A personal access token from Settings > API tokens.
In: header
Header Parameters
A key you choose, such as a UUID, that makes this POST safe to retry. Within 24 hours the same key and request answers with the first successful answer and runs nothing, the same key with a different request answers 422 idempotency_key_reused, and a key whose request is still running answers 409 idempotency_key_in_use. A failed request keeps nothing, so the same key runs it again.
1 <= length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/operations/set_overflow_forward_number" \ -H "Content-Type: application/json" \ -d '{ "number": "string", "agent": "string" }'{}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}Set outbound greeting POST
Pin the greeting spoken word-for-word when the agent makes the call: outbound campaign calls and lead callbacks that don't set their own opener. Distinct from set_greeting_message, which is the opener for calls the agent ANSWERS, and set_returning_greeting, for recognised returning callers. A campaign's or callback trigger's own opening line still wins. Use when the operator says things like 'when we call people, say...', 'set the outbound greeting', or 'how should the agent open a callback'. Pass null to clear it, so the agent writes the opening line itself from the brief. Applies to the current draft version.
Set post-call analysis POST
Set this version's summary instructions for the post-call analysis. The analysis still writes a one-sentence summary of every call; these instructions say what else it must cover. Post-call functions read the summary as {{call_summary}}. Up to 1000 characters. The on/off switch for the whole analysis is agent-wide and is not set here. Works on a draft, or on a published latest version when you pass draftFrom.