メッセージリストを照会します。
操作説明
-
この操作を呼び出して、メッセージリストをクエリできます。また、チャンネル管理 > 管理 > メッセージリスト コンソールでもメッセージリストを表示できます。
-
この操作では、WhatsAppおよび Viber チャンネルタイプのメッセージリストのクエリのみがサポートされています。
-
この操作を呼び出す前に、WhatsAppまたは Viber チャンネルを作成し、電話番号またはマーチャントアカウント ID をバインドし、審査に合格したテンプレートを作成し、チャンネルを通じてメッセージを送信していることを確認してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cams:ListChatappMessage |
list |
*すべてのリソース。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| BusinessNumber |
string |
必須 |
ビジネス電話番号。 |
8613800**** |
| StartTime |
integer |
任意 |
開始時刻。この値はミリ秒単位の UNIX タイムスタンプです。 |
1727057232686 |
| EndTime |
integer |
任意 |
終了時刻。この値はミリ秒単位の UNIX タイムスタンプです。 |
1727057232686 |
| EventAction |
string |
任意 |
メッセージタイプ。有効な値:
列挙値:
|
UP |
| UserNumber |
string |
任意 |
ユーザーの電話番号。これは、チャンネル管理 > 管理 > メッセージ送信 コンソールでメッセージを送信する際にインポートした電話番号です。 |
86138*** |
| ChannelType |
string |
必須 |
チャンネルタイプ。有効な値:
|
|
| ClientAcceptStatus |
string |
任意 |
ユーザーのメッセージ受信ステータス。 |
success |
| TemplateCode |
string |
任意 |
テンプレートコード。チャンネル管理 > 管理 > テンプレートデザイン コンソールでテンプレートコードを確認できます。 |
9938*** |
| GroupMessageId |
string |
任意 |
一括メッセージ ID。チャンネル管理 > 管理 > メッセージリスト > 一括送信リスト コンソールで一括メッセージ ID を確認できます。 |
9292**** |
| MessageStatus |
string |
任意 |
メッセージステータス。 |
success |
| CustSpaceId |
string |
必須 |
ISV サブ顧客のスペース ID または直接顧客のインスタンス ID。チャンネル管理 コンソールでスペース ID を確認できます。 |
cams-************ |
| Page |
object |
必須 |
ページネーションオブジェクト。 |
|
| Size |
integer |
必須 |
ページサイズ。 |
10 |
| Index |
integer |
必須 |
ページ番号。 |
1 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| AccessDeniedDetail |
string |
アクセス拒否の詳細。 |
None |
| Message |
string |
エラーメッセージ。 |
None |
| RequestId |
string |
リクエスト ID。 |
608F9CCA-B5EB-3D72-8047-B25D6D75BDEC |
| Data |
array<object> |
返されたデータオブジェクトのリスト。 |
|
|
object |
返されたデータ。 |
||
| ConversationId |
string |
会話 ID。 |
805a66************************** |
| BusinessNumber |
string |
ビジネス電話番号。 |
86183******** |
| ClientAcceptStatusName |
string |
メッセージ受信ステータスの名前。 |
Success |
| Message |
string |
メッセージ本文。 |
test |
| MessageTypeName |
string |
メッセージタイプ名。 |
interactive |
| FailReason |
string |
送信失敗の理由。 |
timeout |
| EventActionName |
string |
インバウンドまたはアウトバウンドメッセージタイプの名前。有効な値:
|
DOWN |
| Month |
string |
メッセージの月。 |
202507 |
| LanguageCode |
string |
テンプレートの言語。その他の言語については、「言語コード」を参照してください。 |
en |
| TemplateName |
string |
テンプレート名。 |
picture_template |
| MessageType |
string |
メッセージタイプ。 |
INTERACTIVE |
| SendTime |
string |
送信時刻。 |
2025-07-11T01:16:49.761+00:00 |
| MessageStatusName |
string |
メッセージステータス名。 |
Success |
| ClientReadStatus |
string |
メッセージの読み取りステータス。 |
success |
| MessageSource |
string |
メッセージのソース。 |
api |
| FailBackFlag |
string |
メッセージが SMS にフォールバックするかどうかを示します。有効な値:
|
Y |
| UserNumber |
string |
ユーザーの電話番号。 |
86177******** |
| TemplateCode |
string |
テンプレートコード。 |
1103*************** |
| MessageStatus |
string |
メッセージステータス。 |
success |
| Type |
string |
タイプ。 |
message |
| FailBackContent |
string |
フォールバックコンテンツ。 |
None |
| EventAction |
string |
インバウンドまたはアウトバウンドメッセージタイプ。 |
DOWN |
| ClientReadStatusName |
string |
メッセージの読み取りステータス名。 |
Success |
| UniqueMessageId |
string |
一意のメッセージ ID。 |
20250911****************************** |
| ChannelType |
string |
チャンネルタイプ。 |
|
| MessageId |
string |
メッセージ ID。 |
202509******************* |
| Code |
string |
応答コード。
|
OK |
| Success |
boolean |
呼び出しが成功したかどうかを示します。有効な値:
|
false |
例
成功レスポンス
JSONJSON
{
"AccessDeniedDetail": "None",
"Message": "None",
"RequestId": "608F9CCA-B5EB-3D72-8047-B25D6D75BDEC",
"Data": [
{
"ConversationId": "805a66**************************",
"BusinessNumber": "86183********",
"ClientAcceptStatusName": "Success",
"Message": "test",
"MessageTypeName": "interactive",
"FailReason": "timeout",
"EventActionName": "DOWN",
"Month": "202507",
"LanguageCode": "en",
"TemplateName": "picture_template",
"MessageType": "INTERACTIVE",
"SendTime": "2025-07-11T01:16:49.761+00:00",
"MessageStatusName": "Success",
"ClientReadStatus": "success",
"MessageSource": "api",
"FailBackFlag": "Y",
"UserNumber": "86177********",
"TemplateCode": "1103***************",
"MessageStatus": "success",
"Type": "message",
"FailBackContent": "None",
"EventAction": "DOWN",
"ClientReadStatusName": "Success",
"UniqueMessageId": "20250911******************************",
"ChannelType": "WHATSAPP",
"MessageId": "202509*******************"
}
],
"Code": "OK",
"Success": false
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。