RCS Senders

List all senders in project
GA

Request

Returns a paginated list of senders for the specified project. If no page token is supplied then the first 50 will be returned.

Security

BasicAuth and BearerAuth and OAuth2Production

Path

projectIdstringrequired

The unique ID of the project. You can find this on the Sinch Dashboard.

Query

pageTokenstring

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

pageSizenumber, [ 1 .. 100 ]

The page size requested.

filterConversationApiAppIdstring

Optional query for sender by Conversation API app id.

filterSenderIdsstring

Optional query for sender by sender ids.

filterSenderNamestringdeprecated

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

filterStatesArray of strings(RcsSenderStatesEnum)

Optionally query for sender by states.

Items Enum:"DRAFT""IN_PROGRESS""IN_TEST""LAUNCHED""LAUNCHING""PREPARING_LAUNCH""UNLAUNCHED""UNKNOWN"

searchstring

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

sortColumnstring(RcsSenderSortColumnsEnum)

Optional query for sender sort column.

Enum:"CREATED""MODIFIED""NAME""STATE"

sortDirectionstring(RcsSortDirectionsEnum)

Optional query for sender sort direction.

Enum:"ASC""DESC"

curl -i -X GET \
  -u '<username>:<password>' \
  'https://provisioning.api.sinch.com/v1/projects/{projectId}/rcs/senders?pageToken=string&pageSize=1&filterConversationApiAppId=string&filterSenderIds=string&filterSenderName=string&filterStates=DRAFT&search=string&sortColumn=CREATED&sortDirection=ASC' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List of senders

Bodyapplication/json

totalSizenumberrequired

Total size of the entries matching the search query.

pageSizenumberrequired

Requested size of the page.

sendersArray of objects(RcsSenderDto)required

List of senders.

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.

Response

Response with senders.

{
  "totalSize": 2,
  "pageSize": 50,
  "senders": [
    { … },
    { … }
  ]
}