Get a support inbox
Gets one SupportInbox; protected identities require a separately audited reveal.
This method is not served on the public API.
api.sylphx.comdoes not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.
Gets one SupportInbox; protected identities require a separately audited reveal.
Not available yet. This method answers 501 with the problem code UNIMPLEMENTED.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/support_inboxes/support-inbox - Scope
notify:support:read - Effect
read— nothing is written. - Collection support_inboxes
Request
| Field | Type | What it is |
|---|---|---|
name | string | Canonical resource name. Required. |
Response
| Field | Type | What it is |
|---|---|---|
name | string | The canonical resource name. |
uid | string | Immutable platform identity; never substitutes for a source case ID. Output only. |
meta | ResourceMeta | Labels, annotations, display name, timestamps and strong ETag. |
locales | string[] | Supported BCP 47 locales; the language is still decided per message. Required. |
channels | SupportChannel[] | Verified links to existing transport resources, not transport credentials. |
policy | string | Tenant-policy API resource; rule tables and remedy budgets remain there. Required. |
intake_bound | duration | Maximum allowed delay from a received event to committed case intake. Required. |
ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
SupportChannel
| Field | Type | What it is |
|---|---|---|
id | string | Stable channel-link identity within the inbox. Required. |
uid | string | Immutable source identity of this configuration record. |
display_name | string | Human-readable channel label. |
transport | string | Public transport resource or authenticated ingress endpoint. Required. |
allowed_origins | string[] | Exact canonical origins; an empty list never means wildcard browser access. |
anonymous_allowed | bool | Whether platform-issued anonymous sessions may enter this browser channel. |
enabled | bool | Whether new intake is admitted; disabling never drops accepted events. |
labels | map<string, string> | Source metadata, not an authorization mechanism. |
annotations | map<string, string> | Unindexed source annotations. |
version | int64 | Configuration revision, independent of case and delivery versions. |
create_time | timestamp | Original creation time. |
update_time | timestamp | Last configuration change. |
kind | string | Channel class: browser, email, social or product; credentials stay external. |
Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.INVALID_FIELD— A field failed validation.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.ETAG_MISMATCH— The etag sent does not match the Resource's current etag.INVALID_STATE— The Resource is in a state that forbids the call.UNAVAILABLE— The Resource store, the owning service's backend, or the key verifier's snapshot is unavailable; retry after Retry-After.UNIMPLEMENTED— The path or method is not served (yet) at this version.
Every error arrives in the body Errors describes.
Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/support_inboxes/support-inbox" \
-H "Authorization: Bearer $SYLPHX_API_KEY"