Get participant by ID

GET

/workspaces/{workspaceId}/conversations/{conversationId}/participants/{conversationParticipantId}

Retrieve a single conversation participant

Payload della risposta

avatarUrl

string

contact

object

Mostra attributi secondari

contact.identifierKey

string

obbligatorio

contact.identifierValue

string

obbligatorio

contact.platformAddress

string

contact.platformAddressSelector

string

conversationId

string

createdAt

string

displayName

string

obbligatorio

resourceUri

string

status

string

Possible values: invited, pending, active, inactive

type

string

obbligatorio

Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation

updatedAt

string

Esempio di codice

curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/conversations/{conversationId}/participants/{conversationParticipantId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Examples

Esempio di codice

curl "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/conversations/02ec2ac2-ebec-42d3-a5f4-e6f3a9edf418/participants/8f0b5377-2edc-4116-a8e8-6a475f245a04" \
-H "Authorization: AccessKey abcd"

Esempio di codice

{
  "id": "8f0b5377-2edc-4116-a8e8-6a475f245a04",
  "type": "contact",
  "status": "active",
  "displayName": "John Doe",
  "avatarUrl": "",
  "contact": {
    "identifierKey": "emailaddress",
    "identifierValue": "john.doe@bird.com",
    "platformAddress": "john.doe@bird.com"
  }
}