com.twilio.rest.proxy.v1.service.session

Class ParticipantCreator

java.lang.Object

com.twilio.base.Creator<Participant>

com.twilio.rest.proxy.v1.service.session.ParticipantCreator

public class ParticipantCreator
extends Creator<Participant>

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Constructor Summary

Constructors

Constructor and Description
ParticipantCreator(String pathServiceSid, String pathSessionSid, String identifier) Construct a new ParticipantCreator.

Method Summary

Modifier and Type	Method and Description
Participant	create(TwilioRestClient client) Make the request to the Twilio API to perform the create.
ParticipantCreator	setFailOnParticipantConflict(Boolean failOnParticipantConflict) [Experimental] For accounts with the ProxyAllowParticipantConflict account flag, setting to true enables per-request opt-in to allowing Proxy to reject a Participant create request that could cause the same Identifier/ProxyIdentifier pair to be active in multiple Sessions.
ParticipantCreator	setFriendlyName(String friendlyName) The string that you assigned to describe the participant.
ParticipantCreator	setProxyIdentifier(String proxyIdentifier) The proxy phone number to use for the Participant.
ParticipantCreator	setProxyIdentifierSid(String proxyIdentifierSid) The SID of the Proxy Identifier to assign to the Participant..

Methods inherited from class com.twilio.base.Creator

create, createAsync, createAsync

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParticipantCreator

public ParticipantCreator(String pathServiceSid,
                          String pathSessionSid,
                          String identifier)

Construct a new ParticipantCreator.

Parameters:

pathServiceSid - The SID of the parent Service resource

pathSessionSid - The SID of the parent Session resource

identifier - The phone number of the Participant

Method Detail

setFriendlyName

public ParticipantCreator setFriendlyName(String friendlyName)

The string that you assigned to describe the participant. This value must be 255 characters or fewer. **This value should not have PII.**.

Parameters:

friendlyName - The string that you assigned to describe the participant

Returns:

this

setProxyIdentifier

public ParticipantCreator setProxyIdentifier(String proxyIdentifier)

The proxy phone number to use for the Participant. If not specified, Proxy will select a number from the pool..

Parameters:

proxyIdentifier - The proxy phone number to use for the Participant

Returns:

this

setProxyIdentifierSid

public ParticipantCreator setProxyIdentifierSid(String proxyIdentifierSid)

The SID of the Proxy Identifier to assign to the Participant..

Parameters:

proxyIdentifierSid - The Proxy Identifier Sid

Returns:

this

setFailOnParticipantConflict

public ParticipantCreator setFailOnParticipantConflict(Boolean failOnParticipantConflict)

[Experimental] For accounts with the ProxyAllowParticipantConflict account flag, setting to true enables per-request opt-in to allowing Proxy to reject a Participant create request that could cause the same Identifier/ProxyIdentifier pair to be active in multiple Sessions. Depending on the context, this could be a 409 error (Twilio error code 80623) or a 400 error (Twilio error code 80604). If not provided, requests will be allowed to succeed and a Debugger notification (80802) will be emitted. Having multiple, active Participants with the same Identifier/ProxyIdentifier pair causes calls and messages from affected Participants to be routed incorrectly. Please note, the default behavior for accounts without the ProxyAllowParticipantConflict flag is to reject the request as described. This will eventually be the default for all accounts..

Parameters:

failOnParticipantConflict - An experimental parameter to override the ProxyAllowParticipantConflict account flag on a per-request basis.

Returns:

this

create

public Participant create(TwilioRestClient client)

Make the request to the Twilio API to perform the create.

Specified by:

create in class Creator<Participant>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Created Participant