List the recipients in the current conversation in the order in which the messages are sent.
This function is only available on context of type
SINGLE_CONVERSATION
.
function listRecipients(paginationToken?: string, cancelToken?: CancelToken): Promise<PaginatedResults<Recipient>>
Parameters
Parameter | Type | Description |
---|---|---|
paginationToken | PaginationToken | Token of the requested page. If omitted, will return the first page of results. |
cancelToken | Cancel token | Token to cancel the request. |
Return Value
The function returns a promise that resolves with a paginated list of recipients in the order in which the messages are sent.
Property | Type | Description |
---|---|---|
nextPageToken | PaginationToken (optional) | Token to access the next page of results, if any. |
results | Array of Recipient | List of recipients in the order in which the messages are sent. |