API Endpoints

OpenBack Enterprise API for Dynamic Notifications

Version: 1.0

Security


apiKeyHeader

apiKeyAPI Key
NameOcp-Apim-Subscription-Key
Inheader

apiKeyQuery

apiKeyAPI Key
Namesubscription-key
Inquery

Report

/v4/report/getAppsByClientId


Method Type: POST

Endpoint URL: /report/getAppsByClientId

Description: Get All App Report Details from Client ID

Parameters

NameLocated inDescriptionRequiredSchema
reportRequestDtobodyReportRequestDtoNoReportRequestDto

Responses

CodeDescriptionSchema
200OKMessageReportResponseDto
400BadRequestBasicResponseDto
404NotFoundBasicResponseDto

/v4/report/getAppByAppCode


Method Type: POST

Endpoint URL: /report/getAppByAppCode

Description: Get All App Report Details from Sdk AppCode

Parameters

NameLocated inDescriptionRequiredSchema
reportRequestDtobodyReportRequestDtoNoReportRequestDto

Responses

CodeDescriptionSchema
200OKAppReportResponseDto
400BadRequestBasicResponseDto
404NotFoundBasicResponseDto

/v4/report/getGoalByGoalCode


Method Type: POST

Endpoint URL: /report/getGoalByGoalCode

Description: Get a Goal Summary Report by Goal Code

Parameters

NameLocated inDescriptionRequiredSchema
reportRequestDtobodyReport Request DTONoReportRequestDto

Responses

CodeDescriptionSchema
200OKGoalReportResponseDto
400BadRequestBasicResponseDto
404NotFoundBasicResponseDto

Message

/v4/message/get


Method Type: GET

Endpoint URL: /message/get

Description: Get Message Details By Client Message Id

Parameters

NameLocated inDescriptionRequiredSchema
clientKeyqueryOpenBack Client KeyYesstring
clientIdqueryFormat - int64. Client IDYesinteger
clientMessageIdqueryFormat - int64. Client Message IDYesinteger

Responses

CodeDescriptionSchema
200OKMessageResponseDto
400BadRequestBasicResponseDto
404NotFoundBasicResponseDto

/v4/message/getByAppCode


Method Type: GET

Endpoint URL: /message/getByAppCode

Description: Get list of message by App Code

Parameters

NameLocated inDescriptionRequiredSchema
clientKeyqueryOpenBack API KeyYesstring
clientIdqueryFormat - int64. Client IDYesinteger
appCodequeryApp CodeYesstring

Responses

CodeDescriptionSchema
200OKMessageResponseDto
400BadRequestBasicResponseDto
404NotFoundBasicResponseDto

/v4/message/update


Method Type: POST

Endpoint URL: /message/update

Description: Update existing message details

Parameters

NameLocated inDescriptionRequiredSchema
messageDetailsDtobodyMessageDetailsDtoNoMessageDetailsDto

Responses

CodeDescriptionSchema
200OKBasicResponseDto
400BadRequestBasicResponseDto
404NotFoundBasicResponseDto

/v4/message/create


Method Type: PUT

Endpoint URL: /message/create

Description: Create message details

Parameters

NameLocated inDescriptionRequiredSchema
messageDetailsDtobodyMessage Details DTONoMessageDetailsDto

Responses

CodeDescriptionSchema
200OKBasicResponseDto
400BadRequestBasicResponseDto
404NotFoundBasicResponseDto

/v4/message/createBatchMessage


Method Type: PUT

Endpoint URL: /message/createBatchMessage

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

Parameters

NameLocated inDescriptionRequiredSchema
messageBatchDtobodyNoMessageBatchDto

Responses

CodeDescriptionSchema
200OKBasicResponseDto
400BadRequestBasicResponseDto
401UnauthorizedBasicResponseDto
403ForbiddenBasicResponseDto

MessageGroup

/v4/messageGroup/get


Method Type: GET

Endpoint URL: /messageGroup/get

Description: Get Message Group By Message Group ID

Parameters

NameLocated inDescriptionRequiredSchema
clientKeyqueryClient KeyYesstring
clientIdqueryFormat - int64. Client IDYesinteger
messageGroupIdqueryFormat - int64. Message Group IdYesinteger

Responses

CodeDescriptionSchema
200OKMessageGroupResponseDto
400BadRequestBasicResponseDto
404NotFoundBasicResponseDto

/v4/messageGroup/getByAppCode


Method Type: GET

Endpoint URL: /messageGroup/getByAppCode

Description: Get all message groups details by app code

Parameters

NameLocated inDescriptionRequiredSchema
clientKeyqueryOpenBack Client KeyYesstring
clientIdqueryFormat - int64. Client IDYesinteger
appCodequeryUnique App CodeYesstring

Responses

CodeDescriptionSchema
200OKMessageGroupResponseDto
400BadRequestBasicResponseDto
404NotFoundBasicResponseDto

/v4/messageGroup/update


Method Type: POST

Endpoint URL: /messageGroup/update

Description: Update message group details

Parameters

NameLocated inDescriptionRequiredSchema
messageGroupInfoDtobodyMessage Group DetailsNoMessageGroupInfoDto

Responses

CodeDescriptionSchema
200OKBasicResponseDto
400BadRequestBasicResponseDto
404NotFoundBasicResponseDto

/v4/messageGroup/create


Method Type: PUT

Endpoint URL: /messageGroup/create

Description: Create a message group.

Parameters

NameLocated inDescriptionRequiredSchema
messageGroupInfoDtobodygroupNoMessageGroupInfoDto

Responses

CodeDescriptionSchema
200OKBasicResponseDto
400BadRequestBasicResponseDto
404NotFoundBasicResponseDto

/v4/report/getMessagesByClientId


Method Type: POST

Endpoint URL: /report/getMessagesByClientId

Description: Get All Message Summary Reports By Client ID

Parameters

NameLocated inDescriptionRequiredSchema
reportRequestDtobodyReportRequestDtoNoReportRequestDto

Responses

CodeDescriptionSchema
200OKMessageReportResponseDto
400BadRequestBasicResponseDto
404NotFoundBasicResponseDto

/v4/report/getMessagesByAppCode


Method Type: POST

Endpoint URL: /report/getMessageByAppCode

Description: Get All Message Summary Reports from Sdk App Code

Parameters

NameLocated inDescriptionRequiredSchema
reportRequestDtobodyReportRequestDtoNoReportRequestDto

Responses

CodeDescriptionSchema
200OKMessageReportResponseDto
400BadRequestBasicResponseDto
404NotFoundBasicResponseDto

/v4/report/getMessageByMessageGroupId


Method Type: POST

Endpoint URL: /report/getMessageByMessageGroupId

Description: Get a Message Summary Report from Message Group ID

Parameters

NameLocated inDescriptionRequiredSchema
reportRequestDtobodyReport Request DTONoReportRequestDto

Responses

CodeDescriptionSchema
200OKMessageReportResponseDto
400BadRequestBasicResponseDto
404NotFoundBasicResponseDto

/v4/report/getMessageByClientMessageId


Method Type: POST

Endpoint URL: /report/getMessageByClientMessageId

Description: Get a Message Summary Report by Client Message ID

Parameters

NameLocated inDescriptionRequiredSchema
reportRequestDtobodyReport Request DTONoReportRequestDto

Responses

CodeDescriptionSchema
200OKMessageReportResponseDto
400BadRequestBasicResponseDto
404NotFoundBasicResponseDto