Interface AddVoiceParticipantResponse

Response returned when adding a voice participant to a task.

interface AddVoiceParticipantResponse {
    pendingParticipantResponse: {
        channelSid: string;
        interactionSid: string;
        mediaProperties: null | MediaProperties;
        sid: string;
    };
    waitForParticipantToSettle: Promise<TaskParticipant>;
}

Properties

pendingParticipantResponse: {
    channelSid: string;
    interactionSid: string;
    mediaProperties: null | MediaProperties;
    sid: string;
}

Response for the adding participant request.

channelSid: string
The channel sid of the channel where the participant is added
interactionSid: string
The identifier of the interaction where the participant is added
mediaProperties: null | MediaProperties
Optional media properties of the participant
sid: string
The identifier of the participant who is added to the channel

waitForParticipantToSettle: Promise<TaskParticipant>

Wait for the success or failure event for adding a Participant.