カテゴリー
Marketing
List of Campaigns
Campaignオブジェクトのリストを取得できます。 パラメータ URL https://api.channel.io/open/v5/mkt/campaignsおよびHTTP GET経由でアクセス可能 パラメータ 例 要件 説明 タイプ since 1605795977290 任意 取得する最初のCampaignのエポックタイム（マイクロ秒単位）。JSONレスポンスのルートオブジェクトに含まれるnext値によるページネーションをサポート。 Query limit 25 任意 結果の最大件数を制限 - 最小値：1 - 最大値：500 - デフォルト値：25 Query states active 任意 取得するCampaignの状態のセット - 利用可能な値 : draft, active, stopped Query 例 GET https://api.channel.io/open/v5/mkt/campaigns?since=1605795977290&limit=25&states=draft&states=active レスポンス CampaignおよびCampaignMsg
Get a single Campaign
特定のCampaignオブジェクトを取得できます。 パラメータ URL https://api.channel.io/open/v5/mkt/campaigns/{id}およびHTTP GET経由でアクセス可能 パラメータ 例 要件 説明 タイプ id 1234 必須 CampaignオブジェクトのID Path 例 GET https://api.channel.io/open/v5/mkt/campaigns/1234 レスポンス CampaignオブジェクトとCampaignMsgオブジェクトのリスト、および関連情報を返します。 { "campaign": { "id": "string", "channelId": "string", "name": "string", "state": "draft", "sendMedium": "appAlimtalk", "userQuery": { "key": "string", "type": "boolean", "operator": {}, "values": [ {} ], "and": [ null ], "or": [
List of Campaign Users
Campaign Userオブジェクトのリストを取得できます。 パラメータ URL https://api.channel.io/open/v5/mkt/campaigns/{id}/campaign-usersおよびHTTP GET経由でアクセス可能 パラメータ 例 要件 説明 タイプ id 1234 必須 CampaignオブジェクトのID Path state sent 必須 取得するCampaign Userオブジェクトの種類。 - 利用可能な値 : sent, view, goal, click Query since eyJjaGF0S2V5IjoiZ3Jvn0= 任意 取得する最初のCampaign Userのエンコード済みキー。JSONレスポンスのルートオブジェクトに含まれるnext値によるページネーションをサポート。 Query limit 25 任意 取得するCampaign Userオブジェクトの最大数を制限します。 - 最小値：1 - 最大値：500 - デフォルト値：25 Query sortOrder desc 任意 ソート順 - 利用可能な値 : asc,
Get a single Campaign User
特定のCampaign Userオブジェクトを取得できます。 パラメータ URL https://api.channel.io/open/v5/mkt/campaigns/{campaignId}/campaign-users/{userId}およびHTTP GET経由でアクセス可能 パラメータ 例 要件 説明 タイプ campaignId 1234 必須 CampaignオブジェクトのID Path userId 5ec3a01fe2b3f4d2cbc5 必須 UserオブジェクトのID Path 例 GET https://api.channel.io/open/v5/mkt/campaigns/1234/campaign-users/5ec3a01fe2b3f4d2cbc5 レスポンス Campaign Userオブジェクトと関連情報を返します。 { "campaignUser": { "campaignId": "string", "userId": "string", "msgId": "string", "sent": 1656032146842, "view": 1656
List of OneTimeMsg
OneTimeMsgオブジェクトのリストを取得できます。 パラメータ URL https://api.channel.io/open/v5/mkt/one-time-msgsおよびHTTP GET経由でアクセス可能 パラメータ 例 要件 説明 タイプ since 1605795977290 任意 取得する最初のOneTimeMsgのエポックタイム（マイクロ秒単位）。JSONレスポンスのルートオブジェクトに含まれるnext値と共にページネーションをサポートする。 Query limit 25 任意 取得するOneTimeMsgオブジェクトの最大数を制限する - min : 1 - max : 500 - default : 25 Query states waiting 任意 取得するOneTimeMsgの状態のセット - 利用可能な値 : draft、waiting、sent、canceled Query 例 GET https://api.channel.io/open/v5/mkt/one-time-msgs?since=1605795977290&limit=25&states=
Get a single OneTimeMsg
特定のOneTimeMsgオブジェクトを取得できます。 パラメータ URL https://api.channel.io/open/v5/mkt/one-time-msgs/{id}およびHTTP GET経由でアクセス可能 パラメータ 例 要件 説明 タイプ id 1234 必須 OneTimeMsgオブジェクトのID Path 例 GET https://api.channel.io/open/v5/mkt/one-time-msgs/1234 レスポンス OneTimeMsgオブジェクトおよび関連情報を返します。 { "oneTimeMsg": { "id": "string", "channelId": "string", "name": "string", "state": "draft", "sendMedium": "appAlimtalk", "settings": { "type": "string" }, "userQuery": { "key": "string", "type": "boolean", "operator": {}, "values": [ {}
List of OneTimeMsg Users
OneTimeMsg Userオブジェクトのリストを取得できます。 パラメータ URL https://api.channel.io/open/v5/mkt/one-time-msgs/{id}/one-time-msg-usersおよびHTTP GET経由でアクセス可能 パラメータ 例 要件 説明 タイプ id 1234 必須 OneTimeMsgオブジェクトのID Path state sent 必須 取得するOneTimeMsg Userオブジェクトの種類。 - 利用可能な値 : sent、view、goal、click Query since eyJjaGF0S2V5IjoiZ3Jvn0= 任意 取得する最初のOneTimeMsg Userのエンコード済みキー。JSONレスポンスのルートオブジェクトに含まれるnext値と共にページネーションをサポートする。 Query limit 25 任意 取得するOneTimeMsg Userオブジェクトの最大数を制限します。 - min : 1 - max : 500 - default : 25 Query sortOrder desc
Get a single OneTimeMsg User
特定のOneTimeMsg Userオブジェクトを取得できます。 パラメータ URL https://api.channel.io/open/v5/mkt/one-time-msgs/{oneTimeMsgId}/one-time-msg-users/{userId}およびHTTP GET経由でアクセス可能 パラメータ 例 要件 説明 タイプ oneTimeMsgId 1234 必須 OneTimeMsgオブジェクトのID Path userId 5ec3a01fe2b3f4d2cbc5 必須 UserオブジェクトのID Path 例 GET https://api.channel.io/open/v5/mkt/one-time-msgs/1234/one-time-msg-users/5ec3a01fe2b3f4d2cbc5 レスポンス OneTimeMsg Userオブジェクトおよび関連情報を返します。 { "oneTimeMsgUser": { "oneTimeMsgId": "string", "userId": "string", "sent": 1656032149976,