Skip to content

OpenBack API V4

OpenBack Enterprise API for Smart Notifications

Version: 1.0

Security


apiKeyHeader

apiKey API Key
Name Ocp-Apim-Subscription-Key
In header

apiKeyQuery

apiKey API Key
Name subscription-key
In query

Report

/v4/report/getAppsByClientId


Method Type: POST

Endpoint URL: /report/getAppsByClientId

Description: Get All App Report Details from Client ID

Parameters

Name Located in Description Required Schema
reportRequestDto body ReportRequestDto No ReportRequestDto

Responses

Code Description Schema
200 OK MessageReportResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto

/v4/report/getAppByAppCode


Method Type: POST

Endpoint URL: /report/getAppByAppCode

Description: Get All App Report Details from Sdk AppCode

Parameters

Name Located in Description Required Schema
reportRequestDto body ReportRequestDto No ReportRequestDto

Responses

Code Description Schema
200 OK AppReportResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto

/v4/report/getGoalByGoalCode


Method Type: POST

Endpoint URL: /report/getGoalByGoalCode

Description: Get a Goal Summary Report by Goal Code

Parameters

Name Located in Description Required Schema
reportRequestDto body Report Request DTO No ReportRequestDto

Responses

Code Description Schema
200 OK GoalReportResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto

/v4/report/getTrackingIds


Method Type: GET

Endpoint URL: /report/getTrackingIds

Description: /report/getTrackingIds

Parameters

Name Located in Description Required Schema
clientKey query Client Key Yes string
clientId query Format - int64. Client Id Yes integer
sdkAppCode query App Code Yes string

Responses

Code Description Schema
200 OK TrackingIdResponseDto
400 BadRequest BasicResponseDto
401 Unauthorized BasicResponseDto
403 Forbidden BasicResponseDto

Message

/v4/message/get


Method Type: GET

Endpoint URL: /message/get

Description: Get Message Details By Client Message Id

Parameters

Name Located in Description Required Schema
clientKey query OpenBack Client Key Yes string
clientId query Format - int64. Client ID Yes integer
clientMessageId query Format - int64. Client Message ID Yes integer

Responses

Code Description Schema
200 OK MessageResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto

/v4/message/getByAppCode


Method Type: GET

Endpoint URL: /message/getByAppCode

Description: Get list of message by App Code

Parameters

Name Located in Description Required Schema
clientKey query OpenBack API Key Yes string
clientId query Format - int64. Client ID Yes integer
appCode query App Code Yes string

Responses

Code Description Schema
200 OK MessageResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto

/v4/message/update


Method Type: POST

Endpoint URL: /message/update

Description: Update existing message details

Parameters

Name Located in Description Required Schema
messageDetailsDto body MessageDetailsDto No MessageDetailsDto

Responses

Code Description Schema
200 OK BasicResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto

/v4/message/create


Method Type: PUT

Endpoint URL: /message/create

Description: Create message details

Parameters

Name Located in Description Required Schema
messageDetailsDto body Message Details DTO No MessageDetailsDto

Responses

Code Description Schema
200 OK BasicResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto

/v4/message/createBatchMessage


Method Type: PUT

Endpoint URL: /message/createBatchMessage

Description: Create a batch message for individual users from existing message templates

Parameters

Name Located in Description Required Schema
messageBatchDto body No MessageBatchDto

Responses

Code Description Schema
200 OK BasicResponseDto
400 BadRequest BasicResponseDto
401 Unauthorized BasicResponseDto
403 Forbidden BasicResponseDto

MessageGroup

/v4/messageGroup/get


Method Type: GET

Endpoint URL: /messageGroup/get

Description: Get Message Group By Message Group ID

Parameters

Name Located in Description Required Schema
clientKey query Client Key Yes string
clientId query Format - int64. Client ID Yes integer
messageGroupId query Format - int64. Message Group Id Yes integer

Responses

Code Description Schema
200 OK MessageGroupResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto

/v4/messageGroup/getByAppCode


Method Type: GET

Endpoint URL: /messageGroup/getByAppCode

Description: Get all message groups details by app code

Parameters

Name Located in Description Required Schema
clientKey query OpenBack Client Key Yes string
clientId query Format - int64. Client ID Yes integer
appCode query Unique App Code Yes string

Responses

Code Description Schema
200 OK MessageGroupResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto

/v4/messageGroup/update


Method Type: POST

Endpoint URL: /messageGroup/update

Description: Update message group details

Parameters

Name Located in Description Required Schema
messageGroupInfoDto body Message Group Details No MessageGroupInfoDto

Responses

Code Description Schema
200 OK BasicResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto

/v4/messageGroup/create


Method Type: PUT

Endpoint URL: /messageGroup/create

Description: Create a message group.

Parameters

Name Located in Description Required Schema
messageGroupInfoDto body group No MessageGroupInfoDto

Responses

Code Description Schema
200 OK BasicResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto

/v4/report/getMessagesByClientId


Method Type: POST

Endpoint URL: /report/getMessagesByClientId

Description: Get All Message Summary Reports By Client ID

Parameters

Name Located in Description Required Schema
reportRequestDto body ReportRequestDto No ReportRequestDto

Responses

Code Description Schema
200 OK MessageReportResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto

/v4/report/getMessagesByAppCode


Method Type: POST

Endpoint URL: /report/getMessageByAppCode

Description: Get All Message Summary Reports from Sdk App Code

Parameters

Name Located in Description Required Schema
reportRequestDto body ReportRequestDto No ReportRequestDto

Responses

Code Description Schema
200 OK MessageReportResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto

/v4/report/getMessageByMessageGroupId


Method Type: POST

Endpoint URL: /report/getMessageByMessageGroupId

Description: Get a Message Summary Report from Message Group ID

Parameters

Name Located in Description Required Schema
reportRequestDto body Report Request DTO No ReportRequestDto

Responses

Code Description Schema
200 OK MessageReportResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto

/v4/report/getMessageByClientMessageId


Method Type: POST

Endpoint URL: /report/getMessageByClientMessageId

Description: Get a Message Summary Report by Client Message ID

Parameters

Name Located in Description Required Schema
reportRequestDto body Report Request DTO No ReportRequestDto

Responses

Code Description Schema
200 OK MessageReportResponseDto
400 BadRequest BasicResponseDto
404 NotFound BasicResponseDto