amb-conversations

Send a typing indicator

Sends a typing indicator to the customer's device on this conversation. Send typing_start before the reply it precedes; sending it again before that reply is not meaningful and may be dropped. Apple's own behavior for typing_end sent with no reply following is unproven, so treat it as best-effort. This conversation must be open: the same checks that gate a message on this conversation gate a typing indicator, other than the content checks, since a typing indicator has no content. Apple can still refuse the indicator for this customer: AMBRecipientUnreachable means none of their devices can receive it, and AMBConversationClosed can also mean Apple reports that the customer left the conversation, which then closes when the next message is sent.

post/v1/amb/conversations/{conversation_id}/typing

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/amb/conversations/{conversation_id}/typing
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Headers

Idempotency-Keystring

Client-supplied key. On operations supporting request deduplication, a retained response is replayed for duplicate requests with the same key within the idempotency window (3 hours by default). This protection requires a workspace, organization, or staff-account scope. User-only and unscoped unauthenticated operations, streams, and operations with a separate replay contract do not use this response replay.

On a supported operation, if idempotency protection is unavailable before execution, the API returns 503 IdempotencyUnavailable (E01033) without executing this attempt. Retry with backoff using the same key and request. An operation that takes effect before its response is retained can still execute again on retry.

Two distinct 409 errors signal misuse:

  • request_in_progress (E01004): The same key is currently being processed by a concurrent request. Wait briefly and retry. The lock expires within 30 seconds.
  • idempotency_key_reuse (E01005): The same key has already completed against a different request body or method. Generate a new key.

Recommended key format is <event-type>/<entity-id> (for example welcome-user/usr_abc123).

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Request body

event'typing_start' | 'typing_end' required

The typing signal to send. typing_start tells the customer's device that an operator is composing a reply. typing_end tells it composition stopped without a message following. Apple expects at most one typing_start before the reply it precedes; sending it again before that reply is not meaningful and may be dropped. typing_end's behavior against a live conversation is unproven: the legacy platform's implementation was disabled after it caused issues, so treat it as best-effort.

Response

The typing indicator was sent.

Changes

No recorded changes to this operation across all 2 revisions of this API.