Optional. The unique identifier of this participant. Format:projects/<Project ID>/locations/<Location
ID>/conversations/<Conversation ID>/participants/<Participant ID>.
Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.
sipRecordingMediaLabel
string
Optional. Label applied to streams representing this participant in SIPREC XML metadata and SDP. This is used to assign transcriptions from that media stream to this participant. This field can be updated.
obfuscatedExternalUserId
string
Optional. Obfuscated user id that should be associated with the created participant.
You can specify a user id as follows:
If you set this field inCreateParticipantRequestorUpdateParticipantRequest, Dialogflow adds the obfuscated user id with the participant.
Dialogflow returns an error if you try to add a user id for a non-END_USERparticipant.
Dialogflow uses this user id for billing and measurement purposes. For example, Dialogflow determines whether a user in one conversation returned in a later conversation.
Note:
Please never pass raw user ids to Dialogflow. Always obfuscate your user id first.
Dialogflow only accepts a UTF-8 encoded string, e.g., a hex digest of a hash function like SHA-512.
The length of the user id must be <= 256 characters.
documentsMetadataFilters
map (key: string, value: string)
Optional. Key-value filters on the metadata of documents returned by article suggestion. If specified, article suggestion only returns suggested documents that match all filters in theirDocument.metadata. Multiple values for a metadata key should be concatenated by comma. For example, filters to match all documents that have 'US' or 'CA' in their market metadata values and 'agent' in their user metadata values will be
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eParticipant\u003c/code\u003e resource represents individuals or entities, such as human agents, virtual agents, or end-users, involved in a conversation.\u003c/p\u003e\n"],["\u003cp\u003eA participant's role in the conversation is defined by an immutable \u003ccode\u003erole\u003c/code\u003e field, which can be \u003ccode\u003eHUMAN_AGENT\u003c/code\u003e, \u003ccode\u003eAUTOMATED_AGENT\u003c/code\u003e, or \u003ccode\u003eEND_USER\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe JSON representation of a \u003ccode\u003eParticipant\u003c/code\u003e includes fields like \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003erole\u003c/code\u003e, \u003ccode\u003esipRecordingMediaLabel\u003c/code\u003e, \u003ccode\u003eobfuscatedExternalUserId\u003c/code\u003e, and \u003ccode\u003edocumentsMetadataFilters\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eobfuscatedExternalUserId\u003c/code\u003e is an optional field used to associate an obfuscated user ID with a participant for billing and measurement purposes, requiring a UTF-8 encoded string up to 256 characters.\u003c/p\u003e\n"],["\u003cp\u003eThere are five main methods associated with the participant resource: \u003ccode\u003eanalyzeContent\u003c/code\u003e, \u003ccode\u003ecreate\u003c/code\u003e, \u003ccode\u003eget\u003c/code\u003e, \u003ccode\u003elist\u003c/code\u003e, and \u003ccode\u003epatch\u003c/code\u003e, which perform operations such as adding messages, creating participants, retrieving participants, listing all participants and updating them, respectively.\u003c/p\u003e\n"]]],[],null,["# REST Resource: projects.conversations.participants\n\n- [Resource: Participant](#Participant)\n - [JSON representation](#Participant.SCHEMA_REPRESENTATION)\n - [Role](#Participant.Role)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Participant\n---------------------\n\nRepresents a conversation participant (human agent, virtual agent, end-user).\n\n### Role\n\nEnumeration of the roles a participant can play in a conversation."]]
