com.twilio.sdk

Class TwilioConversationsClient

java.lang.Object

com.twilio.sdk.TwilioClient

com.twilio.sdk.TwilioConversationsClient

public class TwilioConversationsClient
extends TwilioClient

Twilio REST client for Conversations end points

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_VERSION

Constructor Summary

Constructors

Constructor and Description
TwilioConversationsClient(String username, String password)
TwilioConversationsClient(String username, String password, String endpoint)

Method Summary

Modifier and Type	Method and Description
Participant	createParticipant(String conversationSid, Map<String,String> properties) Creates a Participant instance by conversation sid
Participant	disconnectParticipant(String conversationSid, String participantSid) Disconnects a Participant from a Conversation
CompletedConversationsList	getCompletedConversations() Gets a list Completed Conversations List
CompletedConversationsList	getCompletedConversations(Map<String,String> filters) Gets a list of filtered Completed Conversations List
Conversation	getConversation(String conversationSid) Get a Conversation instance by sid
InProgressConversationsList	getInProgressConversations() Gets InProgress Conversations List
InProgressConversationsList	getInProgressConversations(Map<String,String> filters) Gets filtered InProgress Conversations List
Participant	getParticipant(String conversationSid, String participantSid) Get a Participant instance by conversation sid and participant sid
ParticipantList	getParticipants(Map<String,String> filters, String conversationSid) Gets filtered Participant List belonging to a Conversation
ParticipantList	getParticipants(String conversationSid) Gets Participant List by Conversation Sid

Methods inherited from class com.twilio.sdk.TwilioClient

get, getAccountSid, getEndpoint, getHttpClient, getNumRetries, request, request, requestStream, requestStream, safeRequest, safeRequest, setHttpClient, setNumRetries, setRequestAccountSid

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_VERSION

public static final String DEFAULT_VERSION

See Also:

Constant Field Values

Constructor Detail

TwilioConversationsClient

public TwilioConversationsClient(String username,
                                 String password)

TwilioConversationsClient

public TwilioConversationsClient(String username,
                                 String password,
                                 String endpoint)

Method Detail

getConversation

public Conversation getConversation(String conversationSid)

Get a Conversation instance by sid

Parameters:

conversationSid - The 34 character sid starting with CV

Returns:

the Conversation

getCompletedConversations

public CompletedConversationsList getCompletedConversations()

Gets a list Completed Conversations List

Returns:

list of Completed Conversation

getCompletedConversations

public CompletedConversationsList getCompletedConversations(Map<String,String> filters)

Gets a list of filtered Completed Conversations List

Parameters:

filters - the query parameters

Returns:

list of Completed Conversations

getInProgressConversations

public InProgressConversationsList getInProgressConversations()

Gets InProgress Conversations List

Returns:

list of In Progress Conversations

getInProgressConversations

public InProgressConversationsList getInProgressConversations(Map<String,String> filters)

Gets filtered InProgress Conversations List

Parameters:

filters - the query parameters

Returns:

list of In Progress Conversations

createParticipant

public Participant createParticipant(String conversationSid,
                                     Map<String,String> properties)
                              throws TwilioRestException

Creates a Participant instance by conversation sid

Parameters:

conversationSid - the conversation sid

properties - Participant properties

Returns:

a Participant

Throws:

TwilioRestException

getParticipant

public Participant getParticipant(String conversationSid,
                                  String participantSid)

Get a Participant instance by conversation sid and participant sid

Parameters:

conversationSid - the 34 character sid starting with CV

participantSid - the 34 character sid starting with PA

Returns:

the Participant

disconnectParticipant

public Participant disconnectParticipant(String conversationSid,
                                         String participantSid)
                                  throws TwilioRestException

Disconnects a Participant from a Conversation

Parameters:

conversationSid - the conversation sid the Participant was part of

participantSid - the participant sid

Returns:

Participant the disconnected participant

Throws:

TwilioRestException

getParticipants

public ParticipantList getParticipants(String conversationSid)

Gets Participant List by Conversation Sid

Parameters:

conversationSid - the convesation sid

Returns:

list of Participants

getParticipants

public ParticipantList getParticipants(Map<String,String> filters,
                                       String conversationSid)

Gets filtered Participant List belonging to a Conversation

Parameters:

filters - the query parameters

conversationSid - the conversation sid

Returns:

List of Participants