Get a single OneTimeMsg

Get a particular OneTimeMsg object

Parameter

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

Parameter

Example

Required

Description

Parameter Type

id

1234

Required

ID of OneTimeMsg object

Path

Example

GET https://api.channel.io/open/v5/mkt/one-time-msgs/1234

Response

Returns a OneTimeMsg object along with related information

{
  "oneTimeMsg": {
    "id": "string",
    "channelId": "string",
    "name": "string",
    "state": "draft",
    "sendMedium": "appAlimtalk",
    "settings": {
      "type": "string"
    },
    "userQuery": {
      "key": "string",
      "type": "boolean",
      "operator": {},
      "values": [
        {}
      ],
      "and": [
        null
      ],
      "or": [
        null
      ]
    },
    "goalEventName": "string",
    "goalEventQuery": {
      "key": "string",
      "type": "boolean",
      "operator": {},
      "values": [
        {}
      ],
      "and": [
        null
      ],
      "or": [
        null
      ]
    },
    "goalEventDuration": {
      "seconds": 0,
      "nano": 0,
      "negative": true,
      "zero": true,
      "units": [
        {
          "dateBased": true,
          "timeBased": true,
          "duration": {
            "seconds": 0,
            "nano": 0,
            "negative": true,
            "zero": true
          },
          "durationEstimated": true
        }
      ]
    },
    "advertising": true,
    "sendToOfflineXms": true,
    "sendToOfflineEmail": true,
    "startAt": 1656032152400,
    "draft": {
      "oneTimeMsg": {}
    },
    "createdAt": 1656032152405,
    "updatedAt": 1656032152405,
    "sent": 0,
    "view": 0,
    "goal": 0,
    "click": 0,
    "userChatExpireDuration": {
      "seconds": 0,
      "nano": 0,
      "negative": true,
      "zero": true,
      "units": [
        {
          "dateBased": true,
          "timeBased": true,
          "duration": {
            "seconds": 0,
            "nano": 0,
            "negative": true,
            "zero": true
          },
          "durationEstimated": true
        }
      ]
    }
  }
}