bcs-notifications-managemet-api-services
home
API INFORMATION
Title: notifications-management-api-services
Version: 1.0.0
Protocols: HTTPS
URI Sandbox: https://notifications-management-api-services-dev.us-e1.cloudhub.io/
URI QA: https://notifications-management-api-services-qa.us-e1.cloudhub.io/
URILive: https://notifications-management-api-services-prod.us-e1.cloudhub.io/
DOWLOAD RAML
DESCRIPTION
This service allows Management of Notifications, which allows the following operations:
Summary
-Send SMS
Path:
POST
/notificationSMSManagement/v1/Accounts:Headers
X-Invoker-BranchId: Office code
X-Invoker-TerminalId: Term code
X-Invoker-Component: Component
X-Invoker-UserIPAddress: Client IP Address
X-Invoker-ServerIPAddress: Server IP Address
X-Invoker-UserMACAddress: Client MAC Address
X-Invoker-ServerMACAddress: Server MAC Address
X-Invoker-ProcessDate: Process date
X-Invoker-TxId: Id TX
X-Invoker-SessionKey: Session key
X-Invoker-Source: Origin
X-Invoker-Country: Country
X-Invoker-ProcessBpmId: ID BPM process
X-Invoker-ProcessId: Process ID
X-Invoker-Network: Net
X-Invoker-subChannel: Subchannel with which the transaction must be registered.
X-Invoker-User: User
X-Invoker-Action: Action
X-Invoker-Destination: Destination
X-Invoker-ModifierUser: Modification user
X-Invoker-ReferencedNumber: Reference number
X-Invoker-RequestNumber: Request number
X-Invoker-CustId: Client code
Headers Security
X-Security-CustLoginIdSi: Used to identify the user who logs in
X-Security-ClientID: The Mule expression to use for obtaining the client ID from
X-Security-ClientSecret: The Mule expression to use for obtaining the client secret from API requests
X-Security-Token: Used to send a valid OAuth 2 access token
Body:
govIssueIdent: Identification given by the local government (Required)
govIssueIdentType: Type of customer identification. (CC, CE, LC, NI, OT, PA or RC)
identSerialNum: Number customer IdentificationdepAcctStmtRec: Contains information of product number.
depAcctId: Accounts Information
- acctId: Accounts numbernotification: Information for Send SMS (Required)
sourceCode: Source
subSourceCode: Secondary source
state: Transaction Status
message: **(Required)**
- desc: SMS message
mobileOperator: Mobile operator to send SMScontactInfo: Contains customer phone information
phoneNum: Customer phone informationExample of Body to Send SMS
{
"govIssueIdent":{
"identSerialNum":"1234567890",
"govIssueIdentType":"CC"
},
"depAcctStmtRec":{
"depAcctId":{
"acctId":"24026781578"
}
},
"notification":{
"sourceCode":"FD",
"subSourceCode":"S07",
"state":"",
"message":{
"desc":"Bienvenido(a) al Banco Caja Social con su Cuentamiga 24026787064, Al recibir su Tarjeta Debito asigne clave en cualquier cajero del Banco"
},
"mobileOperator":"",
"priority":"0"
},
"contactInfo":{
"phoneNum":{
"phone":"3103400745",
"phoneType":"C"
}
}
}Response information:
responseType: Used to return the response
notification: Information of Notification
Example of Body to Response Successfull
{
"notification": {
"sequence": "996697330"
}
}-Send EMail
Path:
POST
/notificationEMAILManagement/v1/AccountsHeaders
X-Invoker-BranchId: Office code
X-Invoker-TerminalId: Term code
X-Invoker-Component: Component
X-Invoker-UserIPAddress: Client IP Address
X-Invoker-ServerIPAddress: Server IP Address
X-Invoker-UserMACAddress: Client MAC Address
X-Invoker-ServerMACAddress: Server MAC Address
X-Invoker-ProcessDate: Process date
X-Invoker-TxId: Id TX
X-Invoker-SessionKey: Session key
X-Invoker-Source: Origin
X-Invoker-Country: Country
X-Invoker-ProcessBpmId: ID BPM process
X-Invoker-ProcessId: Process ID
X-Invoker-Network: Net
X-Invoker-subChannel: Subchannel with which the transaction must be registered.
X-Invoker-User: User
X-Invoker-Action: Action
X-Invoker-Destination: Destination
X-Invoker-ModifierUser: Modification user
X-Invoker-ReferencedNumber: Reference number
X-Invoker-RequestNumber: Request number
X-Invoker-CustId: Client code
Headers Security
X-Security-CustLoginIdSi: Used to identify the user who logs in
X-Security-ClientID: The Mule expression to use for obtaining the client ID from
X-Security-ClientSecret: The Mule expression to use for obtaining the client secret from API requests
X-Security-Token: Used to send a valid OAuth 2 access token
Body:
govIssueIdent: Identification given by the local government (Required)
govIssueIdentType: Type of customer identification. (CC, CE, LC, NI, OT, PA or RC)
identSerialNum: Number customer IdentificationdepAcctStmtRec: Contains information of product number.
depAcctId: Accounts Information
- acctId: Accounts numbernotification: Information for Send SMS (Required)
sourceCode: Source
subSourceCode: Secondary source
state: Transaction Status
emailToInfo: Primary mailing address
- emailAddr: Primary mailing address (Required)
emailToCcInfo: Mail CC (Required)
- emailAddr: Mail CC copies send separated by commas “,”
subject: Email subject to be notified
message: **(Required)**
- desc: SMS message
file: File information List
- fileType: File Type
- fileName: File Name
- fileBase64: Data FileExample of Body to Send Email
{
"govIssueIdent":{
"govIssueIdentType":"CC",
"identSerialNum":"1023947444"
},
"depAcctStmtRec":{
"depAcctId":{
"acctId":"24026781578"
}
},
"notification":{
"sourceCode":"SA",
"subSourceCode":"E05",
"state":"Y",
"emailToInfo":{
"emailAddr":"genericoaut@bancocajasocial.com"
},
"emailToCcInfo":{
"emailAddr":"copia1@bancocajasocial.com , copia2@bancocajasocial.com"
},
"subject":"Adquisicion producto financiero del Banco Caja Social",
"message":{
"desc":"<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01//EN\"\n\"http://www.w3.org/TR/html4/strict.dtd\">\n<HTML>\n<HEAD>\n<TITLE>STAR NOTIFICACIONES - BCSC</TITLE>\n<META name=\"author\" content=\"BCSC\">\n<META name=\"keywords\" content=\"\">\n<META name=\"date\" content=\"2021-12-10T12:00:00+00:00\">\n<STYLE type=\"text/css\">\n</STYLE>\n</HEAD>\n<BODY lang=\"es\">\n<P>Estimado Cliente: <B>EYNER FABIAN ARIAS TRIANA</B></p>\n<div><p style=\"align:justify\">\n Nuestro compromiso con nuestros clientes es siempre dar información oportuna de los servicios adquiridos con la entidad, de manera que adjunto encontrará los documentos que certifican la apertura de cuenta con número <B>24116083285</B>, incluyendo las condiciones y beneficios.\n<P> </P>\n<P></P>\n<P>Para abrir los documentos tendrá que ingresar el número de su documento de identidad.</P>\n<P> </P>\n<P>Gracias por confiar en el Banco Caja Social.</P>\n<P> </P>\n<P>Si tiene alguna inquietud, puede comunicarse con nuestra Linea Amiga, 307 7060 en Bogota y 01 8000 910 038 desde el resto del pais.</P>\n<P></P>\n<P></P>\n<P><B>Banco Caja Social, su Banco Amigo.</B></P>\n<P>Tildes omitidas para manejar compatibilidad entre agentes de correo</P>\n<P></P>\n</div>\n</BODY>\n</HTML>"
},
"file":[
{
"fileBase64":"JVBERi0xLj",
"fileName":"CartaBienvenidaNOMINAAPNOMINA.pdf",
"fileType":"application/binary"
}
]
}
}Response information:
responseType: Used to return the response
notification: Information of Notification
Example of Body to Response Successfull
{
"notification": {
"sequence": "996697330"
}
}> Errors Code.
Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the following structure.
{
"responseType": {
"value": "ER"
},
"responseDetail": {
"errorCode": "00001",
"errorDesc": "No hay conexión a la base de datos.",
"errorType": "DB"
}
}| HTTP Code | Error Code | Error Type | Description |
|---|---|---|---|
| 200 | 00000 | DB | successful response |
| 400 | 00001 | DB | No database connection |
| 400 | 10002 | VAL | The office code has no value |
| 400 | 10003 | VAL | Error when validating the obligation in an EMAIL notification |
| 400 | 10004 | VAL | Error when validating the obligation in an SMS notification |
| 400 | 20002 | SP | Stored procedure failed to insert notification |
| 400 | 20003 | SP | The stored procedure could not calculate the sequence |
| 400 | 20004 | SP | The stored procedure generated an exception in the database |
| 400 | 30002 | WS | Variable initialization error |
| 400 | 30003 | WS | Datasource invocation error |
| 400 | 30004 | WS | Error in the WS |
> Diagram of sequence.
####
- Notify Customer (POST):
Path:
/notification-management/v1/customer:Headers
X-Invoker-BranchId: Office code
X-Invoker-TerminalId: Term code
X-Invoker-Component: Component
X-Invoker-UserIPAddress: Client IP Address
X-Invoker-ServerIPAddress: Server IP Address
X-Invoker-UserMACAddress: Client MAC Address
X-Invoker-ServerMACAddress: Server MAC Address
X-Invoker-ProcessDate: Process date
X-Invoker-TxId: Id TX
X-Invoker-SessionKey: Session key
X-Invoker-Source: Origin
X-Invoker-Country: Country
X-Invoker-ProcessBpmId: ID BPM process
X-Invoker-ProcessId: Process ID
X-Invoker-Network: Net
X-Invoker-subChannel: Subchannel with which the transaction must be registered.
X-Invoker-User: User
X-Invoker-Action: Action
X-Invoker-Destination: Destination
X-Invoker-ModifierUser: Modification user
X-Invoker-ReferencedNumber: Reference number
X-Invoker-RequestNumber: Request number
X-Invoker-CustId: Client code
Request information:
govIssueIdent: govIssueIdent object
govIssueIdentType: Contains information related to client identification type (CC, CE, PA, TI, NI, NIT, PE)
identSerialNum: Contains information related to client identification number
notification: notification object
mobileOperator: Contains information related to mobile operator
subject: Contains information related to Subject of the email to notify
priority: Contains information related to Priority
type: Contains information related to Type of shipment (SMS, MAIL, DUAL)
message: message object
desc: Contains information related to SMS message
email: email object
desc: Contains information related to Message of the email to notify
file: file array object
binData: Contains information related to Attached binary file
fileName: Contains information related to Attached file name
fileType: Contains information related to Type of content of the attached file.
fileDesc: Contains information related to Description of content of the attached file.Example Body request :
{
"govIssueIdent": {
"govIssueIdentType": "CC",
"identSerialNum": "1116232178"
},
"notification": {
"mobileOperator": "",
"subject": "Adquisicion producto financier",
"priority": 0,
"type": "DUAL",
"message": {
"desc": "Bienvenido(a) al Banco Caja Social con su Cuentamiga, Al recibir su Tarjeta Debito asigne clave en cualquier cajero del Banco"
},
"email": {
"desc": "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01//EN\"\n\"http://www.w3.org/TR/html4/strict.dtd\">\n<HTML>\n<HEAD>\n<TITLE>STAR NOTIFICACIONES - BCSC</TITLE>\n<META name=\"author\" content=\"BCSC\">\n<META name=\"keywords\" content=\"\">\n<META name=\"date\" content=\"2021-12-10T12:00:00+00:00\">\n<STYLE type=\"text/css\">\n</STYLE>\n</HEAD>\n<BODY lang=\"es\">\n<P>Estimado Cliente</p>\n<div><p style=\"align:justify\">\n Nuestro compromiso con nuestros clientes es siempre dar información oportuna de los servicios adquiridos con la entidad, de manera que adjunto encontrará los documentos que certifican la apertura de cuenta con número, incluyendo las condiciones y beneficios.\n<P></P>\n<P></P>\n<P>Para abrir los documentos tendrá que ingresar el número de su documento de identidad.</P>\n<P></P>\n<P>Gracias por confiar en el Banco Caja Social.</P>\n<P></P>\n<P>Si tiene alguna inquietud, puede comunicarse con nuestra Linea Amiga desde el resto del pais.</P>\n<P></P>\n<P></P>\n<P><B>Banco Caja Social, su Banco Amigo.</B></P>\n<P>Tildes omitidas para manejar compatibilidad entre agentes de correo</P>\n<P></P>\n</div>\n</BODY>\n</HTML>"
},
"file": [
{
"binData": "JVBEti0xLjUKJeLjz6MKMSAwIG6iago8PC6Nb2REYXRlKFqkODltV9uFezXPyfmklmkcZ/ysa5GHY",
"fileName": "CartaBienvenida.pdf",
"fileType": "application/binary ",
"fileDesc": ""
}
]
}
}Response information:
> Response 200.
{
"responseType": {
"value": "OK"
},
"notification": {
"message": {
"sequence": "824572533"
},
"email":{
"sequence": "824692822"
}
}
}> Error response.
Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
{
"responseType": {
"value": "ER"
},
"responseDetail": {
"errorCode": "00101",
"errorDesc": "El cliente no tiene celular",
"errorType": "RGN"
}
}> Errors Code.
| HTTP Code | Error Code | Error Type | Description |
|---|---|---|---|
| 200 | 00000 | DB | Respuesta exitosa |
| 500 | 00001 | DB | No hay conexión a la base de datos |
| 400 | 10002 | VAL | El codigo de oficina no tiene valor |
| 400 | 10003 | VAL | Error al validar la obligatoriedad en una notificación EMAIL |
| 400 | 10004 | VAL | Error al validar la obligatoriedad en una notificación SMS |
| 500 | 20002 | SP | El procedimiento almacenado no pudo insertar la notificacion |
| 500 | 20003 | SP | El procedimiento almacenado no pudo calcular la sequencia |
| 500 | 20004 | SP | El procedimiento almacenado genero una exception en la base de datos |
| 500 | 30002 | WS | Error en inicializacion de varibles |
| 500 | 30003 | WS | Error en invocacion de Datasource |
| 500 | 30004 | WS | Error en el WS |
| 400 | 00100 | RGN | El valor del tipo envio debe ser (MAIL, SMS o DUAL) |
| 400 | 00101 | RGN | El cliente no tiene celular |
| 400 | 00102 | RGN | El cliente no tiene correo |
| 400 | 00103 | TEC | El cliente no tiene celular - El cliente no tiene correo |
| 404 | 50001 | BDE | PERSONA NATURAL NO EXISTE |
> Diagram of sequence.
####
####
Send SMS Notification:
Description: This resource manage the sending of SMS text messages.
Path: /notification-management/v2/sms
- Send SMS Notification (POST):
Path:
/notification-management/v2/sms:Headers
X-Invoker-BranchId: Office code
X-Invoker-TerminalId: Term code
X-Invoker-Component: Component
X-Invoker-UserIPAddress: Client IP Address
X-Invoker-ServerIPAddress: Server IP Address
X-Invoker-UserMACAddress: Client MAC Address
X-Invoker-ServerMACAddress: Server MAC Address
X-Invoker-ProcessDate: Process date
X-Invoker-TxId: Id TX
X-Invoker-SessionKey: Session key
X-Invoker-Source: Origin
X-Invoker-Country: Country
X-Invoker-ProcessBpmId: ID BPM process
X-Invoker-ProcessId: Process ID
X-Invoker-Network: Net
X-Invoker-Channel: Channel with which the transaction must be registered (minLength:3 "007")
X-Invoker-subChannel: Subchannel with which the transaction must be registered
X-Invoker-User: User
X-Invoker-Action: Action
X-Invoker-Destination: Destination
X-Invoker-ModifierUser: Modification user
X-Invoker-ReferencedNumber: Reference number
X-Invoker-RequestNumber: Request number
X-Invoker-CustId: Client code
Headers Security
X-Security-CustLoginId: Used to identify the user who logs in
ClientID: The Mule expression to use for obtaining the client ID from
ClientSecret: The Mule expression to use for obtaining the client secret from API requests
Authorization: Used to send a valid OAuth 2 access token
Request information:
{
"notification": {
"sourceCode": "OF",
"subSourceCode": "E01",
"depAcctId": {
"acctId": ""
},
"mobileOperator": "2",
"cellPhone": "304123456783",
"mnemonic": "CC1234567",
"additionalData": [
{
"name": "Parametro1",
"value": "JUAN PEREZ"
},
{
"name": "Parametro2",
"value": "2012-01-01"
}
]
}
}Response information:
> Response 200.
{
"responseType": {
"value": "OK"
}
}> Error response.
Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
"responseType": {
"value": "ER"
},
"responseDetail": {
"errorCode": "00004",
"errorDesc": "Parametros de plantilla de notificacion incorrectos",
"errorType": "INP"
}
}####