• 5.19 • 5.2 • 5.3 • 5.8

Get Agent Profile Photo

Get Agent Profile Photo downloads a profile photo of the specified agent.

URL

http[s]://{host:port}/clientweb/api/v1/chats/{chatId}/profilephotos/{partyId}

Method

GET

Request Body

The request body is the party ID of the agent participating in the current chat session.

Note: The party ID is provided with the chat event (polled at https://{host:port}/clientweb/api/v1/chats/{chatId}/events?tenantUrl={tenantUrl}). For example, you can see party_ID in the event message for chat_session_party_joined.

Example

partyId={party id of agent for current chat session} chatId=current chat id

Returns

200 – File content type

Errors

401 – Unauthorized

404 – Not found

< Previous | Next >< Previous | Next >