List of OneTimeMsg Users

Retrieve a list of OneTimeMsg User objects

Parameter

Accessible via URL https://api.channel.io/open/v5/mkt/one-time-msgs/{id}/one-time-msg-users and HTTP GET

ParameterExampleRequiredDescriptionParameter Type
id1234RequiredID of OneTimeMsg objectPath
statesentRequiredThe type of OneTimeMsg User objects to be retrieved.
- available values : sent, view, goal, click
Query
sinceeyJjaGF0S2V5IjoiZ3Jvn0=OptionalEncoded key of the first OneTimeMsg User to be retrieved.
Pagination is supported along with the next value contained in the root object of the JSON response.
Query
limit25OptionalRestrict the maximum number of OneTimeMsg User objects to be retrieved.
- min : 1
- max : 500
- default : 25
Query
sortOrderdescOptionalSorting order
- available values : asc, desc, both
- default : desc
Query

Example

GET https://api.channel.io/open/v5/mkt/one-time-msgs/1234/one-time-msg-users?state=click&since=eyJjaGF0S2V5IjoiZ3Jvn0=&limit=25&sortOrder=desc

Response

Returns a list of OneTimeMsg User objects

{
  "prev": "string",
  "next": "string",
  "oneTimeMsgUsers": [
    {
      "oneTimeMsgId": "string",
      "userId": "string",
      "sent": 1656032149976,
      "view": 1656032149976,
      "goal": 1656032149976,
      "click": 1656032149976,
      "version": 0,
      "id": "string"
    }
  ]
}

Implementation Note

🚧

The OneTimeMsg User is not a target of the unify process. In other words, the OneTimeMsg User data would not be unified even if one is logged in afterwards.

🚧

The OneTimeMsg User objects who has been updated more than a year ago will not be retrieved.