{"MsgType": "","MsgContent": {}}
フィールド | タイプ | 説明 |
MsgType | String | メッセージ要素タイプ。現在サポートされているメッセージオブジェクトには、TIMTextElem(テキストメッセージ)、TIMLocationElem(位置メッセージ)、TIMFaceElem(顔絵文字メッセージ)、TIMCustomElem(カスタムメッセージ)、TIMSoundElem(音声メッセージ)、TIMImageElem(画像メッセージ)、TIMFileElem(ファイルメッセージ)、TIMVideoFileElem(ビデオメッセージ)が含まれます。 |
MsgContent | Object | メッセージ要素の内容。MsgTypeが異なれば、MsgContent形式も異なります。詳細については、下記の文をご参照ください。 |
MsgTypeの値 | タイプ |
TIMTextElem | テキストメッセージ。 |
TIMLocationElem | 地理的位置メッセージ。 |
TIMFaceElem | 顔絵文字メッセージ。 |
TIMCustomElem | カスタムメッセージ。受信者がiOSシステムで、アプリケーションがバックグラウンドにある場合、このメッセージタイプはテキスト以外のフィールドをAPNに送信できます。結合されたメッセージには、TIMCustomElemカスタムメッセージ要素を1つしか含めることができません。 |
TIMSoundElem | 音声メッセージ。 |
TIMImageElem | 画像メッセージ。 |
TIMFileElem | ファイルメッセージ。 |
TIMVideoFileElem | ビデオメッセージ。 |
{"MsgType": "TIMTextElem","MsgContent": {"Text": "hello world"}}
フィールド | タイプ | 説明 |
Text | String | メッセージ内容。受信者がiOSまたはAndroidのバックグラウンドでオンラインの場合、オフラインプッシュのテキストとして表示されます。 |
{"MsgType": "TIMLocationElem","MsgContent": {"Desc": "someinfo","Latitude": 29.340656774469956,"Longitude": 116.77497920478824}}
フィールド | タイプ | 説明 |
Desc | String | 地理的位置の説明情報。 |
Latitude | Number | 緯度。 |
Longitude | Number | 経度。 |
{"MsgType": "TIMFaceElem","MsgContent": {"Index": 1,"Data": "content"}}
フィールド | タイプ | 説明 |
Index | Number | 顔絵文字インデックス、ユーザーカスタマイズ。 |
Data | String | 追加データ。 |
{"MsgType": "TIMCustomElem","MsgContent": {"Data": "message","Desc": "notification","Ext": "url","Sound": "dingdong.aiff"}}
フィールド | タイプ | 説明 |
Data | String | カスタムメッセージデータ。APNsのpayloadフィールドとして発行されないため、payloadからDataフィールドを取得できません。 |
Desc | String | カスタムメッセージの説明情報。受信者がiOSまたはAndroidのバックグラウンドでオンラインの場合、オフラインプッシュテキストを表示します。 カスタムメッセージの送信中にOfflinePushInfo.Descフィールドが同時に設定されている場合、このフィールドは上書きされますので、OfflinePushInfo.Descフィールドを優先的に入力してください。 说明: メッセージにTIMCustomElemカスタムメッセージ要素が1つしかない場合、DescフィールドとOfflinePushInfo.Descフィールドが入力されていないと、メッセージのオフラインプッシュを受信できません。このメッセージのオフラインプッシュを受信するには、OfflinePushInfo.Descフィールドに入力する必要があります。 |
Ext | String | 拡張フィールド。受信者がiOSシステムで、アプリケーションがバックグラウンドにある場合、このフィールドはAPNリクエストパケットPayloadsのExtキー値として発行されます。Extのプロトコル形式は業務側が決定し、APNsは透過的な送信のみを行います。|
|Sound|String|APNsのプッシュリングトーンをカスタマイズします。 |
Sound | String | APNsのプッシュリングトーンをカスタマイズします。 |
{"MsgType": "TIMSoundElem","MsgContent": {"Url": "https://1234-5678187359-1253735226.cos.ap-shanghai.myqcloud.com/abc123/c9be9d32c05bfb77b3edafa4312c6c7d","UUID": "1053D4B3D61040894AC3DE44CDF28B3EC7EB7C0F","Size": 62351,"Second": 1,"Download_Flag": 2}}
フィールド | タイプ | 説明 |
Url | String | 音声ダウンロードアドレス。対応する音声は、このURLアドレスから直接ダウンロードできます。 |
UUID | String | 音声の一意の識別子。クライアントが音声にインデックスを付けるために用いるキー値。 |
Size | Number | 音声データサイズ。単位:バイト。 |
Second | Number | 音声の長さ。単位:秒。 |
Download_Flag | Number | 音声ダウンロード方法のフラグ。現在、Download_Flagの値は2のみです。これは、 Url フィールド値のURLアドレスを介して音声を直接ダウンロードできることを意味します。 |
{"MsgType": "TIMSoundElem","MsgContent": {"UUID": "305c0201"、//音声の一意の識別子。タイプはStringです。クライアントが音声にインデックスを付けるために用いるキー値です。このフィールドからは、対応する音声をダウンロードできません。音声を取得する必要がある場合は、IM SDKバージョンを4.Xにアップグレードしてください。"Size": 62351, //音声データサイズ、タイプはNumber、単位:バイト。"Second": 1 //音声の長さ、タイプはNumber。単位:秒。}}
{"MsgType": "TIMImageElem","MsgContent": {"UUID": "1853095_D61040894AC3DE44CDFFFB3EC7EB720F","ImageFormat": 1,"ImageInfoArray": [{"Type": 1, //元の画像"Size": 1853095,"Width": 2448,"Height": 3264,"URL": "http://xxx/3200490432214177468_144115198371610486_D61040894AC3DE44CDFFFB3EC7EB720F/0"},{"Type": 2, //大きな画像"Size": 2565240,"Width": 0,"Height": 0,"URL": "http://xxx/3200490432214177468_144115198371610486_D61040894AC3DE44CDFFFB3EC7EB720F/720"},{"Type": 3, //サムネイル"Size": 12535,"Width": 0,"Height": 0,"URL": "http://xxx/3200490432214177468_144115198371610486_D61040894AC3DE44CDFFFB3EC7EB720F/198"}]}}
フィールド | タイプ | 説明 |
UUID | String | 画像の一意の識別子。クライアントが画像にインデックスを付けるために用いるキー値。 |
ImageFormat | Number | 画像形式。JPG = 1、GIF = 2、PNG = 3、BMP = 4、その他 = 255。 |
ImageInfoArray | Array | 元の画像、サムネイル、または大きな画像のダウンロード情報。 |
Type | Number | 画像タイプ:1-元の画像、2-大きな画像、3-サムネイル。 |
Size | Number | 画像データサイズ。単位:バイト。 |
Width | Number | 画像幅。単位はピクセル。 |
Height | Number | 画像高さ。単位はピクセル。 |
URL | String | 画像のダウンロードアドレス。 |
{"MsgType": "TIMFileElem","MsgContent": {"Url": "https://7492-5678539059-1253735326.cos.ap-shanghai.myqcloud.com/abc123/49be9d32c0fbfba7b31dafa4312c6c7d","UUID": "1053D4B3D61040894AC3DE44CDF28B3EC7EB7C0F","FileSize": 1773552,"FileName": "file:///private/var/Application/tmp/trim.B75D5F9B-1426-4913-8845-90DD46797FCD.MOV","Download_Flag": 2}}
フィールド | タイプ | 説明 |
Url | String | ファイルのダウンロードアドレス。対応するファイルは、このURLアドレスから直接ダウンロードできます。 |
UUID | String | ファイルの一意の識別子。クライアントがファイルにインデックスを付けるために用いるキー値。 |
FileSize | Number | ファイルデータサイズ。単位:バイト。 |
FileName | String | ファイル名。 |
Download_Flag | Number | ファイルダウンロード方法のフラグ。現在、Download_Flagの値は2のみです。これは、 Url フィールドの値のURLアドレスを介してファイルを直接ダウンロードできることを意味します。 |
{"MsgType": "TIMFileElem","MsgContent": {"UUID": "305c02010", //ファイルの一意の識別子。タイプはStringです。クライアントがファイルにインデックスを付けるために用いるキー値です。このフィールドからは、対応するファイルをダウンロードできません。このファイルを取得する必要がある場合は、IM SDKバージョンを4.Xにアップグレードしてください。"FileSize": 1773552,//ファイルデータサイズ。タイプはNumber、単位はバイトです。"FileName": "file:///private/var/Application/tmp/trim.B75D5F9B-1426-4913-8845-90DD46797FCD.MOV" //ファイル名。タイプはStringです。}}
{ "MsgType": "TIMVideoFileElem", "MsgContent": { "VideoUrl": "https://0345-1400187352-1256635546.cos.ap-shanghai.myqcloud.com/abcd/f7c6ad3c50af7d83e23efe0a208b90c9", "VideoUUID": "5da38ba89d6521011e1f6f3fd6692e35", "VideoSize": 1194603, "VideoSecond": 5, "VideoFormat": "mp4", "VideoDownloadFlag":2, "ThumbUrl": "https://0345-1400187352-1256635546.cos.ap-shanghai.myqcloud.com/abcd/a6c170c9c599280cb06e0523d7a1f37b", "ThumbUUID": "6edaffedef5150684510cf97957b7bc8", "ThumbSize": 13907, "ThumbWidth": 720, "ThumbHeight": 1280, "ThumbFormat": "JPG", "ThumbDownloadFlag":2 } }
フィールド | タイプ | 説明 |
VideoUrl | String | ビデオダウンロードアドレス。対応するビデオは、このURLアドレスから直接ダウンロードできます。 |
VideoUUID | String | ビデオの一意の識別子、クライアントがビデオにインデックスを付けるために用いるキー値。 |
VideoSize | Number | ビデオデータサイズ。単位:バイト。 |
VideoSecond | Number | ビデオ時間。単位:秒。Web端末は、ビデオ時間の取得をサポートしません。値は0です。 |
VideoFormat | String | mp4などのビデオ形式。 |
VideoDownloadFlag | Number | ビデオダウンロード方法のフラグ。現在、VideoDownloadFlagの値は2のみです。これは、``VideoUrlフィールドの値のURLアドレスを介してビデオを直接ダウンロードできることを意味します。 |
ThumbUrl | String | ビデオサムネイルアドレス。対応するビデオサムネイルは、このURLアドレスから直接ダウンロードできます。 |
ThumbUUID | String | ビデオサムネイルの一意の識別子。クライアントがビデオサムネイルにインデックスを付けるために用いるキー値。 |
ThumbSize | Number | サムネイルサイズ。単位:バイト。 |
ThumbWidth | Number | サムネイルの幅。単位はピクセル。 |
ThumbHeight | Number | サムネイルの高さ。単位はピクセル。 |
ThumbFormat | String | JPG、BMPなどのサムネイル形式。 |
ThumbDownloadFlag | Number | ビデオサムネイルダウンロード方法のフラグ。現在、ThumbDownloadFlagの値は2のみです。これは、``ThumbUrlフィールド値のURLアドレスを介してビデオサムネイルを直接ダウンロードできることを意味します。 |
{"MsgType": "TIMVideoFileElem","MsgContent": {"VideoUUID": "1400123456_dramon_34ca36be7dd214dc50a49238ef80a6b5"、//ビデオの一意の識別子。タイプはStringです。クライアントがビデオにインデックスを付けるために用いるキー値です。このフィールドからは、対応するビデオをダウンロードできません。このビデオを取得する必要がある場合は、IM SDKバージョンを4.Xにアップグレードしてください。"VideoSize": 1194603,//ビデオデータサイズ。タイプはNumber。単位:バイト。"VideoSecond": 5,//ビデオの長さ。タイプはNumber。単位:秒。"VideoFormat": "mp4",//ビデオ形式。タイプはmp4などのStringです。"ThumbUUID": "1400123456_dramon_893f5a7a4872676ae142c08acd49c18a"、//ビデオサムネイルの一意の識別子。タイプはStringです。クライアントがビデオサムネイルにインデックスを付けるために用いるキー値です。このフィールドからは、対応するビデオサムネイルをダウンロードできません。このビデオサムネイルを取得する必要がある場合は、IM SDKバージョンを4.Xにアップグレードしてください。"ThumbSize": 13907,//サムネイルサイズ。タイプは数値。単位:バイト。"ThumbWidth": 720,//サムネイルの幅。 タイプはNumberです。"ThumbHeight": 1280,//サムネイルの高さ。タイプはNumberです。"ThumbFormat": "JPG" //サムネイル形式。タイプはJPG、BMPなどのStringです。}}
{"MsgType": "TIMRelayElem","MsgContent": {"Title": "グループチャットの記録","MsgNum": 2,"CompatibleText": "このSDKバージョンはマージ転送メッセージをサポートしていません。新しいバージョンにアップグレードしてください。","AbstractList": ["A:これについて、みなさんはどう思いますか?","B:とても良いと思います"],"MsgList": [{"From_Account": "A","GroupId": "group1","MsgSeq": 85,"MsgRandom": 3998651049,"MsgTimeStamp": 1664437702,"MsgBody": [{"MsgContent": {"Text": "これについて、みなさんはどう思いますか?"},"MsgType": "TIMTextElem"}]},{"From_Account": "B","GroupId": "group1","MsgSeq": 86,"MsgRandom": 965790,"MsgTimeStamp": 1664437703,"MsgBody": [{"MsgContent": {"Text": "とても良いと思います"},"MsgType": "TIMTextElem"}]}]}}
フィールド | タイプ | 説明 |
Title | String | マージ転送メッセージのタイトル。 |
MsgNum | Integer | 転送されたメッセージの数。 |
CompatibleText | String | 互換性のあるテキスト。マージ転送メッセージをサポートしていない古いバージョンのSDKがそのようなメッセージを受信すると、IMバックグラウンドはこのメッセージを送信する前に互換性のあるテキストに変換します。 |
AbstractList | Array | マージされたメッセージのダイジェストリスト。Stringの配列です。 |
MsgList | Array | メッセージリスト。このフィールドは、転送されたメッセージの長さの合計が12KB以下の場合にのみ表示され、現時点ではJsonMsgKeyフィールドはありません。 |
JsonMsgKey | String | マージ転送されたメッセージリストKey。このフィールドは、転送されたメッセージの長さの合計が12KBよりも大きい場合にのみ表示され、現時点ではJsonMsgKeyフィールドはありません。 |
フィールド | タイプ | 説明 |
From_Account | String | メッセージ送信側UserID。このフィールドは、転送されたメッセージがシングルチャットまたはグループチャットの場合に表示されます。 |
To_Account | String | メッセージ受信側UserID。このフィールドは、転送されたメッセージがシングルチャットの場合にのみ表示されます。 |
GroupId | String | グループID。このフィールドは、転送されたメッセージがグループチャットの場合にのみ表示されます。 |
MsgSeq | Integer | メッセージのシーケンス番号(32ビットの符号なし整数)。 |
MsgRandom | Integer | メッセージ乱数(32ビットの符号なし整数)。 |
MsgTimeStamp | Integer | メッセージの秒レベルのタイムスタンプ。 |
MsgBody | Array | |
CloudCustomData | String | メッセージカスタムデータ(クラウドに保存され、反対側に送信され、プログラムをアンインストールして再インストールした後にプルできます)。 |
{"MsgBody": [{"MsgType": "TIMTextElem","MsgContent": {"Text": "hello world"}}]}
{"MsgBody": [{"MsgType": "TIMTextElem","MsgContent": {"Text": "hello"}},{"MsgType": "TIMFaceElem","MsgContent": {"Index": 1,"Data": "content"}},{"MsgType": "TIMTextElem","MsgContent": {"Text": "world"}}]}
{"MsgBody": [{"MsgType": "TIMTextElem","MsgContent": {"Text": "hello"}}],"CloudCustomData": "your cloud custom data"}
{"MsgBody": [{"MsgType": "TIMTextElem","MsgContent": {"Text": "hello"}},{"MsgType": "TIMCustomElem","MsgContent": {"Data": "message","Desc": "world","Ext": "https://www.example.com","Sound": "dingdong.aiff"}}]}
MsgTypeの値 | タイプ | メッセージ要素プッシュテキスト |
TIMTextElem | テキストメッセージ。 | Textフィールド。 |
TIMLocationElem | 地理的位置メッセージ。 | 中国語版オフラインプッシュテキストは「[位置]」、英語版は「[Location]」です。 |
TIMFaceElem | 顔絵文字メッセージ。 | 中国語版オフラインプッシュテキストは「[表情]」、英語版は「[Face]」です。 |
TIMCustomElem | カスタムメッセージ。 | Descフィールド。 |
{"To_Account": "lumotuwe5","MsgRandom": 121212,"MsgBody": [{"MsgType": "TIMCustomElem","MsgContent": {"Data": "other information","Desc": "hello","Ext": "www.qq.com","Sound": "dingdong.aiff"}},{"MsgType": "TIMTextElem","MsgContent": {"Text": "world"}}]}
{"aps": {"alert": "Nickname:helloworld"、//各メッセージ要素のプッシュテキストシーケンスが重ねられます"badge": 5,"sound": "dingdong.aiff" //TIMCustomElemのSoundフィールドに対応します},"ext": "www.qq.com" //TIMCustomElemのExtフィールドに対応します}
{// ..."MsgBody": [...] // これはMsgBodyに関する説明です"OfflinePushInfo": {"PushFlag": 0,"Title":"これはプッシュタイトルです""Desc": "これはオフラインプッシュ内容です""Ext": "これは透過的なコンテンツです""AndroidInfo": {"Sound": "android.mp3","OPPOChannelID": "test_OPPO_channel_id","VIVOClassification": 1},"ApnsInfo": {"Sound": "apns.mp3","BadgeMode": 1,"Title":"apns title","SubTitle":"apns subtitle","Image":"www.image.com","MutableContent": 1}}}
フィールド | タイプ | 属性 | 説明 |
PushFlag | Integer | オプション | 「0」はプッシュを表し、「1」はオフラインプッシュでないことを表します。 |
Title | String | オプション | オフラインプッシュタイトル。このフィールドはiOSとAndroidで共有されています。 |
Desc | String | オプション | 送信されるメッセージにTIMCustomElemカスタムメッセージ要素が1つしかない場合、このDescフィールドはTIMCustomElemのDescフィールドを上書きします。Descフィールドの両方ともに入力されていない場合、カスタムメッセージのオフラインプッシュは受信できません。 |
Ext | String | オプション | オフラインプッシュ透過的コンテンツ。国内のAndroidスマホメーカーごとにプッシュプラットフォームの要件が異なるため、このフィールドがJSON形式であることを確認してください。JSON形式でない場合、一部のベンダーからオフラインプッシュを受信できなくなる可能性があります。 |
AndroidInfo.Sound | String | オプション | Androidオフラインプッシュ音声ファイルパス。 |
AndroidInfo.HuaWeiChannelID | String | オプション | HuaweiスマホEMUI 10.0以降の通知チャネルフィールド。 このフィールドがブランクでない場合、コンソールによって設定されたChannelID値は上書きされます。このフィールドが空の場合、コンソールによって設定されたChannelID値は上書きされません。 |
AndroidInfo.XiaoMiChannelID | String | オプション | XiaomiスマホMIUI 10以降の通知カテゴリ(Channel)適合フィールド。 このフィールドがブランクでない場合、コンソールによって構成されたChannelID値は上書きされます。このフィールドがブランクの場合、コンソールによって構成されたChannelID値は上書きされません。 |
AndroidInfo.OPPOChannelID | String | オプション | OPPOスマホAndroid 8.0以降のNotificationChannel通知適合フィールド。このフィールドがブランクでない場合、コンソールによって設定されたChannelID値は上書きされます。このフィールドがブランクの場合、コンソールによって設定されたChannelID値は上書きされません。 |
AndroidInfo.GoogleChannelID | String | オプション | GoogleスマホAndroid 8.0以降の通知チャネルフィールド。Googleプッシュの新しいインターフェース(アップロード証明書ファイル)はchannel idをサポートし、古いインターフェース(サーバーキーの入力)はサポートしません。 |
AndroidInfo.VIVOClassification | Integer | オプション | VIVOスマホプッシュメッセージの分類。「0」は運用メッセージを表し、「1」はシステムメッセージを表します。入力されていない場合、デフォルトで「1」になります。 |
AndroidInfo.HuaWeiImportance | String | オプション | Huaweiプッシュ通知メッセージの分類。値はLOW、NORMALであり、入力されていない場合のデフォルト値はNORMALです。 |
AndroidInfo.ExtAsHuaweiIntentParam | Integer | オプション | コンソールでHuaweiプッシュを「アプリで指定されたページを開く」ように設定することを前提として、「1」が渡された場合、透過的コンテンツExtがIntentのパラメータとして使用されることを表し、「0」は透過的コンテンツExtがActionパラメータとして使用されることを表します。入力されていない場合、デフォルト値は0です。渡される2つのパラメータの違いについては、Huaweiプッシュドキュメントをご参照ください。 |
AndroidInfo.HuaWeiCategory | String | オプション | Huaweiスマホでメッセージのタイプを識別するために使用されます。このフィールドがブランクでない場合、コンソールによって設定されたcategory値は上書きされます。このフィールドが空の場合、コンソールによって設定されたcategory値は上書きされません。 |
ApnsInfo.BadgeMode | Integer | オプション | このフィールドをデフォルトのままにするか、「0」に設定すると、メッセージをカウントする必要があることを表し、「1」に設定すると、このメッセージをカウントする必要がないことを表します。この場合、右上隅のアイコンの数字は増加しません。 |
ApnsInfo.Title | String | オプション | このフィールドは、APNsによってプッシュされたタイトルを識別するために用いられます。入力すると、最上位階層のTitleが上書きされます。 |
ApnsInfo.SubTitle | String | オプション | このフィールドは、APNsによってプッシュされたサブタイトルを識別するために用いられます。 |
ApnsInfo.Image | String | オプション | このフィールドは、APNsが持つ画像アドレスを識別するために用いられます。クライアントがこのフィールドを取得すると、画像リソースをダウンロードすることにより、ポップアップウィンドウに画像を表示することができます。 |
ApnsInfo.MutableContent | Integer | オプション | 「1」は、iOS 10のプッシュ拡張のオンを表します。デフォルトは「0」です。 |
この記事はお役に立ちましたか?