Get participant by ID

GET

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

Retrieve a single conversation participant

Cuerpo de la respuesta

avatarUrl

string

contact

object

Mostrar atributos secundarios

contact.identifierKey

string

obligatorio

contact.identifierValue

string

obligatorio

contact.platformAddress

string

contact.platformAddressSelector

string

conversationId

string

createdAt

string

displayName

string

obligatorio

resourceUri

string

status

string

Possible values: invited, pending, active, inactive

type

string

obligatorio

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

updatedAt

string

Ejemplo de código

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

Examples

Ejemplo de código

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"

Ejemplo de código

{
  "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"
  }
}