メニュー

Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

メッセージリソース

Programmable ChatのMessageリソースは、サービスインスタンスにおけるチャネル内の単一のメッセージを表します。チャネルのMessagesリソースにPOSTすると、REST API経由でチャネルにメッセージを送信できます。

プロパティ

各メッセージに次のプロパティがあります。

Names in Node.js format
sid
sid<IM> Not PII

このリソースを一意に識別する 34 文字の文字列です。

accountSid
sid<AC> Not PII

このメッセージに関連するアカウントのユニーク ID です。

attributes
文字列 PII MTL: 120 DAYS

A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified.

serviceSid
sid<IS> Not PII

このメッセージが属するサービスのユニーク ID です。

to
sid<CH> Not PII

このメッセージの送信先チャンネルのユニーク ID です。

channelSid
sid<CH> Not PII

dateCreated
date_time<iso8601> Not PII

このリソースの作成された日付です。

dateUpdated
date_time<iso8601> Not PII

このリソースが最後に更新された日付です。 編集されていない場合はnullを返します。

lastUpdatedBy
文字列 PII MTL: 120 DAYS

Field to specify the Identity of the User that last updated the Message (if relevant)

wasEdited
boolean Not PII

true の場合、メッセージは作成後に更新されています。false の場合、メッセージは変更されたことがありません。

from
文字列 PII MTL: 120 DAYS

メッセージの作成者のアイデンティティです。デフォルトは system です。

body
文字列 PII MTL: 120 DAYS

メッセージの内容です。

index
integer Not PII

チャンネル内のメッセージのインデックスです。

type
文字列 Not PII

Message type. Can be text or media currently, representing if it's text message or media message accordingly.

media
オブジェクト Not PII

If a Media resource instance (file) is attached to the Message, this will contain the Media object for the attached Media. null if no Media is attached to the Message. See the table below for the details.

url
url Not PII

このメッセージの絶対 URL です。

Media resource object properties:

name description
sid このリソースを一意に識別する 34 文字の文字列です。
content_type MIME content type which reflects uploaded file type. For example: video/mp4, image/jpeg, etc.
filename Optional — provided filename for the file uploaded. May be null.
Size Uploaded file size in bytes

チャンネルのすべてのメッセージをリストにする

GET /Services/{Service SID}/Channels/{Channel SID}/Messages

パラメーター

Names in Node.js format
serviceSid
必須
GET sid<IS> Not PII

Sid of the Service this message belongs to.

channelSid
必須
GET sid_like<CH> Not PII

Key of the Channel this message belongs to. Could be Sid or UniqueName

order
オプション
GET enum:order_type Not PII

Specifies sorting order for messages list, possible values are: asc or desc. If no value is specified, then asc is used as the default.

        
        
        
        

        チャンネルにメッセージを送信する

        POST /Services/{Service SID}/Channels/{Channel SID}/Messages
        

        パラメーター

        Names in Node.js format
        serviceSid
        必須
        post sid<IS> Not PII

        Sid of the Service this message belongs to.

        channelSid
        必須
        post sid_like<CH> Not PII

        Key of the Channel this message belongs to. Could be Sid or UniqueName

        from
        オプション
        post 文字列 PII MTL: 120 DAYS

        メッセージの作成者のアイデンティティです。デフォルトは system です。

        attributes
        オプション
        post 文字列 PII MTL: 120 DAYS

        An string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that this will always be null for resources returned via LIST GET operations, but will be present for single GET operations.

        dateCreated
        オプション
        post date_time<iso8601> Not PII

        The ISO8601 time specifying the datetime the Message should be set as being created. Will be set to the current time by the Chat service if not specified. Note that this should only be used in cases where a Chat's history is being recreated from a backup/separate source.

        dateUpdated
        オプション
        post date_time<iso8601> Not PII

        The ISO8601 time specifying the datetime the Message should be set as having been last updated. Will be set to the null by the Chat service if not specified. Note that this should only be used in cases where a Chat's history is being recreated from a backup/separate source and where a Message was previously updated.

        lastUpdatedBy
        オプション
        post 文字列 PII MTL: 120 DAYS

        Specify the Identity of the User that last updated the Message (if relevant)

        body
        オプション
        post 文字列 PII MTL: 120 DAYS

        A string message to send to this channel. You can also send structured data by serializing it into a string. May be empty string or null, will be set as empty string as a result in this cases.

        mediaSid
        オプション
        post sid<ME> Not PII

        The Media Sid to be attached to this Message.

              
              
              
              

              チャンネルからメッセージを取得する

              GET /Services/{Service SID}/Channels/{Channel SID}/Messages/{Message SID}
              
                    
                    
                    
                    

                    既存のメッセージを更新する

                    POST /Services/{Service SID}/Channels/{Channel SID}/Messages/{Message SID}
                    

                    パラメーター

                    Names in Node.js format
                    serviceSid
                    必須
                    post sid<IS> Not PII

                    Sid of the Service this message belongs to.

                    channelSid
                    必須
                    post sid_like<CH> Not PII

                    Key of the Channel this message belongs to. Could be Sid or UniqueName

                    sid
                    必須
                    post sid<IM> Not PII

                    Key that uniquely defines the message to update.

                    body
                    オプション
                    post 文字列 PII MTL: 120 DAYS

                    The message body string. You can also send structured data by serializing it into a string. May be updated to empty string or null, will be set as empty string as a result in this cases.

                    attributes
                    オプション
                    post 文字列 PII MTL: 120 DAYS

                    A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that this will always be null for resources returned via LIST GET operations, but will be present for single GET operations.

                    dateCreated
                    オプション
                    post date_time<iso8601> Not PII

                    The ISO8601 time specifying the datetime the Message should be set as being created.

                    dateUpdated
                    オプション
                    post date_time<iso8601> Not PII

                    The ISO8601 time specifying the datetime the Message should be set as having been last updated.

                    lastUpdatedBy
                    オプション
                    post 文字列 PII MTL: 120 DAYS

                    Specify the Identity of the User that last updated the Message (if relevant)

                    from
                    オプション
                    post 文字列 PII MTL: 120 DAYS

                    The identity of the message's author.

                          
                          
                          
                          

                          チャンネルからメッセージを削除する

                          DELETE /Services/{Service SID}/Channels/{Channel SID}/Messages/{Message SID}
                          
                                
                                
                                
                                
                                Rate this page:

                                ヘルプが必要ですか?

                                We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.