Search
K
Orion-API

Orion Call Center API

v1OAS 3.0

The Orion Call Entry API lets authorized call-center applications search, retrieve, create, and replace customer-service call records. It also provides the caller, call, transaction, and product classifications needed when working with those records.

Every request requires an OAuth bearer token validated by Kong and, when configured, independently by Orion. Orion requires a partyId and verifies that the caller has the appropriate fine-grained access: read access for searches, individual records, and lookup values; write access for creating or replacing records.

Consumers identify the company whose data they are accessing with the X-Client-Code header. The clientCode query parameter remains available only on the two existing GET operations for backward compatibility.

For writes, Orion determines the acting user from the first available valid identity claim in this order: https://api.zinnia.io/email, https://qa.api.zinnia.io/email, https://dev.api.zinnia.io/email, upn, then email. When one of these claims is present, the request body’s userName is ignored. If none of these claims is present, Orion uses the trimmed userName from the request body to identify the caller in machine-to-machine scenarios.

Lookup values are trimmed and matched without regard to letter casing. Orion resolves them to the company’s active canonical values. These names are stable API identifiers, so renaming one is a breaking compatibility change. Duplicate active names indicate invalid company configuration.

Create and replace requests are idempotent for at least 24 hours. Orion compares the company, operation and record identity, actor, submitted fields, resolved lookup values, contracts, and call types; contract and call-type ordering does not affect the comparison. A completed replay returns the original result with X-Idempotent-Replay. Reusing an idempotency key for a different request, or while the original request is still in progress, returns 409 Conflict.

API Base URL
  • Server 1:https://qa.api.zinnia.io
Security
Bearer (http)

Supply an OAuth bearer token obtained from Auth0.

List active call types

Returns active canonical tenant call types, sorted by name, using FGA read authorization. X-Client-Code is required. Names are trimmed and matched case-insensitively by write operations; an unknown/inactive name returns field-specific 400, while duplicate active names return 503 and are logged as a configuration defect. A lookup rename is an API compatibility change.

get
https://qa.api.zinnia.io/callcenter/v1/lookups/call-types

Headers

X-Client-Codestringrequired

Required tenant selector. Trimmed and resolved case-insensitively to a canonical configured tenant before FGA authorization; missing, blank, or unknown values return 400.

Match pattern:^[A-Za-z]{3,4}$

>= 3 characters<= 4 characters

Example:ABCD

Response

OK

LookupResponse

Tenant-scoped active lookup values using canonical compatibility-stable names.

* Additional properties are NOT allowed.
clientCodestring | null

Canonical tenant code selected by X-Client-Code.

itemsarray | null[object]

Active values sorted by name.

* Additional properties are NOT allowed.
Show Child Parameters
get/callcenter/v1/lookups/call-types
 

List active caller types

Returns active canonical tenant caller types, sorted by name, using FGA read authorization. X-Client-Code is required. Names are trimmed and matched case-insensitively by write operations; an unknown/inactive name returns field-specific 400, while duplicate active names return 503 and are logged as a configuration defect. A lookup rename is an API compatibility change.

get
https://qa.api.zinnia.io/callcenter/v1/lookups/caller-types

Headers

X-Client-Codestringrequired

Required tenant selector. Trimmed and resolved case-insensitively to a canonical configured tenant before FGA authorization; missing, blank, or unknown values return 400.

Match pattern:^[A-Za-z]{3,4}$

>= 3 characters<= 4 characters

Example:ABCD

Response

OK

LookupResponse

Tenant-scoped active lookup values using canonical compatibility-stable names.

* Additional properties are NOT allowed.
clientCodestring | null

Canonical tenant code selected by X-Client-Code.

itemsarray | null[object]

Active values sorted by name.

* Additional properties are NOT allowed.
Show Child Parameters
get/callcenter/v1/lookups/caller-types