Get a single OneTimeMsg
Get a particular OneTimeMsg
object
Parameter
Accessible via URL https://api.channel.io/open/v3/mkt/one-time-msgs/{id}
and HTTP GET
Parameter | Example | Required | Description | Parameter Type |
---|---|---|---|---|
id | 1234 | Required | ID of | Path |
Example
GET https://api.channel.io/open/v3/mkt/one-time-msgs/1234
Response
Returns a OneTimeMsg
object along with related information
{
"oneTimeMsg": {
"id": "string",
"channelId": "string",
"name": "string",
"state": "draft",
"botName": "string",
"message": {
"blocks": [
{
"type": "bullets",
"language": "string",
"value": "string"
}
],
"buttons": [
{
"title": "string",
"theme": "blue",
"url": "string"
}
],
"files": [
{
"id": "string",
"type": "string",
"name": "string",
"size": 0,
"contentType": "string",
"duration": 0,
"width": 0,
"height": 0,
"orientation": 0,
"animated": true,
"bucket": "string",
"key": "string",
"previewKey": "string"
}
],
"webPage": {
"id": "string",
"url": "string",
"title": "string",
"description": "string",
"imageUrl": "string",
"videoUrl": "string",
"publisher": "string",
"author": "string",
"width": 0,
"height": 0,
"bucket": "string",
"previewKey": "string",
"logo": "string",
"name": "string"
}
},
"exposureType": "fullScreen",
"userQuery": {
"key": "string",
"type": "boolean",
"operator": {},
"values": [
{}
],
"and": [
null
],
"or": [
null
]
},
"goalEventName": "string",
"goalEventQuery": {
"key": "string",
"type": "boolean",
"operator": {},
"values": [
{}
],
"and": [
null
],
"or": [
null
]
},
"enableSupportBot": true,
"followingSupportBotId": "string",
"advertising": true,
"sendToOfflineUser": true,
"startAt": 1605163155489,
"draft": {
"oneTimeMsg": {}
},
"createdAt": 1605163155489,
"updatedAt": 1605163155489,
"sent": 0,
"view": 0,
"goal": 0,
"click": 0
}
}
Updated over 1 year ago