GET
Permissão: igrp.notification.read. Filtros por businessKey, category, priority, channel, status, batchId, recurrenceId, recipient e intervalo createdFrom/createdTo (ISO 8601).
bearer-jwtheader
AutorizaçãoBearer <token>Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.
businessKey?stringcategory?stringpriority?stringValor em
"LOW""NORMAL""HIGH""URGENT"channel?stringValor em
"EMAIL""SMS""WHATSAPP""PUSH""IN_APP""OFFLINE"status?stringValor em
"PENDING""QUEUED""SENDING""SENT""DELIVERED""READ""FAILED""CANCELLED""EXPIRED"batchId?stringFormato
uuidrecurrenceId?stringFormato
uuidrecipient?stringcreatedFrom?stringFormato
date-timecreatedTo?stringFormato
date-timeapplicationCode?stringpageable*OK
*/*- response
content?array<>page?integerFormato
int32size?integerFormato
int32totalElements?integerFormato
int64totalPages?integerFormato
int32curl -X GET 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/notifications?page=0&size=1&sort=string'{ "content": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "businessKey": "string", "category": "string", "priority": "string", "channelStrategy": "string", "createdAt": "2019-08-24T14:15:22Z", "deliveryStats": { "total": 0, "pending": 0, "queued": 0, "sending": 0, "sent": 0, "delivered": 0, "read": 0, "failed": 0, "cancelled": 0, "expired": 0 } } ], "page": 0, "size": 0, "totalElements": 0, "totalPages": 0}POST
Permissão: igrp.notification.send. Pedido M2M (token client_credentials). Responde 202 com o id e as entregas; a entrega é assíncrona. EMAIL exige o provider SMTP configurado (senão 422 CHANNEL_NOT_ENABLED).
bearer-jwtheader
AutorizaçãoBearer <token>Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.
application/json- body
businessKey?stringcategory?stringpriority?stringValor em
"LOW""NORMAL""HIGH""URGENT"channelStrategy*stringValor em
"SPECIFIC""ALL""PREFERRED"channels?array<>recipients?array<>groups?array<>template?inline?variables?locale?stringattachments?array<>idempotencyKey?stringcorrelationId?stringcallbackUrl?stringscheduledAt?stringFormato
date-timeexpiresAt?stringFormato
date-timeapplicationCode?stringOK
*/*- response
id?stringFormato
uuiddeliveries?array<>curl -X POST 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/notifications' \ -H 'Content-Type: application/json' \ -d '{ "channelStrategy": "SPECIFIC"}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "deliveries": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "channel": "string", "status": "string", "providerMessageId": "string", "errorCode": "string", "recipientUserId": "string", "recipientEmail": "string", "recipientPhone": "string" } ]}GET
Permissão: igrp.notification.read. Inclui as entregas e o conteúdo renderizado.
bearer-jwtheader
AutorizaçãoBearer <token>Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.
id*stringFormato
uuidapplicationCode?stringOK
*/*- response
id?stringFormato
uuidapplicationCode?stringbusinessKey?stringcategory?stringpriority?stringchannelStrategy?stringchannels?array<string>templateCode?stringtemplateLocale?stringlocale?stringscheduledAt?stringFormato
date-timeexpiresAt?stringFormato
date-timebatchId?stringFormato
uuidrecurrenceId?stringFormato
uuidresendOf?stringFormato
uuididempotencyKey?stringcorrelationId?stringcreatedBy?stringcreatedAt?stringFormato
date-timedeliveries?array<>curl -X GET 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/notifications/497f6eca-6276-4993-bfeb-53cbbbba6f08'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "applicationCode": "string", "businessKey": "string", "category": "string", "priority": "string", "channelStrategy": "string", "channels": [ "string" ], "templateCode": "string", "templateLocale": "string", "locale": "string", "scheduledAt": "2019-08-24T14:15:22Z", "expiresAt": "2019-08-24T14:15:22Z", "batchId": "5579c111-9c50-47e2-af92-f16d52e63189", "recurrenceId": "6fa1ecb6-5547-4080-8b7c-c837a5472fe0", "resendOf": "6a92c73a-ace4-45ff-b39d-5644ef85bd39", "idempotencyKey": "string", "correlationId": "string", "createdBy": "string", "createdAt": "2019-08-24T14:15:22Z", "deliveries": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "channel": "string", "status": "string", "recipientUserId": "string", "recipientEmail": "string", "recipientPhone": "string", "renderedSubject": "string", "renderedBody": "string", "renderedTitle": "string", "attempts": 0, "providerMessageId": "string", "errorCode": "string", "sentAt": "2019-08-24T14:15:22Z", "deliveredAt": "2019-08-24T14:15:22Z", "readAt": "2019-08-24T14:15:22Z", "failedAt": "2019-08-24T14:15:22Z" } ]}POST
Permissão: igrp.notification.send. Canais e destinatários opcionais.
bearer-jwtheader
AutorizaçãoBearer <token>Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.
id*stringFormato
uuidapplicationCode?stringapplication/json- body
channels?array<>recipients?array<>correlationId?stringapplicationCode?stringOK
*/*- response
id?stringFormato
uuiddeliveries?array<>curl -X POST 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/notifications/497f6eca-6276-4993-bfeb-53cbbbba6f08/resend' \ -H 'Content-Type: application/json' \ -d '{}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "deliveries": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "channel": "string", "status": "string", "providerMessageId": "string", "errorCode": "string", "recipientUserId": "string", "recipientEmail": "string", "recipientPhone": "string" } ]}POST
Permissão: igrp.notification.send. O mesmo pedido para muitos destinatários; devolve o batchId.
bearer-jwtheader
AutorizaçãoBearer <token>Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.
application/json- body
businessKey?stringcategory?stringpriority?stringValor em
"LOW""NORMAL""HIGH""URGENT"channelStrategy*stringValor em
"SPECIFIC""ALL""PREFERRED"channels?array<>recipients?array<>groups?array<>template?inline?variables?locale?stringattachments?array<>idempotencyKey?stringcorrelationId?stringcallbackUrl?stringscheduledAt?stringFormato
date-timeexpiresAt?stringFormato
date-timeapplicationCode?stringOK
*/*- response
batchId?stringFormato
uuidnotificationId?stringFormato
uuidtotalDeliveries?integerFormato
int32deliveries?array<>curl -X POST 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/notifications/bulk' \ -H 'Content-Type: application/json' \ -d '{ "channelStrategy": "SPECIFIC"}'{ "batchId": "5579c111-9c50-47e2-af92-f16d52e63189", "notificationId": "2d591c23-85b1-4e8c-a6bd-74d89f8955c5", "totalDeliveries": 0, "deliveries": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "channel": "string", "status": "string", "providerMessageId": "string", "errorCode": "string", "recipientUserId": "string", "recipientEmail": "string", "recipientPhone": "string" } ]}POST
Permissão: igrp.notification.send. Multipart: parte request (JSON) e parte file (CSV).
bearer-jwtheader
AutorizaçãoBearer <token>Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.
multipart/form-data- body
request*file*fileFormato
binaryOK
*/*- response
batchId?stringFormato
uuidnotificationId?stringFormato
uuidtotalDeliveries?integerFormato
int32deliveries?array<>curl -X POST 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/notifications/bulk/csv' \ -F 'request={ "channelStrategy": "SPECIFIC"}' \ -F 'file=string'{ "batchId": "5579c111-9c50-47e2-af92-f16d52e63189", "notificationId": "2d591c23-85b1-4e8c-a6bd-74d89f8955c5", "totalDeliveries": 0, "deliveries": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "channel": "string", "status": "string", "providerMessageId": "string", "errorCode": "string", "recipientUserId": "string", "recipientEmail": "string", "recipientPhone": "string" } ]}GET
Permissão: igrp.notification.read.
bearer-jwtheader
AutorizaçãoBearer <token>Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.
batchId*stringFormato
uuidapplicationCode?stringOK
*/*- response
batchId?stringFormato
uuidstatus?stringValor em
"ACCEPTED""CANCELLED"total?integerFormato
int64sent?integerFormato
int64delivered?integerFormato
int64failed?integerFormato
int64cancelled?integerFormato
int64pending?integerFormato
int64curl -X GET 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/batches/497f6eca-6276-4993-bfeb-53cbbbba6f08'{ "batchId": "5579c111-9c50-47e2-af92-f16d52e63189", "status": "ACCEPTED", "total": 0, "sent": 0, "delivered": 0, "failed": 0, "cancelled": 0, "pending": 0}POST
Permissão: igrp.notification.send. Cancela as entregas ainda pendentes.
bearer-jwtheader
AutorizaçãoBearer <token>Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.
batchId*stringFormato
uuidapplicationCode?stringOK
*/*- response
batchId?stringFormato
uuidstatus?stringValor em
"ACCEPTED""CANCELLED"total?integerFormato
int64sent?integerFormato
int64delivered?integerFormato
int64failed?integerFormato
int64cancelled?integerFormato
int64pending?integerFormato
int64curl -X POST 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/batches/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel'{ "batchId": "5579c111-9c50-47e2-af92-f16d52e63189", "status": "ACCEPTED", "total": 0, "sent": 0, "delivered": 0, "failed": 0, "cancelled": 0, "pending": 0}How is this guide?
Última atualização: