チャンネルリソース
Programmable ChatのChannelリソースは「チャットルーム」、すなわちMessageの送受信できる範囲を表しています。
Memberを追加したり、Channelへの参加を招待できます。 ChannelはChat Serviceスコープ内に存在します。
指定されたUserがMemberである全Channelを返すUsers Channelの一覧を取得できます。
チャンネルには、オプションで、アドレス可能なユニーク名を付けることもできます。これにより、チャンネルに何か具体的な名前を付けて、直接検索したり、識別したりできます。ユニーク名は、サービスインスタンス内でユニークであるように強制されます。
Twilio コンソール
You can view your Chat Channels using your Twilio console when logged in to the console. Within a Service, you will be able to browse the Channels within the Service.
プロパティ
各チャンネルに次のプロパティがあります。
| Names in PHP format | |
|---|---|
sid
|
The unique string that we created to identify the Channel resource. |
accountSid
|
The SID of the Account that created the Channel resource. |
serviceSid
|
The SID of the Service the resource is associated with. |
friendlyName
|
The string that you assigned to describe the resource. |
uniqueName
|
An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's |
attributes
|
The JSON string that stores application-specific data. Note If this property has been assigned a value, it's only displayed in a FETCH action that returns a single resource; otherwise, it's null. If the attributes have not been set, |
type
|
The visibility of the channel. Can be: |
dateCreated
|
The date and time in GMT when the resource was created specified in RFC 2822 format. |
dateUpdated
|
The date and time in GMT when the resource was last updated specified in RFC 2822 format. |
createdBy
|
The |
membersCount
|
The number of Members in the Channel. |
messagesCount
|
The number of Messages in the Channel. |
url
|
The absolute URL of the Channel resource. |
links
|
The absolute URLs of the Members, Messages , Invites and, if it exists, the last Message for the Channel. |
| Names in PHP format | |
|---|---|
serviceSid
必須
|
The SID of the Service to read the resources from. |
type
オプション
|
The visibility of the Channels to read. Can be: |
| Names in PHP format | |
|---|---|
serviceSid
必須
|
The SID of the Service to create the resource under. |
friendlyName
オプション
|
A descriptive string that you create to describe the new resource. It can be up to 64 characters long. |
uniqueName
オプション
|
An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's |
attributes
オプション
|
A valid JSON string that contains application-specific data. |
type
オプション
|
The visibility of the channel. Can be: |
dateCreated
オプション
|
The date, specified in ISO 8601 format, to assign to the resource as the date it was created. The default is the current time set by the Chat service. Note that this should only be used in cases where a Channel is being recreated from a backup/separate source. |
dateUpdated
オプション
|
The date, specified in ISO 8601 format, to assign to the resource as the date it was last updated. The default value is |
createdBy
オプション
|
The |
主なレスポンスコード
| code | description |
|---|---|
| 409 Conflict | 指定された一意な名前のChannelがすでに存在します。 |
チャンネルを取得する
ChannelはSIDまたはUniqueName（一意な名前）から取得できます
Channel SID
GET /Services/{Service SID}/Channels/{Channel SID}
UniqueName
GET /Services/{Service SID}/Channels/{Unique Name}
チャンネルを更新する
You are able to update a Channel via the SID or UniqueName
Channel SID
POST /Services/{Service SID}/Channels/{Channel SID}
UniqueName
POST /Services/{Service SID}/Channels/{Unique Name}
パラメーター
| Names in PHP format | |
|---|---|
serviceSid
必須
|
The SID of the Service to update the resource from. |
sid
必須
|
The Twilio-provided string that uniquely identifies the Channel resource to update. |
friendlyName
オプション
|
A descriptive string that you create to describe the resource. It can be up to 64 characters long. |
uniqueName
オプション
|
An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's |
attributes
オプション
|
A valid JSON string that contains application-specific data. |
dateCreated
オプション
|
The date, specified in ISO 8601 format, to assign to the resource as the date it was created. |
dateUpdated
オプション
|
The date, specified in ISO 8601 format, to assign to the resource as the date it was last updated. |
createdBy
オプション
|
The |
チャンネルを削除する
You are able to delete a Channel via the SID or UniqueName
Channel SID
DELETE /Services/{Service SID}/Channels/{Channel SID}
UniqueName
DELETE /Services/{Service SID}/Channels/{Unique Name}
ヘルプが必要ですか？
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.