カテゴリー
User
Update a User
特定のUser情報を更新できます。 パラメータ URL https://api.channel.io/open/v5/users/{userId}およびHTTP PATCH経由でアクセス可能 PATCH本文にパラメータを表示します。この方法は現在application/jsonのみをサポートしています。 パラメータ 例 要件 説明 タイプ userId 5ec3a01fe2b3f4d2cbc5 必須 ID of User Path profile {"name": "Gabrielle Chanel", ..} 任意 Profileオブジェクトにはユーザー情報が含まれます。 Body profileOnce {"utmSource": "google", ..} 任意 Profileオブジェクトにはユーザー情報が含まれます。ただし、プロパティが存在する場合は更新されません。 Body tags ['tag1', 'tag2'] 任意 ユーザーのタグ属性。既存のタグはすべて、新しく指定された配列に置き換えられます（上書きされます）。 Body unsubscribeEmail true
Upsert a User (By memberId)）
Userが存在する場合は、情報を更新します。 そうでない場合は、新しいUserを作成します。 パラメータ URL https://api.channel.io/open/v5/users/@{memberId}およびHTTP PUT経由でアクセス可能 memberIdの先頭に@が付く点にご注意ください。 PUT本文にパラメータを表示します。この方法は現在application/jsonのみをサポートしています。 パラメータ 例 要件 説明 タイプ memberId 12345 必須 自社で使用しているメンバー（ユーザー）ID Path profile {"name": "Gabrielle Chanel", ..} 任意 Profileオブジェクトにはユーザー情報が含まれます。 Body profileOnce {"utmSource": "google", ..} 任意 Profileオブジェクトにはユーザー情報が含まれます。ただし、プロパティが存在する場合は更新されません。 Body tags ['tag1', 'tag2'] 任意 ユーザーのタグ属性です。既存のタグはすべて、新し
Get a single User
特定のUserオブジェクトを取得できます。 Userを取得する方法は2つあります。 1つ目は、userId（チャネルトークサーバー内でのユーザー識別子）を指定して取得する方法です。 2つ目は、memberId（JavaScriptクイックスタートで使用したmemberId）を指定して取得する方法です。 userIdによる特定のUserの取得 Parameter URL https://api.channel.io/open/v5/users/{userId}およびHTTP GET経由でアクセス可能 パラメータ 例 要件 説明 タイプ userId 5ec3a01fe2b3f4d2cbc5 必須 UserのID Path 例 GET https://api.channel.io/open/v5/users/5ec3a01fe2b3f4d2cbc5 レスポンス Userオブジェクトと関連情報を返します。 { "user": { "id": "string", "channelId": "string", "memberId": "string", "veilId": "string", "
Delete a User
特定のUserオブジェクトを削除できます。 Userを削除する方法は2つあります。 1つ目は、userId（チャネルトークサーバー内でのユーザー識別子）を指定して削除する方法です。 2つ目は、memberId（JavaScriptクイックスタートで使用したmemberId）を指定して削除する方法です。 userIdによる特定のUserの削除 パラメータ URL https://api.channel.io/open/v5/users/{userId}およびHTTP DELETE経由でアクセス可能 パラメータ 例 要件 説明 タイプ userId 5ec3a01fe2b3f4d2cbc5 必須 UserのID Path 例 DELETE https://api.channel.io/open/v5/users/5ec3a01fe2b3f4d2cbc5 レスポンス 成功した場合、HTTPステータスコード204を返します。 --- memberIdによる特定のUserの削除 パラメータ URL https://api.channel.io/open/v5/users/@{memberId}お
Block a User
特定のUserをブロックできます。 パラメータ URL https://api.channel.io/open/v5/users/{userId}/blockおよびHTTP POST経由でアクセス可能 パラメータ 例 要件 説明 タイプ userId 12345 必須 UserのID Path 例 POST http://api.channel.io/open/v5/users/12345/block レスポンス 変更されたUserオブジェクトと関連情報を返します。 { "user": { "id": "string", "channelId": "string", "memberId": "string", "veilId": "string", "unifiedId": "string", "type": "member", "name": "string", "mobileNumberQualified": true, "emailQualified": true, "profile": { "name": "string", "empty": true, "email": "s
Unblock a User
特定のUserのブロックを解除できます。 パラメータ URL https://api.channel.io/open/v5/users/{userId}/blockおよびHTTP DELETE経由でアクセス可能 パラメータ 例 要件 説明 タイプ userId 12345 必須 UserのID Path 例 DELETE http://api.channel.io/open/v5/users/12345/block レスポンス 変更されたUserオブジェクトと関連情報を返します。 { "user": { "id": "string", "channelId": "string", "memberId": "string", "veilId": "string", "unifiedId": "string", "type": "member", "name": "string", "mobileNumberQualified": true, "emailQualified": true, "profile": { "name": "string", "empty": true, "ema
Create a User's UserChat
特定のUserの新規UserChatを作成できます。 パラメータ URL https://api.channel.io/open/v5/users/{userId}/user-chatsおよびHTTP POST経由でアクセス可能 パラメータ 例 要件 説明 タイプ userId 12345 必須 UserのID Path 例 POST https://api.channel.io/open/v5/users/12345/user-chats レスポンス 新しく作成されたUserChatオブジェクトを返します。 { "campaign": { "id": "string", "channelId": "string", "name": "string", "state": "draft", "sendMedium": "appAlimtalk", "userQuery": { "key": "string", "type": "boolean", "operator": {}, "values": [ {} ], "and": [ null ], "or": [ null ] }, "t
Get a list of User's UserChats
特定のUserのUserChatを取得できます。 パラメータ URL https://api.channel.io/open/v5/users/{userId}/user-chats およびHTTP GET経由でアクセス可能 クエリ文字列にパラメータを表示します。 パラメータ 例 要件 説明 タイプ userId 12345 必須 UserのID Path sortOrder desc 任意 ソート順（並び順）。 - 指定可能な値 : asc, desc, both - デフォルト値 : desc（降順。最新のメッセージが先頭になります） Query since 500000 任意 取得を開始するメッセージのマイクロ秒単位のエポックタイムです。 sinceパラメータが指定されていない（空の）場合、取得されるリストは（orderパラメータで指定された順序における）最初のメッセージから開始されます。 Query limit 40 任意 取得するダイレクトチャットの最大件数を指定します。 - 最小値：1 - 最大値：500 - デフォルト値：25 Query 例 GET https://ap
Issue token for a User
特定のUserのsessionJWTを発行できます。 パラメータ URL https://api.channel.io/open/v5/users/@{memberId}/session-jwt/issueおよびHTTP PUT経由でアクセス可能 パラメータ 例 要件 説明 タイプ memberId 12345 必須 UserのmemberId Path expiration PT30M 任意 このプロパティがnullの場合、有効期限は1分（PT1M）に設定されます。 Query 例 PUT https://api.channel.io/open/v5/users/@12345/session-jwt/issue?expiration=PT30M レスポンス sessionJWTとexpireAtを含むオブジェクトを返します。 { "sessionJWT" : "dfw123asdfa.12asda23sdfawe.12adaefaw34", "expireAt" : 1689821504019 }
Touch a User
（2025年12月5日より提供開始）