List of OneTimeMsg Users

Retrieve a list of OneTimeMsg User objects

Parameter

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

Parameter

Example

Required

Description

Parameter Type

id

1234

Required

ID of OneTimeMsg object

Path

state

sent (sent, view, goal, click)

Required

The type of OneTimeMsg User objects to be retrieved.

Query

since

eyJjaGF0S2V5IjoiZ3Jvn0=

Optional

Encoded 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

limit

25

Optional

Restrict the maximum number of OneTimeMsg User objects to be retrieved.

  • min : 1
  • max : 500
  • default : 25

Query

sortOrder

desc (asc, desc)

Optional

Sorting order

  • default : desc

Query

Example

GET https://api.channel.io/open/v3/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

{
  "next": "string",
  "oneTimeMsgUsers": [
    {
      "oneTimeMsgId": "string",
      "userId": "string",
      "sent": 1605925011760,
      "view": 1605925011760,
      "goal": 1605925011760,
      "click": 1605925011760,
      "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.