Conversation Message Resource
APIのベースURL
リファレンスドキュメントの URL はすべて、次のベース URL を使用しています。
https://conversations.twilio.com/v1Using the shortened base URL
Using the REST API, you can interact with Conversation Message resources in the default Conversation Service instance via a "shortened" URL that does not include the Conversation Service instance SID ("ISXXX..."). If you are only using one Conversation Service (the default), you do not need to include the Conversation Service SID in your URL, e.g.
GET /v1/Conversations/CHxx/Messages
For Conversations applications that build on more than one Conversation Service instance, you will need to specify the Conversation Service SID in the REST API call:
GET /v1/Services/ISxx/Conversations/CHxx/MessagesConversationMessage properties
| Resource Properties in REST API format | |
|---|---|
account_sid
|
The unique ID of the Account responsible for this message. |
conversation_sid
|
The unique ID of the Conversation for this message. |
sid
|
このリソースを一意に識別する 34 文字の文字列です。 |
index
|
The index of the message within the Conversation. Indices may skip numbers, but will always be in order of when the message was received. |
author
|
The channel specific identifier of the message's author. Defaults to |
body
|
The content of the message, can be up to 1,600 characters long. |
media
|
An array of objects that describe the Message's media, if the message contains media. Each object contains these fields: |
attributes
|
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 if the attributes are not set "{}" will be returned. |
participant_sid
|
The unique ID of messages's author participant. Null in case of |
date_created
|
このリソースの作成された日付です。 |
date_updated
|
このリソースが最後に更新された日付です。 編集されていない場合は |
url
|
An absolute API resource API URL for this message. |
delivery
|
An object that contains the summary of delivery statuses for the message to non-chat participants. |
links
|
Contains an absolute API resource URL to access the delivery & read receipts of this message. |
Create a ConversationMessage resource
https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Messages
パラメーター
| Parameters in REST API format | |
|---|---|
conversation_sid
Path
|
The unique ID of the Conversation for this message. |
author
オプション
|
The channel specific identifier of the message's author. Defaults to |
body
オプション
|
The content of the message, can be up to 1,600 characters long. |
date_created
オプション
|
このリソースの作成された日付です。 |
date_updated
オプション
|
このリソースが最後に更新された日付です。 編集されていない場合は |
attributes
オプション
|
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 if the attributes are not set "{}" will be returned. |
media_sid
オプション
|
The Media SID to be attached to the new Message. |
x_twilio_webhook_enabled
ヘッダー
|
The X-Twilio-Webhook-Enabled HTTP request header |
例 1
Fetch a ConversationMessage resource
https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Messages/{Sid}
パラメーター
| Parameters in REST API format | |
|---|---|
conversation_sid
Path
|
The unique ID of the Conversation for this message. |
sid
Path
|
このリソースを一意に識別する 34 文字の文字列です。 |
例 1
List all Conversation Message(s)
https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Messages
パラメーター
| Parameters in REST API format | |
|---|---|
conversation_sid
Path
|
The unique ID of the Conversation for messages. |
order
オプション
|
The sort order of the returned messages. Can be: |
例 1
例 2
Update a ConversationMessage resource
https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Messages/{Sid}
パラメーター
| Parameters in REST API format | |
|---|---|
conversation_sid
Path
|
The unique ID of the Conversation for this message. |
sid
Path
|
このリソースを一意に識別する 34 文字の文字列です。 |
author
オプション
|
The channel specific identifier of the message's author. Defaults to |
body
オプション
|
The content of the message, can be up to 1,600 characters long. |
date_created
オプション
|
このリソースの作成された日付です。 |
date_updated
オプション
|
このリソースが最後に更新された日付です。 編集されていない場合は |
attributes
オプション
|
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 if the attributes are not set "{}" will be returned. |
x_twilio_webhook_enabled
ヘッダー
|
The X-Twilio-Webhook-Enabled HTTP request header |
例 1
Delete a ConversationMessage resource
https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Messages/{Sid}
パラメーター
| Parameters in REST API format | |
|---|---|
conversation_sid
Path
|
The unique ID of the Conversation for this message. |
sid
Path
|
このリソースを一意に識別する 34 文字の文字列です。 |
x_twilio_webhook_enabled
ヘッダー
|
The X-Twilio-Webhook-Enabled HTTP request header |
例 1
ヘルプが必要ですか？
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.