twilio.rest.chat.v3 package¶
Submodules¶
twilio.rest.chat.v3.channel module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.chat.v3.channel.
ChannelContext
(version, service_sid, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
update
(type=<object object>, messaging_service_sid=<object object>, x_twilio_webhook_enabled=<object object>)[source]¶ Update the ChannelInstance
Parameters: - type (ChannelInstance.ChannelType) – The Type for this Channel to migrate to.
- messaging_service_sid (unicode) – The unique ID of the Messaging Service this channel belongs to.
- x_twilio_webhook_enabled (ChannelInstance.WebhookEnabledType) – The X-Twilio-Webhook-Enabled HTTP request header
Returns: The updated ChannelInstance
Return type:
-
-
class
twilio.rest.chat.v3.channel.
ChannelInstance
(version, payload, service_sid=None, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
account_sid
¶ Returns: The SID of the Account that created the resource Return type: unicode
-
attributes
¶ Returns: The JSON string that stores application-specific data Return type: unicode
-
created_by
¶ Returns: The identity of the User that created the channel Return type: unicode
-
date_created
¶ Returns: The ISO 8601 date and time in GMT when the resource was created Return type: datetime
-
date_updated
¶ Returns: The ISO 8601 date and time in GMT when the resource was last updated Return type: datetime
-
friendly_name
¶ Returns: The string that you assigned to describe the resource Return type: unicode
-
members_count
¶ Returns: The number of Members in the Channel Return type: unicode
-
messages_count
¶ Returns: The number of Messages that have been passed in the Channel Return type: unicode
-
messaging_service_sid
¶ Returns: The unique ID of the Messaging Service this channel belongs to. Return type: unicode
-
service_sid
¶ Returns: The SID of the Service that the resource is associated with Return type: unicode
-
sid
¶ Returns: The unique string that identifies the resource Return type: unicode
-
type
¶ Returns: The visibility of the channel. Can be: public or private Return type: ChannelInstance.ChannelType
-
unique_name
¶ Returns: An application-defined string that uniquely identifies the resource Return type: unicode
-
update
(type=<object object>, messaging_service_sid=<object object>, x_twilio_webhook_enabled=<object object>)[source]¶ Update the ChannelInstance
Parameters: - type (ChannelInstance.ChannelType) – The Type for this Channel to migrate to.
- messaging_service_sid (unicode) – The unique ID of the Messaging Service this channel belongs to.
- x_twilio_webhook_enabled (ChannelInstance.WebhookEnabledType) – The X-Twilio-Webhook-Enabled HTTP request header
Returns: The updated ChannelInstance
Return type:
-
url
¶ Returns: The absolute URL of the Channel resource Return type: unicode
-
-
class
twilio.rest.chat.v3.channel.
ChannelList
(version)[source]¶
-
class
twilio.rest.chat.v3.channel.
ChannelPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of ChannelInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.chat.v3.channel.ChannelInstance Return type: twilio.rest.chat.v3.channel.ChannelInstance
-
Module contents¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.chat.v3.
V3
(domain)[source]¶ Bases:
twilio.base.version.Version
-
channels
¶ Return type: twilio.rest.chat.v3.channel.ChannelList
-