outbound-calls

Create Public Outbound Call

Request an outbound call using the authenticated organization's triage agent. Requires outbound voice enabled and configured outbound telephony. Repeat the same dedup_key to retrieve the same order, not place another call. 202 acknowledges the order, not connection to the recipient; poll GET for its status. reason: at most 2,000 characters; dedup_key: at most 200; language: at most 35. Oversized strings and unknown fields return 422. case_data is limited to 4,096 bytes of compact UTF-8 JSON (unescaped Unicode); exceeding that limit returns 400. Invalid requests do not create or enqueue a call.

post/public/v1/outbound-calls

Request

  • Base URL: https://api.gurusup.com
  • URL: https://api.gurusup.com/public/v1/outbound-calls
  • Auth: API key in header x-api-key

Request body

recipient_e164string required

Recipient phone number in E.164 format, e.g. +34600111222.

reasonstring required

Purpose of the call. Maximum 2,000 characters.

dedup_keystring required

Non-blank idempotency key scoped to the organization. Maximum 200 characters.

case_dataobject

Initial case context. Maximum 4,096 bytes of compact UTF-8 JSON (unescaped Unicode).

languagestring nullable

Optional initial language, e.g. es or es-ES. Maximum 35 characters.

Example request

{
  "case_data": {
    "order_reference": "SUP-42"
  },
  "dedup_key": "delivery-SUP-42",
  "language": "es",
  "reason": "Confirm the delivery date for order SUP-42",
  "recipient_e164": "+34600111222"
}

Response

Successful Response

order_idstring required
status'pending' | 'calling' | 'in_progress' | 'completed' | 'failed' | 'cancelled' | 'expired' | 'blocked' | 'unknown' required

pending: waiting to be processed (not a queue-delivery guarantee); calling: connecting; in_progress: phone connection active, human answer not yet confirmed; completed: call ended; failed: unsuccessful; cancelled: cancelled before calling; expired: validity elapsed; blocked: another unfinished order prevents this call; unknown: call outcome cannot yet be confirmed, do not automatically place another call.

Changes

No recorded changes to this operation across all 1 revision of this API.