Package com.ringcentral.paths.restapi.account.messagethreads

Class Index

java.lang.Object

com.ringcentral.paths.restapi.account.messagethreads.Index

public class Index
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Index	parent
RestClient	rc
String	threadId

Constructor Summary

Constructors

Constructor	Description
Index(Index parent, String threadId)

Method Summary

Modifier and Type	Method	Description
Index	assign()
String	delete()	Deletes a message thread by IDs.
Index	entries()
MessageThread	get()	Returns a message thread by ID.
MessageThreadList	list()
MessageThreadList	list(MthListThreadsParameters queryParams)	Returns a paginated list of message threads for the specified account according to the specified criteria.
Index	messages()
Index	notes()
Index	notes(String noteId)
String	path()
String	path(Boolean withParameter)
Index	resolve()
Index	sync()

Methods inherited from class java.lang.Object

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

Field Details

rc

public RestClient rc

parent

public Index parent

threadId

public String threadId

Constructor Details

Index

public Index(Index parent,
 String threadId)

Method Details

path

public String path(Boolean withParameter)

path

public String path()

list

public MessageThreadList list(MthListThreadsParameters queryParams)
                       throws RestException,
IOException

Returns a paginated list of message threads for the specified account according to the specified criteria.

Different filters are combined with logical "AND", different values for the same filter (if supported) are combined with logical "OR".

Only threads that accessible for a current authorized user are returned. The records are sorted by `creationTime` in ascending order.

HTTP Method: get Endpoint: /restapi/{apiVersion}/account/{accountId}/message-threads Rate Limit Group: Medium App Permission: SMS

Throws:

RestException

IOException

list

public MessageThreadList list()
                       throws RestException,
IOException

Throws:

RestException

IOException

get

public MessageThread get()
                  throws RestException,
IOException

Returns a message thread by ID.

API returns a 403 error if the current user does not have access to the given thread.

HTTP Method: get Endpoint: /restapi/{apiVersion}/account/{accountId}/message-threads/{threadId} Rate Limit Group: Medium App Permission: SMS

Throws:

RestException

IOException

delete

public String delete()
              throws RestException,
IOException

Deletes a message thread by IDs.

Technically this operation just sets thread's `availability` to `Deleted`. API returns a 403 error if the current user does not have access to the given thread.

Once the thread is deleted its `assignee` attribute is cleared automatically.

HTTP Method: delete Endpoint: /restapi/{apiVersion}/account/{accountId}/message-threads/{threadId} Rate Limit Group: Medium App Permission: SMS

Throws:

RestException

IOException

sync

public Index sync()

notes

public Index notes()

notes

public Index notes(String noteId)

assign

public Index assign()

entries

public Index entries()

resolve

public Index resolve()

messages

public Index messages()