callbotagent.aiDokumentacja
v1 · Contract draft
ENPL
Otwórz panel
Zapowiedź

Dokumentacja poglądowa. Interfejs jest w trakcie udostępniania — przykłady mają charakter zapowiedzi, a finalne wartości potwierdzimy przy starcie.

Wyniki, rozmowy, final order snapshot

Stan zamówienia opisują trzy niezależne wymiary. Nie mieszaj ich: jedno zamówienie może być completed (przetwarzanie), a jednocześnie mieć business_outcome: declined.

Base URL: https://api.callbotagent.ai/api/v1/commerce. Żądania podpisujesz HMAC (X-CBA-Key-Id, X-CBA-Timestamp, X-CBA-Signature). Scope orders:read.

Trzy wymiary statusu

processing_state — gdzie rekord jest w potoku:

Wartość Znaczenie
received → validated → qualified | rejected przyjęcie, walidacja, kwalifikacja
scheduled → queued → calling harmonogram i wykonanie kontaktu
completed | failed | cancelled stany końcowe

call_disposition — jak zakończyła się próba połączenia:

Wartość Znaczenie
not_started / answered brak próby / odebrano
no_answer / busy / voicemail brak odbioru / zajęte / poczta głosowa
provider_failed / unknown błąd realizacji połączenia / nieokreślone

business_outcome — rezultat biznesowy rozmowy:

Wartość Znaczenie
unknown / confirmed / modified nieokreślone / potwierdzone / zmienione
declined / follow_up / invalid_contact odmowa / kontakt ponowny / błędny kontakt

Wynik i final order snapshot

GET /orders/{externalOrderId}/result

Zwraca final_order_snapshot: utrwalone pozycje/warianty, ilości, ceny, walutę, sumę, flagę potwierdzenia oraz powód (reason).

curl https://api.callbotagent.ai/api/v1/commerce/orders/RB-5510/result \
  -H "X-CBA-Key-Id: cba_test_••••••••" \
  -H "X-CBA-Timestamp: 2026-07-10T12:34:56Z" \
  -H "X-CBA-Signature: v1=9f8c2a...e41"
# 200 OK → {
#   "external_order_id": "RB-5510", "business_outcome": "confirmed",
#   "final_order_snapshot": {
#     "items": [{ "external_variant_id": "SKU-ROUTER-01-BLK", "quantity": 1, "price": "349.00" }],
#     "currency": "PLN", "total": "349.00", "confirmed": true, "reason": null }
# }

GET /orders/{externalOrderId}/calls

Zwraca listę prób kontaktu z ich call_disposition i znacznikami czasu (RFC 3339 UTC):

{
  "external_order_id": "RB-5510",
  "calls": [
    { "attempt": 1, "call_disposition": "no_answer", "started_at": "2026-07-14T09:03:11Z" },
    { "attempt": 2, "call_disposition": "answered",  "started_at": "2026-07-14T14:20:05Z" }
  ]
}

Wynik możesz pobierać (pull) tym endpointem albo otrzymywać przez push — zobacz ./webhooks.md. Powiązane operacje na zamówieniu: ./orders.md.