Path parameters

• ConversationSid string Required

  The unique ID of the Conversation for this participant.

• Sid string Required

  A 34 character string that uniquely identifies this resource. Alternatively, you can pass a Participant's identity rather than the SID.

Responses

• 200 application/json

  OK

  Hide headers attributes Show headers attributes

  • Access-Control-Allow-Origin string

    Specify the origin(s) allowed to access the resource

  • Access-Control-Allow-Methods string

    Specify the HTTP methods allowed when accessing the resource

  • Access-Control-Allow-Headers string

    Specify the headers allowed when accessing the resource

  • Access-Control-Allow-Credentials boolean

    Indicates whether the browser should include credentials

  • Access-Control-Expose-Headers string

    Headers exposed to the client

  Hide response attributes Show response attributes object

  • account_sid string | null

    The unique ID of the Account responsible for this participant.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

  • conversation_sid string | null

    The unique ID of the Conversation for this participant.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CH[0-9a-fA-F]{32}$.

  • sid string | null

    A 34 character string that uniquely identifies this resource.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^MB[0-9a-fA-F]{32}$.

  • identity string | null

    A unique string identifier for the conversation participant as Conversation User. This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters.

  • attributes string | null

    An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set "{}" will be returned.

  • messaging_binding

    Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant.

  • role_sid string | null

    The SID of a conversation-level Role to assign to the participant.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^RL[0-9a-fA-F]{32}$.

  • date_created string(date-time) | null

    The date that this resource was created.

  • date_updated string(date-time) | null

    The date that this resource was last updated.

  • url string(uri) | null

    An absolute API resource URL for this participant.

  • last_read_message_index integer | null

    Index of last “read” message in the Conversation for the Participant.

  • last_read_timestamp string | null

    Timestamp of last “read” message in the Conversation for the Participant.