latestOpenAPI 3.1.02026-08-18893023.3 MB

c78a716de420

RCS Senders

List all senders in project

Returns a paginated list of senders for the specified project. If no page token is supplied then the first `50` will be returned.
get/v1/projects/{projectId}/rcs/senders

Path parameters

projectIdstring required

The unique ID of the project. You can find this on the <a href="https://dashboard.sinch.com/">Sinch Dashboard</a>.

Query parameters

pageTokenstring

The page token if retrieving the next page from a previous query.

pageSizenumber

The page size requested.

filterConversationApiAppIdstring

Optional query for sender by Conversation API app id.

filterSenderIdsstring

Optional query for sender by sender ids.

filterSenderNamestring

Optional query for sender by name. Use the search parameter instead

filterStatesstring[]

Optionally query for sender by states.

searchstring

Search term to filter senders (partial match, case-insensitive).

sortColumn'CREATED' | 'MODIFIED' | 'NAME' | 'STATE'

Optional query for sender sort column.

sortDirection'ASC' | 'DESC'

Optional query for sender sort direction.

Response

List of senders

totalSizenumber required

Total size of the entries matching the search query.

pageSizenumber required

Requested size of the page.

previousPageTokenstring

Encoded token to use in list request to fetch previous batch of entries.

nextPageTokenstring

Encoded token to use in list request to fetch next batch of entries.