Sign inGet Started

Request conversation authentication

POST
/v1/amb/conversations/{conversation_id}/authentications
curl -X POST "https://us1.platform.bird.com/v1/amb/conversations/{conversation_id}/authentications" \
  -H "Authorization: Bearer $TOKEN"
Réponse202
{
  "id": "amauth_01krdgeqcxet5s7t44vh8rt9mg",
  "conversation_id": "acv_01krdgeqcxet5s7t44vh8rt9mg",
  "provider_id": "aauthp_01krdgeqcxet5s7t44vh8rt9mg",
  "message_id": "amb_01krdgeqcxet5s7t44vh8rt9mg",
  "status": "pending"
}

Sends a native sign-in request to an open conversation whose device advertises AUTH2. The business needs an enabled authentication provider. The request expires after ten minutes. Bird validates the provider's response and waits for confirmation from the originating Messages device before storing the verified identity with the conversation. The customer's tokens are never stored or returned. A new request supersedes an unfinished one in the same conversation, including when the new request then fails to send. Reusing an idempotency key returns the original request. The outcome arrives as a webhook event. Read the request to recover a missing event.

Paramètres

conversation_idstring

Conversation identifier. Starts with acv_.

Contenu de la réponse

id
string
obligatoire
conversation_id
string
obligatoire
provider_id
string
obligatoire
provider_revision
integer
obligatoire

Provider revision used by this attempt.

message_id
nullable string
obligatoire

Authentication message reference, or null before acceptance.

status
string
obligatoire

Progress of an authentication request. Every value except pending and processing is terminal.

  • pending: the sign-in message was accepted and the customer has not finished.
  • processing: the authorization code is being exchanged or Bird is waiting for confirmation from the originating Messages device.
  • succeeded: the identity was validated and the originating Messages device confirmed sign-in.
  • failed: delivery, identity verification or device confirmation failed, or the provider callback was replayed.
  • cancelled: the customer or the provider declined authorization.
  • expired: the request passed its ten-minute lifetime.
  • superseded: a newer request, or a change to the conversation, business or provider, replaced the request.

Possible values: pending, processing, succeeded, failed, cancelled, expired, superseded

created_at
string
obligatoire

When the attempt was created.

expires_at
string
obligatoire

When this attempt expires.

completed_at
string

When the attempt reached a terminal outcome.

failure_code
string

Why the request did not succeed. Contains no provider response or credentials.

  • authentication_expired: ten minutes passed. Request a new sign-in.
  • new_authentication: a newer request replaced this one.
  • conversation_closed and conversation_changed: the conversation closed or reopened. Wait for the customer to write again.
  • configuration_changed: the provider settings changed or the business was disconnected.
  • user_cancelled, apple_authentication_cancel: the customer declined.
  • provider_rejected, token_exchange_failed, identity_verification_failed: the provider response could not be accepted. Check the provider settings, then request a new sign-in.
  • processing_interrupted: the exchange or device confirmation did not finish within one minute. Ask the customer to sign in again and return to Messages.
  • apple_authentication_failure: the Messages device reported a failed sign-in. Request a new sign-in.
  • authentication_replayed: the provider callback was used more than once. Request a new sign-in.
  • message_submission_failed, message_failed: the sign-in message could not be sent.

Other values are message delivery reasons passed through unchanged.

identity
object

Validated identity claims. Verification does not create a persistent login session or grant access to customer systems.

Afficher les attributs enfants
identity.issuer
string
obligatoire

Issuer that verified the identity.

identity.subject
string
obligatoire

Provider-issued user identifier. Not necessarily your CRM customer ID.

identity.name
string

Name supplied by the provider when name collection is enabled.

identity.email
string

Email supplied by the provider when email collection is enabled.

identity.email_verified
boolean

Whether the provider verified this email address.

identity.authenticated_at
string

When the provider says the user authenticated. May precede this verification.

identity.verified_at
string
obligatoire

When Bird completed identity validation and confirmed the originating Messages conversation.

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.