RCS Accounts

The RCS endpoint offers you a way to manage your RCS accounts.

Lists activities on account Open Beta

Paginated list of activities for account. Ordered from the most recent one to the oldest one.

SecurityBasic or OAuth2.0
Request
path Parameters
projectId
required
string

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

query Parameters
pageToken
string

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

pageSize
number [ 1 .. 100 ]

The page size requested.

Responses
200

Recent activities on account

Response Schema: application/json
totalSize
required
number

Total size of the entries matching the search query.

pageSize
required
number

Requested size of the page.

required
Array of objects (AccountNotificationDto1)
previousPageToken
string

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

nextPageToken
string

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

400

BadRequest

401

Unauthorized

404

NotFound

500

InternalServerError

get/v1/projects/{projectId}/rcs/activities
Request samples 
Response samples 
application/json
Response for all account activities.


{
  • "totalSize": 2,
  • "pageSize": 50,
  • "notifications": [
    • {
      },
    • {
      }
    ]
}
Creates a comment for an account Open Beta 
Creates a comment for an account.


SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
The unique ID of the project. You can find this on the Sinch Dashboard.


 
Request Body schema: application/json
required
Comment data


comment
required
string  [ 1 .. 65535 ] characters 
 
Responses 
201
Created comment for an account.


Response Schema: application/json
type
required
string (CommentTypeEnum) 
 Value: "CREATED"  
comment
required
string
 
created
string
 
400
BadRequest


401
Unauthorized


404
NotFound


500
InternalServerError


Callbacks 
postComment on account
post/v1/projects/{projectId}/rcs/comments
Request samples 
application/json
Example body request to create a comment.


{
  • "comment": "Example comment."
}
Response samples 
application/json
Response when successfully creating a comment.



{
  • "type": "CREATED",
  • "comment": "Example comment",
  • "created": "2023-01-19T13:11:08.204Z"
}
Callback payload samples 
POST: Comment on account
application/json
{
  • "type": "RCS_ACCOUNT_COMMENT_ADDED",
  • "comment": "Example comment"
}
SecurityPrivacyLegal & ComplianceCookie Statement
© 2024 Sinch. All rights reserved.