iGRPIGRP 3.0Documentation

Destinatários e grupos

Contactos, preferências, opt-outs e grupos de destinatários.

Obter destinatário

GET
/api/v1/recipients/{userId}

Permissão: igrp.notification.admin. Contactos e preferências de um utilizador.

Autorização

bearer-jwt
headerAutorizaçãoBearer <token>

Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.

Parâmetros de caminho

userId*string

Parâmetros de query

applicationCode?string

Corpo da resposta

OK

*/*
  1. response
id?string
Formatouuid
userId?string
contacts?array<>
pushTokens?array<string>
preferredChannels?array<>
optOuts?array<>
curl -X GET 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/recipients/string'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "userId": "string",  "contacts": [    {      "channel": "EMAIL",      "value": "string"    }  ],  "pushTokens": [    "string"  ],  "preferredChannels": [    "EMAIL"  ],  "optOuts": [    {      "channel": "EMAIL",      "category": "string"    }  ]}

Remover destinatário

DELETE
/api/v1/recipients/{userId}

Permissão: igrp.notification.admin.

Autorização

bearer-jwt
headerAutorizaçãoBearer <token>

Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.

Parâmetros de caminho

userId*string

Parâmetros de query

applicationCode?string

Corpo da resposta

OK

curl -X DELETE 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/recipients/string'
Vazio

Criar ou atualizar destinatário

PUT
/api/v1/recipients/{userId}

Permissão: igrp.notification.admin.

Autorização

bearer-jwt
headerAutorizaçãoBearer <token>

Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.

Parâmetros de caminho

userId*string

Corpo do pedido

application/json
  1. body
contacts?array<>
pushTokens?array<string>
preferredChannels?array<>
optOuts?array<>
applicationCode?string

Corpo da resposta

OK

*/*
  1. response
id?string
Formatouuid
userId?string
contacts?array<>
pushTokens?array<string>
preferredChannels?array<>
optOuts?array<>
curl -X PUT 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/recipients/string' \  -H 'Content-Type: application/json' \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "userId": "string",  "contacts": [    {      "channel": "EMAIL",      "value": "string"    }  ],  "pushTokens": [    "string"  ],  "preferredChannels": [    "EMAIL"  ],  "optOuts": [    {      "channel": "EMAIL",      "category": "string"    }  ]}

Canais preferidos

PUT
/api/v1/recipients/{userId}/preferences

Permissão: igrp.notification.admin. Usados pela estratégia PREFERRED.

Autorização

bearer-jwt
headerAutorizaçãoBearer <token>

Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.

Parâmetros de caminho

userId*string

Corpo do pedido

application/json
  1. body
preferredChannels?array<>
applicationCode?string

Corpo da resposta

OK

*/*
  1. response
id?string
Formatouuid
userId?string
contacts?array<>
pushTokens?array<string>
preferredChannels?array<>
optOuts?array<>
curl -X PUT 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/recipients/string/preferences' \  -H 'Content-Type: application/json' \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "userId": "string",  "contacts": [    {      "channel": "EMAIL",      "value": "string"    }  ],  "pushTokens": [    "string"  ],  "preferredChannels": [    "EMAIL"  ],  "optOuts": [    {      "channel": "EMAIL",      "category": "string"    }  ]}

Opt-outs

PUT
/api/v1/recipients/{userId}/opt-outs

Permissão: igrp.notification.admin. Por canal e categoria.

Autorização

bearer-jwt
headerAutorizaçãoBearer <token>

Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.

Parâmetros de caminho

userId*string

Corpo do pedido

application/json
  1. body
optOuts?array<>
applicationCode?string

Corpo da resposta

OK

*/*
  1. response
id?string
Formatouuid
userId?string
contacts?array<>
pushTokens?array<string>
preferredChannels?array<>
optOuts?array<>
curl -X PUT 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/recipients/string/opt-outs' \  -H 'Content-Type: application/json' \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "userId": "string",  "contacts": [    {      "channel": "EMAIL",      "value": "string"    }  ],  "pushTokens": [    "string"  ],  "preferredChannels": [    "EMAIL"  ],  "optOuts": [    {      "channel": "EMAIL",      "category": "string"    }  ]}

Listar grupos

GET
/api/v1/groups

Permissão: igrp.notification.admin.

Autorização

bearer-jwt
headerAutorizaçãoBearer <token>

Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.

Parâmetros de query

applicationCode?string

Corpo da resposta

OK

*/*
  1. response
[index: integer]?
curl -X GET 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/groups'
[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "type": "INTERNAL",    "memberUserIds": [      "string"    ],    "externalGroupRef": "string"  }]

Criar grupo

POST
/api/v1/groups

Permissão: igrp.notification.admin.

Autorização

bearer-jwt
headerAutorizaçãoBearer <token>

Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.

Corpo do pedido

application/json
  1. body
name*string
Comprimento1 <= length
type*string
Valor em"INTERNAL""EXTERNAL_DEPARTMENT"
memberUserIds?array<string>
externalGroupRef?string
applicationCode?string

Corpo da resposta

OK

*/*
  1. response
id?string
Formatouuid
name?string
type?string
Valor em"INTERNAL""EXTERNAL_DEPARTMENT"
memberUserIds?array<string>
externalGroupRef?string
curl -X POST 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/groups' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "type": "INTERNAL"}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "type": "INTERNAL",  "memberUserIds": [    "string"  ],  "externalGroupRef": "string"}

Obter grupo

GET
/api/v1/groups/{id}

Permissão: igrp.notification.admin.

Autorização

bearer-jwt
headerAutorizaçãoBearer <token>

Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.

Parâmetros de caminho

id*string
Formatouuid

Parâmetros de query

applicationCode?string

Corpo da resposta

OK

*/*
  1. response
id?string
Formatouuid
name?string
type?string
Valor em"INTERNAL""EXTERNAL_DEPARTMENT"
memberUserIds?array<string>
externalGroupRef?string
curl -X GET 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/groups/497f6eca-6276-4993-bfeb-53cbbbba6f08'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "type": "INTERNAL",  "memberUserIds": [    "string"  ],  "externalGroupRef": "string"}

Remover grupo

DELETE
/api/v1/groups/{id}

Permissão: igrp.notification.admin.

Autorização

bearer-jwt
headerAutorizaçãoBearer <token>

Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.

Parâmetros de caminho

id*string
Formatouuid

Parâmetros de query

applicationCode?string

Corpo da resposta

OK

curl -X DELETE 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/groups/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Vazio

Atualizar grupo

PUT
/api/v1/groups/{id}

Permissão: igrp.notification.admin.

Autorização

bearer-jwt
headerAutorizaçãoBearer <token>

Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.

Parâmetros de caminho

id*string
Formatouuid

Corpo do pedido

application/json
  1. body
name*string
Comprimento1 <= length
type*string
Valor em"INTERNAL""EXTERNAL_DEPARTMENT"
memberUserIds?array<string>
externalGroupRef?string
applicationCode?string

Corpo da resposta

OK

*/*
  1. response
id?string
Formatouuid
name?string
type?string
Valor em"INTERNAL""EXTERNAL_DEPARTMENT"
memberUserIds?array<string>
externalGroupRef?string
curl -X PUT 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/groups/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "type": "INTERNAL"}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "type": "INTERNAL",  "memberUserIds": [    "string"  ],  "externalGroupRef": "string"}
How is this guide?

Última atualização: