twilio-ruby 6.4.0 → 6.6.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGES.md +36 -0
- data/README.md +2 -2
- data/lib/twilio-ruby/rest/api/v2010/account/message/feedback.rb +4 -4
- data/lib/twilio-ruby/rest/api/v2010/account/message.rb +19 -6
- data/lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb +19 -19
- data/lib/twilio-ruby/rest/flex_api/v1/configuration.rb +7 -0
- data/lib/twilio-ruby/rest/insights/v1/room/participant.rb +3 -3
- data/lib/twilio-ruby/rest/media/v1/media_processor.rb +7 -7
- data/lib/twilio-ruby/rest/media/v1/media_recording.rb +1 -1
- data/lib/twilio-ruby/rest/media/v1/player_streamer.rb +2 -2
- data/lib/twilio-ruby/rest/messaging/v1/service/channel_sender.rb +329 -0
- data/lib/twilio-ruby/rest/messaging/v1/service.rb +31 -4
- data/lib/twilio-ruby/rest/numbers/v2/bulk_hosted_number_order.rb +249 -0
- data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb +19 -19
- data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance.rb +14 -14
- data/lib/twilio-ruby/rest/numbers/v2.rb +15 -0
- data/lib/twilio-ruby/rest/video/v1/room.rb +2 -2
- data/lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb +4 -4
- data/lib/twilio-ruby/version.rb +1 -1
- metadata +4 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 342853723bf8d9a243b81e603c11cdaff04fc230
|
4
|
+
data.tar.gz: 38e211b1f826265046247bbd71f1542f34bbea78
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bea2ea6fa4daeb7c8cbf435b2fbdbb562a8f7ab76c4f0b260875beb3293d7e48093de1930e5dcf40d8d4c4acccf01ba23d13566a3b7c680b508fd65b42539ad8
|
7
|
+
data.tar.gz: f949bd0bf82da86466909a3d7cce04bee87cbed4882169db07e7e4dbd264bc0d02d3f7b7d9f33e79596582a662f3acdfa3e255754ead30241509365b77a4c7db
|
data/CHANGES.md
CHANGED
@@ -1,6 +1,42 @@
|
|
1
1
|
twilio-ruby changelog
|
2
2
|
=====================
|
3
3
|
|
4
|
+
[2023-09-07] Version 6.6.0
|
5
|
+
--------------------------
|
6
|
+
**Api**
|
7
|
+
- Make message tagging parameters public **(breaking change)**
|
8
|
+
|
9
|
+
**Flex**
|
10
|
+
- Adding `agent_conv_end_methods` to Flex Configuration
|
11
|
+
|
12
|
+
**Messaging**
|
13
|
+
- Mark Mesasging Services fallback_to_long_code feature obsolete
|
14
|
+
|
15
|
+
**Numbers**
|
16
|
+
- Add Create Port In request api
|
17
|
+
- Renaming sid for bulk_hosting_sid and remove account_sid response field in numbers/v2/BulkHostedNumberOrders **(breaking change)**
|
18
|
+
|
19
|
+
**Pricing**
|
20
|
+
- gate resources behind a beta_feature
|
21
|
+
|
22
|
+
|
23
|
+
[2023-08-24] Version 6.5.0
|
24
|
+
--------------------------
|
25
|
+
**Api**
|
26
|
+
- Add new property `RiskCheck` for SMS pumping protection feature only (public beta to be available soon): Include this parameter with a value of `disable` to skip any kind of risk check on the respective message request
|
27
|
+
|
28
|
+
**Flex**
|
29
|
+
- Changing `sid<UO>` path param to `sid<UT>` in interaction channel participant update endpoint **(breaking change)**
|
30
|
+
|
31
|
+
**Messaging**
|
32
|
+
- Add Channel Sender api
|
33
|
+
- Fixing country code docs and removing Zipwhip references
|
34
|
+
|
35
|
+
**Numbers**
|
36
|
+
- Request status changed in numbers/v2/BulkHostedNumberOrders **(breaking change)**
|
37
|
+
- Add bulk hosting orders API under version `/v2
|
38
|
+
|
39
|
+
|
4
40
|
[2023-08-10] Version 6.4.0
|
5
41
|
--------------------------
|
6
42
|
**Library - Fix**
|
data/README.md
CHANGED
@@ -39,13 +39,13 @@ This library supports the following Ruby implementations:
|
|
39
39
|
To install using [Bundler][bundler] grab the latest stable version:
|
40
40
|
|
41
41
|
```ruby
|
42
|
-
gem 'twilio-ruby', '~> 6.
|
42
|
+
gem 'twilio-ruby', '~> 6.6.0'
|
43
43
|
```
|
44
44
|
|
45
45
|
To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
|
46
46
|
|
47
47
|
```bash
|
48
|
-
gem install twilio-ruby -v 6.
|
48
|
+
gem install twilio-ruby -v 6.6.0
|
49
49
|
```
|
50
50
|
|
51
51
|
To build and install the development branch yourself from the latest source:
|
@@ -116,13 +116,13 @@ module Twilio
|
|
116
116
|
|
117
117
|
|
118
118
|
##
|
119
|
-
# @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account)
|
119
|
+
# @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) associated with this MessageFeedback resource.
|
120
120
|
def account_sid
|
121
121
|
@properties['account_sid']
|
122
122
|
end
|
123
123
|
|
124
124
|
##
|
125
|
-
# @return [String] The SID of the Message resource
|
125
|
+
# @return [String] The SID of the Message resource associated with this MessageFeedback resource.
|
126
126
|
def message_sid
|
127
127
|
@properties['message_sid']
|
128
128
|
end
|
@@ -134,13 +134,13 @@ module Twilio
|
|
134
134
|
end
|
135
135
|
|
136
136
|
##
|
137
|
-
# @return [Time] The date and time in GMT
|
137
|
+
# @return [Time] The date and time in GMT when this MessageFeedback resource was created, specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
|
138
138
|
def date_created
|
139
139
|
@properties['date_created']
|
140
140
|
end
|
141
141
|
|
142
142
|
##
|
143
|
-
# @return [Time] The date and time in GMT
|
143
|
+
# @return [Time] The date and time in GMT when this MessageFeedback resource was last updated, specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
|
144
144
|
def date_updated
|
145
145
|
@properties['date_updated']
|
146
146
|
end
|
@@ -33,8 +33,8 @@ module Twilio
|
|
33
33
|
end
|
34
34
|
##
|
35
35
|
# Create the MessageInstance
|
36
|
-
# @param [String] to The recipient's phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (for SMS/MMS) or [channel address](https://www.twilio.com/docs/
|
37
|
-
# @param [String] status_callback The URL of the endpoint to which Twilio sends [Message status callback requests](https://www.twilio.com/docs/sms/api/message-resource#twilios-request-to-the-statuscallback-url). URL must contain a valid hostname and underscores are not allowed. If you include this parameter with the `messaging_service_sid`, Twilio uses this URL instead of the Status Callback URL of the [Messaging Service](https://www.twilio.com/docs/messaging/
|
36
|
+
# @param [String] to The recipient's phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (for SMS/MMS) or [channel address](https://www.twilio.com/docs/messaging/channels), e.g. `whatsapp:+15552229999`.
|
37
|
+
# @param [String] status_callback The URL of the endpoint to which Twilio sends [Message status callback requests](https://www.twilio.com/docs/sms/api/message-resource#twilios-request-to-the-statuscallback-url). URL must contain a valid hostname and underscores are not allowed. If you include this parameter with the `messaging_service_sid`, Twilio uses this URL instead of the Status Callback URL of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource).
|
38
38
|
# @param [String] application_sid The SID of the associated [TwiML Application](https://www.twilio.com/docs/usage/api/applications). If this parameter is provided, the `status_callback` parameter of this request is ignored; [Message status callback requests](https://www.twilio.com/docs/sms/api/message-resource#twilios-request-to-the-statuscallback-url) are sent to the TwiML App's `message_status_callback` URL.
|
39
39
|
# @param [Float] max_price The maximum price in US dollars that you are willing to pay for this Message's delivery. The value can have up to four decimal places. When the `max_price` parameter is provided, the cost of a message is checked before it is sent. If the cost exceeds `max_price`, the message is not sent and the Message `status` is `failed`.
|
40
40
|
# @param [Boolean] provide_feedback Boolean indicating whether or not you intend to provide delivery confirmation feedback to Twilio (used in conjunction with the [Message Feedback subresource](https://www.twilio.com/docs/sms/api/message-feedback-resource)). Default value is `false`.
|
@@ -50,7 +50,9 @@ module Twilio
|
|
50
50
|
# @param [Time] send_at The time that Twilio will send the message. Must be in ISO 8601 format.
|
51
51
|
# @param [Boolean] send_as_mms If set to `true`, Twilio delivers the message as a single MMS message, regardless of the presence of media.
|
52
52
|
# @param [String] content_variables For [Content Editor/API](https://www.twilio.com/docs/content) only: Key-value pairs of [Template variables](https://www.twilio.com/docs/content/using-variables-with-content-api) and their substitution values. `content_sid` parameter must also be provided. If values are not defined in the `content_variables` parameter, the [Template's default placeholder values](https://www.twilio.com/docs/content/content-api-resources#create-templates) are used.
|
53
|
-
# @param [String]
|
53
|
+
# @param [String] tags A string containing a JSON map of key value pairs of tags to be recorded as metadata for the message. The object may contain up to 10 tags. Keys and values can each be up to 128 characters in length.
|
54
|
+
# @param [RiskCheck] risk_check
|
55
|
+
# @param [String] from The sender's Twilio phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), [Wireless SIM](https://www.twilio.com/docs/iot/wireless/programmable-wireless-send-machine-machine-sms-commands), [short code](https://www.twilio.com/docs/sms/api/short-code), or [channel address](https://www.twilio.com/docs/messaging/channels) (e.g., `whatsapp:+15554449999`). The value of the `from` parameter must be a sender that is hosted within Twilio and belong to the Account creating the Message. If you are using `messaging_service_sid`, this parameter can be empty (Twilio assigns a `from` value from the Messaging Service's Sender Pool) or you can provide a specific sender from your Sender Pool.
|
54
56
|
# @param [String] messaging_service_sid The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services) you want to associate with the Message. When this parameter is provided and the `from` parameter is omitted, Twilio selects the optimal sender from the Messaging Service's Sender Pool. You may also provide a `from` parameter if you want to use a specific Sender from the Sender Pool.
|
55
57
|
# @param [String] body The text content of the outgoing message. Can be up to 1,600 characters in length. SMS only: If the `body` contains more than 160 [GSM-7](https://www.twilio.com/docs/glossary/what-is-gsm-7-character-encoding) characters (or 70 [UCS-2](https://www.twilio.com/docs/glossary/what-is-ucs-2-character-encoding) characters), the message is segmented and charged accordingly. For long `body` text, consider using the [send_as_mms parameter](https://www.twilio.com/blog/mms-for-long-text-messages).
|
56
58
|
# @param [Array[String]] media_url The URL of media to include in the Message content. `jpeg`, `jpg`, `gif`, and `png` file types are fully supported by Twilio and content is formatted for delivery on destination devices. The media size limit is 5 MB for supported file types (`jpeg`, `jpg`, `png`, `gif`) and 500 KB for [other types](https://www.twilio.com/docs/sms/accepted-mime-types) of accepted media. To send more than one image in the message, provide multiple `media_url` parameters in the POST request. You can include up to ten `media_url` parameters per message. [International](https://support.twilio.com/hc/en-us/articles/223179808-Sending-and-receiving-MMS-messages) and [carrier](https://support.twilio.com/hc/en-us/articles/223133707-Is-MMS-supported-for-all-carriers-in-US-and-Canada-) limits apply.
|
@@ -74,6 +76,8 @@ module Twilio
|
|
74
76
|
send_at: :unset,
|
75
77
|
send_as_mms: :unset,
|
76
78
|
content_variables: :unset,
|
79
|
+
tags: :unset,
|
80
|
+
risk_check: :unset,
|
77
81
|
from: :unset,
|
78
82
|
messaging_service_sid: :unset,
|
79
83
|
body: :unset,
|
@@ -99,6 +103,8 @@ module Twilio
|
|
99
103
|
'SendAt' => Twilio.serialize_iso8601_datetime(send_at),
|
100
104
|
'SendAsMms' => send_as_mms,
|
101
105
|
'ContentVariables' => content_variables,
|
106
|
+
'Tags' => tags,
|
107
|
+
'RiskCheck' => risk_check,
|
102
108
|
'From' => from,
|
103
109
|
'MessagingServiceSid' => messaging_service_sid,
|
104
110
|
'Body' => body,
|
@@ -411,6 +417,7 @@ module Twilio
|
|
411
417
|
'price_unit' => payload['price_unit'],
|
412
418
|
'api_version' => payload['api_version'],
|
413
419
|
'subresource_uris' => payload['subresource_uris'],
|
420
|
+
'tags' => payload['tags'],
|
414
421
|
}
|
415
422
|
|
416
423
|
# Context
|
@@ -448,13 +455,13 @@ module Twilio
|
|
448
455
|
end
|
449
456
|
|
450
457
|
##
|
451
|
-
# @return [String] The sender's phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), [Wireless SIM](https://www.twilio.com/docs/wireless/
|
458
|
+
# @return [String] The sender's phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), [Wireless SIM](https://www.twilio.com/docs/iot/wireless/programmable-wireless-send-machine-machine-sms-commands), [short code](https://www.twilio.com/docs/sms/api/short-code), or [channel address](https://www.twilio.com/docs/messaging/channels) (e.g., `whatsapp:+15554449999`). For incoming messages, this is the number or channel address of the sender. For outgoing messages, this value is a Twilio phone number, alphanumeric sender ID, short code, or channel address from which the message is sent.
|
452
459
|
def from
|
453
460
|
@properties['from']
|
454
461
|
end
|
455
462
|
|
456
463
|
##
|
457
|
-
# @return [String] The recipient's phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format) or [channel address](https://www.twilio.com/docs/
|
464
|
+
# @return [String] The recipient's phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format) or [channel address](https://www.twilio.com/docs/messaging/channels) (e.g. `whatsapp:+15552229999`)
|
458
465
|
def to
|
459
466
|
@properties['to']
|
460
467
|
end
|
@@ -502,7 +509,7 @@ module Twilio
|
|
502
509
|
end
|
503
510
|
|
504
511
|
##
|
505
|
-
# @return [String] The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/
|
512
|
+
# @return [String] The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) associated with the Message resource. The value is `null` if a Messaging Service was not used.
|
506
513
|
def messaging_service_sid
|
507
514
|
@properties['messaging_service_sid']
|
508
515
|
end
|
@@ -549,6 +556,12 @@ module Twilio
|
|
549
556
|
@properties['subresource_uris']
|
550
557
|
end
|
551
558
|
|
559
|
+
##
|
560
|
+
# @return [Hash] A string containing a JSON map of key value pairs of tags to be recorded as metadata for the message.
|
561
|
+
def tags
|
562
|
+
@properties['tags']
|
563
|
+
end
|
564
|
+
|
552
565
|
##
|
553
566
|
# Delete the MessageInstance
|
554
567
|
# @return [Boolean] True if delete succeeds, false otherwise
|
@@ -34,13 +34,13 @@ module Twilio
|
|
34
34
|
end
|
35
35
|
##
|
36
36
|
# Create the ParticipantInstance
|
37
|
-
# @param [String] identity A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversation SDK to communicate. Limited to 256 characters.
|
38
|
-
# @param [String] messaging_binding_address The address of the participant's device, e.g. a phone or WhatsApp number. Together with the Proxy address, this determines a participant uniquely. This field (with proxy_address) is only null when the participant is interacting from an SDK endpoint (see the
|
39
|
-
# @param [String] messaging_binding_proxy_address The address of the Twilio phone number (or WhatsApp number) that the participant is in contact with. This field, together with participant address, is only null when the participant is interacting from an SDK endpoint (see the
|
40
|
-
# @param [Time] date_created The date
|
41
|
-
# @param [Time] date_updated The date
|
42
|
-
# @param [String] attributes An optional 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
|
43
|
-
# @param [String] messaging_binding_projected_address The address of the Twilio phone number that is used in Group MMS.
|
37
|
+
# @param [String] identity A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters.
|
38
|
+
# @param [String] messaging_binding_address The address of the participant's device, e.g. a phone or WhatsApp number. Together with the Proxy address, this determines a participant uniquely. This field (with `proxy_address`) is only null when the participant is interacting from an SDK endpoint (see the `identity` field).
|
39
|
+
# @param [String] messaging_binding_proxy_address The address of the Twilio phone number (or WhatsApp number) that the participant is in contact with. This field, together with participant address, is only null when the participant is interacting from an SDK endpoint (see the `identity` field).
|
40
|
+
# @param [Time] date_created The date on which this resource was created.
|
41
|
+
# @param [Time] date_updated The date on which this resource was last updated.
|
42
|
+
# @param [String] attributes An optional 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.
|
43
|
+
# @param [String] messaging_binding_projected_address The address of the Twilio phone number that is used in Group MMS.
|
44
44
|
# @param [String] role_sid The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant.
|
45
45
|
# @param [ServiceConversationParticipantEnumWebhookEnabledType] x_twilio_webhook_enabled The X-Twilio-Webhook-Enabled HTTP request header
|
46
46
|
# @return [ParticipantInstance] Created ParticipantInstance
|
@@ -217,10 +217,10 @@ module Twilio
|
|
217
217
|
|
218
218
|
##
|
219
219
|
# Update the ParticipantInstance
|
220
|
-
# @param [Time] date_created The date
|
221
|
-
# @param [Time] date_updated The date
|
222
|
-
# @param [String] identity A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversation SDK to communicate. Limited to 256 characters.
|
223
|
-
# @param [String] attributes An optional 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
|
220
|
+
# @param [Time] date_created The date on which this resource was created.
|
221
|
+
# @param [Time] date_updated The date on which this resource was last updated.
|
222
|
+
# @param [String] identity A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters.
|
223
|
+
# @param [String] attributes An optional 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.
|
224
224
|
# @param [String] role_sid The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant.
|
225
225
|
# @param [String] messaging_binding_proxy_address The address of the Twilio phone number that the participant is in contact with. 'null' value will remove it.
|
226
226
|
# @param [String] messaging_binding_projected_address The address of the Twilio phone number that is used in Group MMS. 'null' value will remove it.
|
@@ -379,13 +379,13 @@ module Twilio
|
|
379
379
|
end
|
380
380
|
|
381
381
|
##
|
382
|
-
# @return [String] A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversation SDK to communicate. Limited to 256 characters.
|
382
|
+
# @return [String] A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters.
|
383
383
|
def identity
|
384
384
|
@properties['identity']
|
385
385
|
end
|
386
386
|
|
387
387
|
##
|
388
|
-
# @return [String] An optional 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
|
388
|
+
# @return [String] An optional 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.
|
389
389
|
def attributes
|
390
390
|
@properties['attributes']
|
391
391
|
end
|
@@ -403,13 +403,13 @@ module Twilio
|
|
403
403
|
end
|
404
404
|
|
405
405
|
##
|
406
|
-
# @return [Time] The date
|
406
|
+
# @return [Time] The date on which this resource was created.
|
407
407
|
def date_created
|
408
408
|
@properties['date_created']
|
409
409
|
end
|
410
410
|
|
411
411
|
##
|
412
|
-
# @return [Time] The date
|
412
|
+
# @return [Time] The date on which this resource was last updated.
|
413
413
|
def date_updated
|
414
414
|
@properties['date_updated']
|
415
415
|
end
|
@@ -455,10 +455,10 @@ module Twilio
|
|
455
455
|
|
456
456
|
##
|
457
457
|
# Update the ParticipantInstance
|
458
|
-
# @param [Time] date_created The date
|
459
|
-
# @param [Time] date_updated The date
|
460
|
-
# @param [String] identity A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversation SDK to communicate. Limited to 256 characters.
|
461
|
-
# @param [String] attributes An optional 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
|
458
|
+
# @param [Time] date_created The date on which this resource was created.
|
459
|
+
# @param [Time] date_updated The date on which this resource was last updated.
|
460
|
+
# @param [String] identity A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters.
|
461
|
+
# @param [String] attributes An optional 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.
|
462
462
|
# @param [String] role_sid The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant.
|
463
463
|
# @param [String] messaging_binding_proxy_address The address of the Twilio phone number that the participant is in contact with. 'null' value will remove it.
|
464
464
|
# @param [String] messaging_binding_projected_address The address of the Twilio phone number that is used in Group MMS. 'null' value will remove it.
|
@@ -175,6 +175,7 @@ module Twilio
|
|
175
175
|
'channel_configs' => payload['channel_configs'],
|
176
176
|
'debugger_integration' => payload['debugger_integration'],
|
177
177
|
'flex_ui_status_report' => payload['flex_ui_status_report'],
|
178
|
+
'agent_conv_end_methods' => payload['agent_conv_end_methods'],
|
178
179
|
}
|
179
180
|
|
180
181
|
# Context
|
@@ -463,6 +464,12 @@ module Twilio
|
|
463
464
|
@properties['flex_ui_status_report']
|
464
465
|
end
|
465
466
|
|
467
|
+
##
|
468
|
+
# @return [Hash] Agent conversation end methods.
|
469
|
+
def agent_conv_end_methods
|
470
|
+
@properties['agent_conv_end_methods']
|
471
|
+
end
|
472
|
+
|
466
473
|
##
|
467
474
|
# Fetch the ConfigurationInstance
|
468
475
|
# @param [String] ui_version The Pinned UI version of the Configuration resource to fetch.
|
@@ -306,7 +306,7 @@ module Twilio
|
|
306
306
|
end
|
307
307
|
|
308
308
|
##
|
309
|
-
# @return [String] Reason the participant left the room. See [the list of possible values here](https://www.twilio.com/docs/video/
|
309
|
+
# @return [String] Reason the participant left the room. See [the list of possible values here](https://www.twilio.com/docs/video/troubleshooting/video-log-analyzer-api#end_reason).
|
310
310
|
def end_reason
|
311
311
|
@properties['end_reason']
|
312
312
|
end
|
@@ -330,7 +330,7 @@ module Twilio
|
|
330
330
|
end
|
331
331
|
|
332
332
|
##
|
333
|
-
# @return [Hash] Object containing information about the participant's data from the room. See [below](https://www.twilio.com/docs/video/
|
333
|
+
# @return [Hash] Object containing information about the participant's data from the room. See [below](https://www.twilio.com/docs/video/troubleshooting/video-log-analyzer-api#properties) for more information.
|
334
334
|
def properties
|
335
335
|
@properties['properties']
|
336
336
|
end
|
@@ -342,7 +342,7 @@ module Twilio
|
|
342
342
|
end
|
343
343
|
|
344
344
|
##
|
345
|
-
# @return [Hash] Object containing information about the SDK name and version. See [below](https://www.twilio.com/docs/video/
|
345
|
+
# @return [Hash] Object containing information about the SDK name and version. See [below](https://www.twilio.com/docs/video/troubleshooting/video-log-analyzer-api#publisher_info) for more information.
|
346
346
|
def publisher_info
|
347
347
|
@properties['publisher_info']
|
348
348
|
end
|
@@ -31,10 +31,10 @@ module Twilio
|
|
31
31
|
end
|
32
32
|
##
|
33
33
|
# Create the MediaProcessorInstance
|
34
|
-
# @param [String] extension The [Media Extension](/docs/live/
|
35
|
-
# @param [String] extension_context The context of the Media Extension, represented as a JSON dictionary. See the documentation for the specific [Media Extension](/docs/live/
|
36
|
-
# @param [Object] extension_environment User-defined environment variables for the Media Extension, represented as a JSON dictionary of key/value strings. See the documentation for the specific [Media Extension](/docs/live/
|
37
|
-
# @param [String] status_callback The URL to which Twilio will send asynchronous webhook requests for every MediaProcessor event. See [Status Callbacks](/docs/live/status-callbacks) for details.
|
34
|
+
# @param [String] extension The [Media Extension](/docs/live/media-extensions-overview) name or URL. Ex: `video-composer-v2`
|
35
|
+
# @param [String] extension_context The context of the Media Extension, represented as a JSON dictionary. See the documentation for the specific [Media Extension](/docs/live/media-extensions-overview) you are using for more information about the context to send.
|
36
|
+
# @param [Object] extension_environment User-defined environment variables for the Media Extension, represented as a JSON dictionary of key/value strings. See the documentation for the specific [Media Extension](/docs/live/media-extensions-overview) you are using for more information about whether you need to provide this.
|
37
|
+
# @param [String] status_callback The URL to which Twilio will send asynchronous webhook requests for every MediaProcessor event. See [Status Callbacks](/docs/live/api/status-callbacks) for details.
|
38
38
|
# @param [String] status_callback_method The HTTP method Twilio should use to call the `status_callback` URL. Can be `POST` or `GET` and the default is `POST`.
|
39
39
|
# @param [String] max_duration The maximum time, in seconds, that the MediaProcessor can run before automatically ends. The default value is 300 seconds, and the maximum value is 90000 seconds. Once this maximum duration is reached, Twilio will end the MediaProcessor, regardless of whether media is still streaming.
|
40
40
|
# @return [MediaProcessorInstance] Created MediaProcessorInstance
|
@@ -331,13 +331,13 @@ module Twilio
|
|
331
331
|
end
|
332
332
|
|
333
333
|
##
|
334
|
-
# @return [String] The [Media Extension](/docs/live/
|
334
|
+
# @return [String] The [Media Extension](/docs/live/media-extensions-overview) name or URL. Ex: `video-composer-v2`
|
335
335
|
def extension
|
336
336
|
@properties['extension']
|
337
337
|
end
|
338
338
|
|
339
339
|
##
|
340
|
-
# @return [String] The context of the Media Extension, represented as a JSON dictionary. See the documentation for the specific [Media Extension](/docs/live/
|
340
|
+
# @return [String] The context of the Media Extension, represented as a JSON dictionary. See the documentation for the specific [Media Extension](/docs/live/media-extensions-overview) you are using for more information about the context to send.
|
341
341
|
def extension_context
|
342
342
|
@properties['extension_context']
|
343
343
|
end
|
@@ -361,7 +361,7 @@ module Twilio
|
|
361
361
|
end
|
362
362
|
|
363
363
|
##
|
364
|
-
# @return [String] The URL to which Twilio will send asynchronous webhook requests for every MediaProcessor event. See [Status Callbacks](/docs/live/status-callbacks) for details.
|
364
|
+
# @return [String] The URL to which Twilio will send asynchronous webhook requests for every MediaProcessor event. See [Status Callbacks](/docs/live/api/status-callbacks) for details.
|
365
365
|
def status_callback
|
366
366
|
@properties['status_callback']
|
367
367
|
end
|
@@ -350,7 +350,7 @@ module Twilio
|
|
350
350
|
end
|
351
351
|
|
352
352
|
##
|
353
|
-
# @return [String] The URL to which Twilio will send asynchronous webhook requests for every MediaRecording event. See [Status Callbacks](/docs/live/status-callbacks) for more details.
|
353
|
+
# @return [String] The URL to which Twilio will send asynchronous webhook requests for every MediaRecording event. See [Status Callbacks](/docs/live/api/status-callbacks) for more details.
|
354
354
|
def status_callback
|
355
355
|
@properties['status_callback']
|
356
356
|
end
|
@@ -32,7 +32,7 @@ module Twilio
|
|
32
32
|
##
|
33
33
|
# Create the PlayerStreamerInstance
|
34
34
|
# @param [Boolean] video Specifies whether the PlayerStreamer is configured to stream video. Defaults to `true`.
|
35
|
-
# @param [String] status_callback The URL to which Twilio will send asynchronous webhook requests for every PlayerStreamer event. See [Status Callbacks](/docs/live/status-callbacks) for more details.
|
35
|
+
# @param [String] status_callback The URL to which Twilio will send asynchronous webhook requests for every PlayerStreamer event. See [Status Callbacks](/docs/live/api/status-callbacks) for more details.
|
36
36
|
# @param [String] status_callback_method The HTTP method Twilio should use to call the `status_callback` URL. Can be `POST` or `GET` and the default is `POST`.
|
37
37
|
# @param [String] max_duration The maximum time, in seconds, that the PlayerStreamer is active (`created` or `started`) before automatically ends. The default value is 300 seconds, and the maximum value is 90000 seconds. Once this maximum duration is reached, Twilio will end the PlayerStreamer, regardless of whether media is still streaming.
|
38
38
|
# @return [PlayerStreamerInstance] Created PlayerStreamerInstance
|
@@ -360,7 +360,7 @@ module Twilio
|
|
360
360
|
end
|
361
361
|
|
362
362
|
##
|
363
|
-
# @return [String] The URL to which Twilio will send asynchronous webhook requests for every PlayerStreamer event. See [Status Callbacks](/docs/live/status-callbacks) for more details.
|
363
|
+
# @return [String] The URL to which Twilio will send asynchronous webhook requests for every PlayerStreamer event. See [Status Callbacks](/docs/live/api/status-callbacks) for more details.
|
364
364
|
def status_callback
|
365
365
|
@properties['status_callback']
|
366
366
|
end
|