listRecipients

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

ParameterTypeDescription
paginationTokenPaginationTokenToken of the requested page. If omitted, will return the first page of results.
cancelTokenCancel tokenToken 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.

PropertyTypeDescription
nextPageTokenPaginationToken (optional)Token to access the next page of results, if any.
resultsArray of RecipientList of recipients in the order in which the messages are sent.