{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v3/platformData/messageSubscribers/","auth":"required","settings":"","results":{"codes":[{"name":"","code":"{\n    \"messageSubscribersListResponse\": {\n        \"status\": 200,\n        \"details\": \"Success\",\n        \"subscribersList\": [\n            {\n                \"subscriber_id\": \"8565754\",\n                \"platform_id\": 2,\n                \"sent_in\": \"2019-11-06 00:11:33\",\n                \"opened_in\": \"2019-11-06 20:11:33\",\n                \"status\": 7,\n                \"identifier\": \"maria:::at:::inngage.com.br\"\n            },\n            {\n                \"subscriber_id\": \"8583538\",\n                \"platform_id\": 1,\n                \"sent_in\": \"2019-11-06 20:11:33\",\n                \"opened_in\": \"2019-11-06 20:11:33\",\n                \"status\": 1,\n                \"identifier\": \"[email protected]\"\n            }\n        ],\n        \"headerData\": {\n            \"_id\": \"2551451\",\n            \"message_type_id\": 1,\n            \"title\": \"Titulo\",\n            \"body\": \"Corpo da mensagem\",\n            \"date\": \"2020-10-22\",\n            \"begin\": \"00:11\",\n            \"end\": \"20:11\"\n        }\n    }\n}","language":"json","status":200},{"name":"","code":"{\n    \"messageSubscribersListResponse\": {\n        \"status\": 400,\n        \"details\": \"Operation Failed\",\n        \"subscribersList\": null,\n        \"headerData\": null\n    }\n}","language":"json","status":400}]},"params":[{"name":"app_token","type":"string","default":"","desc":"token do aplicativo na plataforma Inngage","required":false,"in":"body","ref":"","_id":"5f986c705dae820053a4764f"},{"name":"control_message_id","type":"string","default":"","desc":"ID de controle da mensagem","required":false,"in":"body","ref":"","_id":"5f986c705dae820053a4764e"}],"examples":{"codes":[{"code":"{\n\"messageSubscribersListRequest\":{\n\"app_token\":\"73f5bdfe7b252551e6d892445fd8fcae\",\n\"control_message_id\":\"5f7e3019227f0000f700341f\"\n}\n}\n","language":"json"}]},"method":"post"},"next":{"description":"","pages":[]},"title":"/messageSubscribers (Subscribers que receberam uma mensagem)","type":"endpoint","slug":"messagesubscribers-subscribers-que-receberam-uma-mensagem-1","excerpt":"","body":"A API Message Subscribers permite resgatar uma lista com todas os subscribers que foram impactados por determinada mensagem.\n\nEssa API retorna os seguintes atributos de cada receptor:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"subscriber_id\",\n    \"h-0\": \"Item\",\n    \"h-2\": \"Padrão\",\n    \"h-1\": \"Descrição\",\n    \"1-0\": \"sent_in\",\n    \"2-0\": \"platform\",\n    \"3-0\": \"opened_in\",\n    \"4-0\": \"status\",\n    \"5-0\": \"identifier\",\n    \"2-1\": \"Plataforma do usuário\",\n    \"2-2\": \"1 - Android, 2 - iOS\",\n    \"1-1\": \"Data de envio da mensagem para o usuário\",\n    \"0-1\": \"Id único do usuário na plataforma Inngage\",\n    \"3-1\": \"Data de abertura/clique da mensagem\",\n    \"4-1\": \"Status interno da mensagem\",\n    \"5-1\": \"Identificador do usuário\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]","updates":[],"order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5f9875836695f500128d6d8a","createdAt":"2020-10-27T19:31:15.414Z","user":"5724b9982ad0bc17001227fa","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"(Integrações) API Rest","slug":"integrações-api-rest","order":11,"from_sync":false,"reference":false,"_id":"5f6dd615c624d800180bd237","createdAt":"2020-09-25T11:35:49.617Z","version":"57240e292887bb0e00bb9d96","project":"57240e292887bb0e00bb9d93","__v":0},"version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["57240e292887bb0e00bb9d97","57241b7deae5090e00ee6249","57241c06eae5090e00ee624a","57242abb2ad0bc170012279b","5734d18c7b9859320047f4b1","57688cc71f818b0e00695efb","577ead2ca74eb40e00d97bca","57b66af649a12a0e007b461b","597e5f8f13505b0014251a79","59964eb2f824b4000f961fbe","5a15ab12f2643f001ee8737c","5ab1151799750500797334e0","5c597e8b0abe110014bf1a11","5e395a05470bc3002d78d886","5e42a9647515f300509a594d","5f5e716dcc85f9004a4fa193","5f6dd615c624d800180bd237","5f984feb8aed05003a0032dc","60ac0e9c4c04970016613c6c"],"_id":"57240e292887bb0e00bb9d96","createdAt":"2016-04-30T01:45:13.341Z","project":"57240e292887bb0e00bb9d93","releaseDate":"2016-04-30T01:45:13.341Z","__v":19},"project":"57240e292887bb0e00bb9d93","__v":1,"parentDoc":null}

post/messageSubscribers (Subscribers que receberam uma mensagem)


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

app_token:
string
token do aplicativo na plataforma Inngage
control_message_id:
string
ID de controle da mensagem

Examples


Result Format


Documentation

A API Message Subscribers permite resgatar uma lista com todas os subscribers que foram impactados por determinada mensagem. Essa API retorna os seguintes atributos de cada receptor: [block:parameters] { "data": { "0-0": "subscriber_id", "h-0": "Item", "h-2": "Padrão", "h-1": "Descrição", "1-0": "sent_in", "2-0": "platform", "3-0": "opened_in", "4-0": "status", "5-0": "identifier", "2-1": "Plataforma do usuário", "2-2": "1 - Android, 2 - iOS", "1-1": "Data de envio da mensagem para o usuário", "0-1": "Id único do usuário na plataforma Inngage", "3-1": "Data de abertura/clique da mensagem", "4-1": "Status interno da mensagem", "5-1": "Identificador do usuário" }, "cols": 3, "rows": 6 } [/block]