Show Member Messages History
Pending
GET
https://api.mpc.dev.placewise.com/v1/members/me/messages_history
API Permit:BL:Api:Members:OAuth:MessagesHistory:List
API Context:Loyalty Club
Authorizations:TokenMember
Message model
| Key | Message type | Description | Required? | Type |
|---|---|---|---|---|
| id | all | Message ID | yes | string |
| sending_id | all | MPC Sending ID | yes | string |
| type | all | yes | enum: ["sms", "email", "push"] | |
| created_at | all | Time when the message has been sent | yes | ISO 8601 DateTime |
| content | all | Message content. Note: HTML is stripped from Email messages. | yes | string |
| subject | email, push | Email & push subject/title | no | string |
| sender | sms | SMS sender (may be string or MSISDN) | no | string |
| msisdn | sms | MSISDN the message has been sent to | no | string |
| from_name | Email sender name | no | string | |
| from_address | Email sender address | no | string | |
| Address the message has been sent to | no | string | ||
| url | push | A link contained by the Push message | no | string |
| image | push | An image contained by the Push message | no | string |
| data | push | Additional data contained by the Push message | no | object |
| app_token | push | App token the message has been sent to | no | string |
Query Parameters
| Parameter | Type | Required? | Default | Description |
|---|---|---|---|---|
| per_page | integer | no | 100 | Number of results to be returned per request (100 is the maximum) |
| page_no | integer | no | 1 | Number of results page |
| types | String[] | no | null | Message types that should be returned - available values: ["sms", "email", "push"] |
| distinct | boolean | no | false | When true, messages will be returned uniquely per sending_id |
Example
{
"messages": [
{
"id": "cHVzaDo2MDc2",
"sending_id": "4281",
"created_at": "2022-03-03T08:35:53.807Z",
"type": "push",
"content": "Hello world",
"subject": "Hi",
"url": "https://example.com",
"image": "https://example.com/image.png",
"data": { "sending_id": 13 },
"app_token": "f3kqGU3DRlKrccLKsN6d0A:APA91bFa8AMptK5ETnRfx"
},
{
"id": "ZW1haWw6NjY4Nzk=",
"sending_id": "85901",
"created_at": "2022-03-03T08:35:29.664Z",
"type": "email",
"content": "Hello world",
"subject": "Hi",
"from_name": "Placewise NO.",
"from_address": "no_reply@placewise.com",
"email": "member@placewise.com"
},
{
"id": "bXBfc21zOjQ2NjE2MDM5",
"sending_id": "3391",
"created_at": "2022-03-03T09:35:26.114+01:00",
"type": "sms",
"content": "Hello world",
"sender": "Infinity",
"msisdn": "48886645106"
}
],
"pagination_info": {} // Pagination info - see 'Pagination info"
}
Request
Header Params
X-Loyalty-Club-Slug
stringÂ
required
Default:
{{LOYALTY_CLUB_SLUG}}
X-Client-Authorization
stringÂ
optional
Default:
{{API_TOKEN}}
Request samples
Responses
Modified at 2024-05-07 15:48:35