purecloud 0.63.1 → 0.64.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +3 -3
- data/config-ruby.json +1 -1
- data/doc_out/ADFS.html.md +1 -1
- data/doc_out/AggregationQuery.html.md +1 -1
- data/doc_out/AnalyticsConversationSegment.html.md +3 -3
- data/doc_out/AnalyticsSession.html.md +2 -2
- data/doc_out/AttributesApi.html.md +29 -29
- data/doc_out/AuditMessage.html.md +1 -1
- data/doc_out/Call.html.md +4 -4
- data/doc_out/CallForwarding.html.md +1 -1
- data/doc_out/CallMediaParticipant.html.md +6 -6
- data/doc_out/Callback.html.md +2 -2
- data/doc_out/CallbackMediaParticipant.html.md +4 -4
- data/doc_out/Campaign.html.md +1 -1
- data/doc_out/CampaignInteraction.html.md +1 -1
- data/doc_out/CampaignRule.html.md +2 -2
- data/doc_out/CampaignRuleActionEntities.html.md +1 -1
- data/doc_out/CampaignSequence.html.md +1 -1
- data/doc_out/CertificateDetails.html.md +3 -3
- data/doc_out/ChatMediaParticipant.html.md +3 -3
- data/doc_out/CobrowseMediaParticipant.html.md +3 -3
- data/doc_out/Condition.html.md +1 -1
- data/doc_out/ContactSort.html.md +1 -1
- data/doc_out/ContentQueryRequest.html.md +1 -1
- data/doc_out/ContentSortItem.html.md +1 -1
- data/doc_out/ConversationChat.html.md +1 -1
- data/doc_out/ConversationsApi.html.md +58 -58
- data/doc_out/CustomerInteractionCenter.html.md +1 -1
- data/doc_out/DialerContact.html.md +1 -1
- data/doc_out/Document.html.md +1 -1
- data/doc_out/DocumentAudit.html.md +1 -1
- data/doc_out/DocumentUpdate.html.md +1 -1
- data/doc_out/DomainCapabilities.html.md +4 -4
- data/doc_out/DomainEdgeSoftwareUpdateDto.html.md +2 -2
- data/doc_out/DomainEdgeSoftwareVersionDto.html.md +2 -2
- data/doc_out/DomainLogicalInterface.html.md +3 -3
- data/doc_out/DomainNetworkAddress.html.md +1 -1
- data/doc_out/DomainNetworkCommandResponse.html.md +1 -1
- data/doc_out/DomainNetworkRoute.html.md +1 -1
- data/doc_out/DomainOrganizationRole.html.md +3 -3
- data/doc_out/DomainOrganizationRoleCreate.html.md +3 -3
- data/doc_out/DomainOrganizationRoleUpdate.html.md +3 -3
- data/doc_out/DomainPermission.html.md +1 -1
- data/doc_out/DomainPermissionPolicy.html.md +1 -1
- data/doc_out/DomainPhysicalCapabilities.html.md +2 -2
- data/doc_out/Edge.html.md +2 -2
- data/doc_out/EdgeAutoUpdateConfig.html.md +2 -2
- data/doc_out/EdgeGroup.html.md +1 -1
- data/doc_out/EdgeLogsJobRequest.html.md +1 -1
- data/doc_out/Email.html.md +1 -1
- data/doc_out/EmailMediaParticipant.html.md +3 -3
- data/doc_out/Endpoint.html.md +1 -1
- data/doc_out/Evaluation.html.md +4 -4
- data/doc_out/EvaluationForm.html.md +1 -1
- data/doc_out/EvaluationScoringSet.html.md +1 -1
- data/doc_out/FaxDocument.html.md +1 -1
- data/doc_out/FieldList.html.md +3 -3
- data/doc_out/Geolocation.html.md +1 -1
- data/doc_out/GeolocationSettings.html.md +1 -1
- data/doc_out/GreetingsApi.html.md +50 -50
- data/doc_out/Group.html.md +1 -1
- data/doc_out/GroupUpdate.html.md +1 -1
- data/doc_out/GroupsApi.html.md +68 -68
- data/doc_out/HeartBeatRule.html.md +2 -2
- data/doc_out/IdentityProviderApi.html.md +22 -22
- data/doc_out/InboundDomain.html.md +1 -1
- data/doc_out/InitiateScreenRecording.html.md +1 -1
- data/doc_out/InteractionStatsAlert.html.md +1 -1
- data/doc_out/InteractionStatsRule.html.md +2 -2
- data/doc_out/JsonNode.html.md +20 -20
- data/doc_out/LineStatus.html.md +1 -1
- data/doc_out/LocationDefinition.html.md +1 -1
- data/doc_out/MediaParticipantRequest.html.md +5 -5
- data/doc_out/MeteredEvaluationAssignment.html.md +1 -1
- data/doc_out/OAuthProvider.html.md +1 -1
- data/doc_out/Okta.html.md +1 -1
- data/doc_out/OneLogin.html.md +1 -1
- data/doc_out/OrgMediaUtilization.html.md +1 -1
- data/doc_out/Organization.html.md +1 -1
- data/doc_out/OrganizationPresence.html.md +2 -2
- data/doc_out/OutOfOffice.html.md +1 -1
- data/doc_out/OutboundRoute.html.md +2 -2
- data/doc_out/Parameter.html.md +1 -1
- data/doc_out/Participant.html.md +2 -2
- data/doc_out/PhoneCapabilities.html.md +5 -5
- data/doc_out/PhoneNumberStatus.html.md +1 -1
- data/doc_out/Policy.html.md +1 -1
- data/doc_out/PolicyActions.html.md +3 -3
- data/doc_out/PolicyCreate.html.md +1 -1
- data/doc_out/PresenceApi.html.md +33 -33
- data/doc_out/PureCloud.html.md +1 -1
- data/doc_out/QueryRequest.html.md +1 -1
- data/doc_out/QuestionGroup.html.md +4 -4
- data/doc_out/QuestionGroupScore.html.md +1 -1
- data/doc_out/QuestionScore.html.md +2 -2
- data/doc_out/QueueMember.html.md +1 -1
- data/doc_out/RecordingApi.html.md +70 -70
- data/doc_out/ReportSchedule.html.md +1 -1
- data/doc_out/ResourcePermissionPolicy.html.md +1 -1
- data/doc_out/RoutingStatusRule.html.md +2 -2
- data/doc_out/Salesforce.html.md +1 -1
- data/doc_out/Screenshare.html.md +1 -1
- data/doc_out/ScriptsApi.html.md +72 -72
- data/doc_out/Site.html.md +1 -1
- data/doc_out/SocialExpression.html.md +1 -1
- data/doc_out/SortItem.html.md +1 -1
- data/doc_out/TagValue.html.md +1 -1
- data/doc_out/TimeAllowed.html.md +1 -1
- data/doc_out/TimeOffRequest.html.md +2 -2
- data/doc_out/TimeOffRequestPatch.html.md +1 -1
- data/doc_out/TransferRequest.html.md +1 -1
- data/doc_out/Trunk.html.md +1 -1
- data/doc_out/TrunkBase.html.md +1 -1
- data/doc_out/UnreadStatus.html.md +1 -1
- data/doc_out/UserPresence.html.md +1 -1
- data/doc_out/UserPresenceRule.html.md +2 -2
- data/doc_out/UserQueue.html.md +1 -1
- data/doc_out/UserRecording.html.md +1 -1
- data/doc_out/UserRecordingsApi.html.md +47 -47
- data/doc_out/UserScheduleAdherence.html.md +1 -1
- data/doc_out/ValidateAddressResponse.html.md +1 -1
- data/doc_out/Video.html.md +3 -3
- data/doc_out/VoicemailGroupPolicy.html.md +2 -2
- data/doc_out/VoicemailMessage.html.md +2 -2
- data/doc_out/VoicemailOrganizationPolicy.html.md +4 -4
- data/doc_out/VoicemailUserPolicy.html.md +1 -1
- data/doc_out/Workspace.html.md +1 -1
- data/doc_out/Wrapup.html.md +1 -1
- data/doc_out/index.html.md +3 -3
- data/lib/purecloud/api/attributes_api.rb +39 -39
- data/lib/purecloud/api/conversations_api.rb +58 -58
- data/lib/purecloud/api/greetings_api.rb +67 -67
- data/lib/purecloud/api/groups_api.rb +104 -104
- data/lib/purecloud/api/identity_provider_api.rb +33 -33
- data/lib/purecloud/api/presence_api.rb +46 -46
- data/lib/purecloud/api/recording_api.rb +76 -76
- data/lib/purecloud/api/scripts_api.rb +87 -87
- data/lib/purecloud/api/user_recordings_api.rb +64 -64
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/adfs.rb +2 -0
- data/lib/purecloud/models/aggregation_query.rb +2 -0
- data/lib/purecloud/models/analytics_conversation_segment.rb +6 -0
- data/lib/purecloud/models/analytics_session.rb +4 -0
- data/lib/purecloud/models/audit_message.rb +2 -0
- data/lib/purecloud/models/call.rb +8 -0
- data/lib/purecloud/models/call_forwarding.rb +2 -0
- data/lib/purecloud/models/call_media_participant.rb +12 -0
- data/lib/purecloud/models/callback.rb +4 -0
- data/lib/purecloud/models/callback_media_participant.rb +8 -0
- data/lib/purecloud/models/campaign.rb +2 -0
- data/lib/purecloud/models/campaign_interaction.rb +2 -0
- data/lib/purecloud/models/campaign_rule.rb +4 -0
- data/lib/purecloud/models/campaign_rule_action_entities.rb +2 -0
- data/lib/purecloud/models/campaign_sequence.rb +2 -0
- data/lib/purecloud/models/certificate_details.rb +6 -0
- data/lib/purecloud/models/chat_media_participant.rb +6 -0
- data/lib/purecloud/models/cobrowse_media_participant.rb +6 -0
- data/lib/purecloud/models/condition.rb +2 -0
- data/lib/purecloud/models/contact_sort.rb +2 -0
- data/lib/purecloud/models/content_query_request.rb +2 -0
- data/lib/purecloud/models/content_sort_item.rb +2 -0
- data/lib/purecloud/models/conversation_chat.rb +2 -0
- data/lib/purecloud/models/customer_interaction_center.rb +2 -0
- data/lib/purecloud/models/dialer_contact.rb +2 -0
- data/lib/purecloud/models/document.rb +2 -0
- data/lib/purecloud/models/document_audit.rb +2 -0
- data/lib/purecloud/models/document_update.rb +2 -0
- data/lib/purecloud/models/domain_capabilities.rb +8 -0
- data/lib/purecloud/models/domain_edge_software_update_dto.rb +4 -0
- data/lib/purecloud/models/domain_edge_software_version_dto.rb +4 -0
- data/lib/purecloud/models/domain_logical_interface.rb +6 -0
- data/lib/purecloud/models/domain_network_address.rb +2 -0
- data/lib/purecloud/models/domain_network_command_response.rb +2 -0
- data/lib/purecloud/models/domain_network_route.rb +2 -0
- data/lib/purecloud/models/domain_organization_role.rb +17 -11
- data/lib/purecloud/models/domain_organization_role_create.rb +17 -11
- data/lib/purecloud/models/domain_organization_role_update.rb +17 -11
- data/lib/purecloud/models/domain_permission.rb +2 -0
- data/lib/purecloud/models/domain_permission_policy.rb +2 -0
- data/lib/purecloud/models/domain_physical_capabilities.rb +4 -0
- data/lib/purecloud/models/edge.rb +4 -0
- data/lib/purecloud/models/edge_auto_update_config.rb +4 -4
- data/lib/purecloud/models/edge_group.rb +2 -0
- data/lib/purecloud/models/edge_logs_job_request.rb +2 -0
- data/lib/purecloud/models/email.rb +2 -0
- data/lib/purecloud/models/email_media_participant.rb +6 -0
- data/lib/purecloud/models/endpoint.rb +2 -0
- data/lib/purecloud/models/evaluation.rb +8 -0
- data/lib/purecloud/models/evaluation_form.rb +2 -0
- data/lib/purecloud/models/evaluation_scoring_set.rb +2 -0
- data/lib/purecloud/models/fax_document.rb +2 -0
- data/lib/purecloud/models/field_list.rb +6 -0
- data/lib/purecloud/models/geolocation.rb +2 -0
- data/lib/purecloud/models/geolocation_settings.rb +2 -0
- data/lib/purecloud/models/group.rb +2 -0
- data/lib/purecloud/models/group_update.rb +2 -0
- data/lib/purecloud/models/heart_beat_rule.rb +4 -0
- data/lib/purecloud/models/inbound_domain.rb +2 -0
- data/lib/purecloud/models/initiate_screen_recording.rb +2 -0
- data/lib/purecloud/models/interaction_stats_alert.rb +2 -0
- data/lib/purecloud/models/interaction_stats_rule.rb +4 -0
- data/lib/purecloud/models/json_node.rb +64 -24
- data/lib/purecloud/models/line_status.rb +2 -0
- data/lib/purecloud/models/location_definition.rb +2 -0
- data/lib/purecloud/models/media_participant_request.rb +10 -0
- data/lib/purecloud/models/metered_evaluation_assignment.rb +2 -0
- data/lib/purecloud/models/o_auth_provider.rb +2 -0
- data/lib/purecloud/models/okta.rb +2 -0
- data/lib/purecloud/models/one_login.rb +2 -0
- data/lib/purecloud/models/org_media_utilization.rb +2 -0
- data/lib/purecloud/models/organization.rb +2 -0
- data/lib/purecloud/models/organization_presence.rb +4 -0
- data/lib/purecloud/models/out_of_office.rb +2 -0
- data/lib/purecloud/models/outbound_route.rb +4 -0
- data/lib/purecloud/models/parameter.rb +2 -0
- data/lib/purecloud/models/participant.rb +4 -0
- data/lib/purecloud/models/phone_capabilities.rb +10 -0
- data/lib/purecloud/models/phone_number_status.rb +2 -0
- data/lib/purecloud/models/policy.rb +2 -0
- data/lib/purecloud/models/policy_actions.rb +6 -0
- data/lib/purecloud/models/policy_create.rb +2 -0
- data/lib/purecloud/models/pure_cloud.rb +2 -0
- data/lib/purecloud/models/query_request.rb +2 -0
- data/lib/purecloud/models/question_group.rb +8 -0
- data/lib/purecloud/models/question_group_score.rb +2 -0
- data/lib/purecloud/models/question_score.rb +4 -0
- data/lib/purecloud/models/queue_member.rb +2 -0
- data/lib/purecloud/models/report_schedule.rb +2 -0
- data/lib/purecloud/models/resource_permission_policy.rb +2 -0
- data/lib/purecloud/models/routing_status_rule.rb +4 -0
- data/lib/purecloud/models/salesforce.rb +2 -0
- data/lib/purecloud/models/screenshare.rb +2 -0
- data/lib/purecloud/models/site.rb +2 -0
- data/lib/purecloud/models/social_expression.rb +2 -0
- data/lib/purecloud/models/sort_item.rb +2 -0
- data/lib/purecloud/models/tag_value.rb +2 -0
- data/lib/purecloud/models/time_allowed.rb +2 -0
- data/lib/purecloud/models/time_off_request.rb +4 -0
- data/lib/purecloud/models/time_off_request_patch.rb +2 -0
- data/lib/purecloud/models/transfer_request.rb +2 -0
- data/lib/purecloud/models/trunk.rb +2 -0
- data/lib/purecloud/models/trunk_base.rb +2 -0
- data/lib/purecloud/models/unread_status.rb +2 -0
- data/lib/purecloud/models/user_presence.rb +2 -0
- data/lib/purecloud/models/user_presence_rule.rb +4 -0
- data/lib/purecloud/models/user_queue.rb +2 -0
- data/lib/purecloud/models/user_recording.rb +2 -0
- data/lib/purecloud/models/user_schedule_adherence.rb +2 -0
- data/lib/purecloud/models/validate_address_response.rb +2 -0
- data/lib/purecloud/models/video.rb +6 -0
- data/lib/purecloud/models/voicemail_group_policy.rb +4 -0
- data/lib/purecloud/models/voicemail_message.rb +4 -0
- data/lib/purecloud/models/voicemail_organization_policy.rb +8 -0
- data/lib/purecloud/models/voicemail_user_policy.rb +2 -0
- data/lib/purecloud/models/workspace.rb +2 -0
- data/lib/purecloud/models/wrapup.rb +2 -0
- data/lib/purecloud/version.rb +1 -1
- data/newVersion.md +1 -1
- data/swagger.json +1 -1
- data/version.json +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: aa5354d022001e321440f8d61942d91ce99c90bc
|
4
|
+
data.tar.gz: b2722824c228403d7e74bf75a22ecbd50802990c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 17c73fbba462a6f41fb7091c340a59a1e0fa2fa92135bac47c35602ef6f34022b3df5e0a5ec83717b846bb13f86c6f0feff7652aeffca27a640a9cc196e6ce39
|
7
|
+
data.tar.gz: a2db3fdc7f6a9444f31bf9925149d20bc07ba549cd23417b878978892efa93df7ae80139aa2278e629e3c1f6cd003da02017fb698ae3c4c44429748f292566b8
|
data/README.md
CHANGED
@@ -9,8 +9,8 @@ With the PureCloud Platform API, you can control all aspects of your PureCloud e
|
|
9
9
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
10
10
|
|
11
11
|
- API version: v2
|
12
|
-
- Package version: 0.
|
13
|
-
- Build date: 2017-01-
|
12
|
+
- Package version: 0.64.1
|
13
|
+
- Build date: 2017-01-04T14:31:38.053Z
|
14
14
|
|
15
15
|
For more information, please visit [https://developer.mypurecloud.com](https://developer.mypurecloud.com)
|
16
16
|
|
@@ -18,7 +18,7 @@ For more information, please visit [https://developer.mypurecloud.com](https://d
|
|
18
18
|
|
19
19
|
### from rubygems.org
|
20
20
|
|
21
|
-
gem 'purecloud', '~> 0.
|
21
|
+
gem 'purecloud', '~> 0.64.1'
|
22
22
|
|
23
23
|
### Install from Git
|
24
24
|
|
data/config-ruby.json
CHANGED
@@ -1 +1 @@
|
|
1
|
-
{"gemVersion":"0.
|
1
|
+
{"gemVersion":"0.64.1","gemName":"purecloud","moduleName":"PureCloud","gemLicense":"MIT","gemSummary":"PureCloud Platform API Library","gemDescription":"A Ruby library to interface with the PureCloud Platform API","gemHomepage":"https://developer.mypurecloud.com","gemAuthor":"Kevin Glinski","gemAuthorEmail":"Kevin.Glinski@inin.com","httpUserAgent":"PureCloud SDK/Ruby 0.64.1","gitUserId":"mypurecloud","gitRepoId":"purecloud_api_sdk_ruby"}
|
data/doc_out/ADFS.html.md
CHANGED
@@ -13,7 +13,7 @@ title: ADFS
|
|
13
13
|
| **certificate** | **String** | | [optional] |
|
14
14
|
| **issuer_uri** | **String** | | [optional] |
|
15
15
|
| **sso_target_uri** | **String** | | [optional] |
|
16
|
-
| **disabled** | **BOOLEAN** | | [optional] |
|
16
|
+
| **disabled** | **BOOLEAN** | | [optional] [default to false]|
|
17
17
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
18
18
|
{: class="table table-striped"}
|
19
19
|
|
@@ -13,7 +13,7 @@ title: AggregationQuery
|
|
13
13
|
| **group_by** | **Array<String>** | Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group. | [optional] |
|
14
14
|
| **filter** | [**AnalyticsQueryFilter**](AnalyticsQueryFilter.html) | Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters | [optional] |
|
15
15
|
| **metrics** | **Array<String>** | Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *). | [optional] |
|
16
|
-
| **flatten_multivalued_dimensions** | **BOOLEAN** | Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c') | [optional] |
|
16
|
+
| **flatten_multivalued_dimensions** | **BOOLEAN** | Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c') | [optional] [default to false]|
|
17
17
|
{: class="table table-striped"}
|
18
18
|
|
19
19
|
|
@@ -26,11 +26,11 @@ title: AnalyticsConversationSegment
|
|
26
26
|
| **destination_session_id** | **String** | | [optional] |
|
27
27
|
| **sip_response_codes** | **Array<Integer>** | | [optional] |
|
28
28
|
| **q850_response_codes** | **Array<Integer>** | | [optional] |
|
29
|
-
| **conference** | **BOOLEAN** | | [optional] |
|
29
|
+
| **conference** | **BOOLEAN** | | [optional] [default to false]|
|
30
30
|
| **group_id** | **String** | | [optional] |
|
31
31
|
| **subject** | **String** | | [optional] |
|
32
|
-
| **audio_muted** | **BOOLEAN** | | [optional] |
|
33
|
-
| **video_muted** | **BOOLEAN** | | [optional] |
|
32
|
+
| **audio_muted** | **BOOLEAN** | | [optional] [default to false]|
|
33
|
+
| **video_muted** | **BOOLEAN** | | [optional] [default to false]|
|
34
34
|
{: class="table table-striped"}
|
35
35
|
|
36
36
|
|
@@ -28,13 +28,13 @@ title: AnalyticsSession
|
|
28
28
|
| **callback_numbers** | **Array<String>** | | [optional] |
|
29
29
|
| **callback_scheduled_time** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
30
30
|
| **script_id** | **String** | | [optional] |
|
31
|
-
| **skip_enabled** | **BOOLEAN** | | [optional] |
|
31
|
+
| **skip_enabled** | **BOOLEAN** | | [optional] [default to false]|
|
32
32
|
| **timeout_seconds** | **Integer** | | [optional] |
|
33
33
|
| **cobrowse_role** | **String** | | [optional] |
|
34
34
|
| **cobrowse_room_id** | **String** | | [optional] |
|
35
35
|
| **media_bridge_id** | **String** | | [optional] |
|
36
36
|
| **screen_share_address_self** | **String** | | [optional] |
|
37
|
-
| **sharing_screen** | **BOOLEAN** | | [optional] |
|
37
|
+
| **sharing_screen** | **BOOLEAN** | | [optional] [default to false]|
|
38
38
|
| **screen_share_room_id** | **String** | | [optional] |
|
39
39
|
| **video_room_id** | **String** | | [optional] |
|
40
40
|
| **video_address_self** | **String** | | [optional] |
|
@@ -9,9 +9,9 @@ All URIs are relative to *https://api.mypurecloud.com*
|
|
9
9
|
Method | HTTP request | Description
|
10
10
|
------------- | ------------- | -------------
|
11
11
|
|[**delete_attribute_id**](AttributesApi.html#delete_attribute_id) | **DELETE** /api/v2/attributes/{attributeId} | Delete an existing Attribute.|
|
12
|
-
|[**get**](AttributesApi.html#get) | **GET** /api/v2/attributes | Gets a list of existing attributes.|
|
13
12
|
|[**get_attribute_id**](AttributesApi.html#get_attribute_id) | **GET** /api/v2/attributes/{attributeId} | Get details about an existing attribute.|
|
14
|
-
|[**
|
13
|
+
|[**get_attributes**](AttributesApi.html#get_attributes) | **GET** /api/v2/attributes | Gets a list of existing attributes.|
|
14
|
+
|[**post_attributes**](AttributesApi.html#post_attributes) | **POST** /api/v2/attributes | Create an attribute.|
|
15
15
|
|[**post_query**](AttributesApi.html#post_query) | **POST** /api/v2/attributes/query | Query attributes|
|
16
16
|
|[**put_attribute_id**](AttributesApi.html#put_attribute_id) | **PUT** /api/v2/attributes/{attributeId} | Update an existing attribute.|
|
17
17
|
{: class="table table-striped"}
|
@@ -71,11 +71,11 @@ nil (empty response body)
|
|
71
71
|
|
72
72
|
|
73
73
|
|
74
|
-
<a name="
|
74
|
+
<a name="get_attribute_id"></a>
|
75
75
|
|
76
|
-
## -[**
|
76
|
+
## -[**Attribute**](Attribute.html) get_attribute_id(attribute_id)
|
77
77
|
|
78
|
-
|
78
|
+
Get details about an existing attribute.
|
79
79
|
|
80
80
|
|
81
81
|
|
@@ -96,17 +96,15 @@ end
|
|
96
96
|
|
97
97
|
api_instance = PureCloud::AttributesApi.new
|
98
98
|
|
99
|
-
|
100
|
-
|
101
|
-
page_size: 25 # Integer | Page size
|
102
|
-
}
|
99
|
+
attribute_id = "attribute_id_example" # String | Attribute ID
|
100
|
+
|
103
101
|
|
104
102
|
begin
|
105
|
-
#
|
106
|
-
result = api_instance.
|
103
|
+
#Get details about an existing attribute.
|
104
|
+
result = api_instance.get_attribute_id(attribute_id)
|
107
105
|
p result
|
108
106
|
rescue PureCloud::ApiError => e
|
109
|
-
puts "Exception when calling AttributesApi->
|
107
|
+
puts "Exception when calling AttributesApi->get_attribute_id: #{e}"
|
110
108
|
end
|
111
109
|
~~~
|
112
110
|
|
@@ -114,14 +112,13 @@ end
|
|
114
112
|
|
115
113
|
Name | Type | Description | Notes
|
116
114
|
------------- | ------------- | ------------- | -------------
|
117
|
-
**
|
118
|
-
**page_size** | **Integer**| Page size | [optional] [default to 25]
|
115
|
+
**attribute_id** | **String**| Attribute ID |
|
119
116
|
{: class="table table-striped"}
|
120
117
|
|
121
118
|
|
122
119
|
### Return type
|
123
120
|
|
124
|
-
[**
|
121
|
+
[**Attribute**](Attribute.html)
|
125
122
|
|
126
123
|
### HTTP request headers
|
127
124
|
|
@@ -130,11 +127,11 @@ Name | Type | Description | Notes
|
|
130
127
|
|
131
128
|
|
132
129
|
|
133
|
-
<a name="
|
130
|
+
<a name="get_attributes"></a>
|
134
131
|
|
135
|
-
## -[**
|
132
|
+
## -[**AttributeEntityListing**](AttributeEntityListing.html) get_attributes(opts)
|
136
133
|
|
137
|
-
|
134
|
+
Gets a list of existing attributes.
|
138
135
|
|
139
136
|
|
140
137
|
|
@@ -155,15 +152,17 @@ end
|
|
155
152
|
|
156
153
|
api_instance = PureCloud::AttributesApi.new
|
157
154
|
|
158
|
-
|
159
|
-
|
155
|
+
opts = {
|
156
|
+
page_number: 1, # Integer | Page number
|
157
|
+
page_size: 25 # Integer | Page size
|
158
|
+
}
|
160
159
|
|
161
160
|
begin
|
162
|
-
#
|
163
|
-
result = api_instance.
|
161
|
+
#Gets a list of existing attributes.
|
162
|
+
result = api_instance.get_attributes(opts)
|
164
163
|
p result
|
165
164
|
rescue PureCloud::ApiError => e
|
166
|
-
puts "Exception when calling AttributesApi->
|
165
|
+
puts "Exception when calling AttributesApi->get_attributes: #{e}"
|
167
166
|
end
|
168
167
|
~~~
|
169
168
|
|
@@ -171,13 +170,14 @@ end
|
|
171
170
|
|
172
171
|
Name | Type | Description | Notes
|
173
172
|
------------- | ------------- | ------------- | -------------
|
174
|
-
**
|
173
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1]
|
174
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25]
|
175
175
|
{: class="table table-striped"}
|
176
176
|
|
177
177
|
|
178
178
|
### Return type
|
179
179
|
|
180
|
-
[**
|
180
|
+
[**AttributeEntityListing**](AttributeEntityListing.html)
|
181
181
|
|
182
182
|
### HTTP request headers
|
183
183
|
|
@@ -186,9 +186,9 @@ Name | Type | Description | Notes
|
|
186
186
|
|
187
187
|
|
188
188
|
|
189
|
-
<a name="
|
189
|
+
<a name="post_attributes"></a>
|
190
190
|
|
191
|
-
## -[**Attribute**](Attribute.html)
|
191
|
+
## -[**Attribute**](Attribute.html) post_attributes(body)
|
192
192
|
|
193
193
|
Create an attribute.
|
194
194
|
|
@@ -216,10 +216,10 @@ body = PureCloud::Attribute.new # Attribute | Attribute
|
|
216
216
|
|
217
217
|
begin
|
218
218
|
#Create an attribute.
|
219
|
-
result = api_instance.
|
219
|
+
result = api_instance.post_attributes(body)
|
220
220
|
p result
|
221
221
|
rescue PureCloud::ApiError => e
|
222
|
-
puts "Exception when calling AttributesApi->
|
222
|
+
puts "Exception when calling AttributesApi->post_attributes: #{e}"
|
223
223
|
end
|
224
224
|
~~~
|
225
225
|
|
@@ -11,7 +11,7 @@ title: AuditMessage
|
|
11
11
|
| **user** | [**AuditUser**](AuditUser.html) | | [optional] |
|
12
12
|
| **correlation_id** | **String** | Correlation ID. | [optional] |
|
13
13
|
| **transaction_id** | **String** | Transaction ID. | [optional] |
|
14
|
-
| **transaction_initiator** | **BOOLEAN** | Whether or not this audit can be considered the initiator of the transaction it is a part of. | [optional] |
|
14
|
+
| **transaction_initiator** | **BOOLEAN** | Whether or not this audit can be considered the initiator of the transaction it is a part of. | [optional] [default to false]|
|
15
15
|
| **application** | **String** | The application through which the action of this AuditMessage was initiated. | [optional] |
|
16
16
|
| **service_name** | **String** | The name of the service which sent this AuditMessage. | |
|
17
17
|
| **level** | **String** | The level of this audit. USER or SYSTEM. | |
|
data/doc_out/Call.html.md
CHANGED
@@ -10,11 +10,11 @@ title: Call
|
|
10
10
|
| **state** | **String** | The connection state of this communication. | [optional] |
|
11
11
|
| **id** | **String** | A globally unique identifier for this communication. | [optional] |
|
12
12
|
| **direction** | **String** | The direction of the call | [optional] |
|
13
|
-
| **recording** | **BOOLEAN** | True if this call is being recorded. | [optional] |
|
13
|
+
| **recording** | **BOOLEAN** | True if this call is being recorded. | [optional] [default to false]|
|
14
14
|
| **recording_state** | **String** | State of recording on this call. | [optional] |
|
15
|
-
| **muted** | **BOOLEAN** | True if this call is muted so that remote participants can't hear any audio from this end. | [optional] |
|
16
|
-
| **confined** | **BOOLEAN** | True if this call is held and the person on this side hears hold music. | [optional] |
|
17
|
-
| **held** | **BOOLEAN** | True if this call is held and the person on this side hears silence. | [optional] |
|
15
|
+
| **muted** | **BOOLEAN** | True if this call is muted so that remote participants can't hear any audio from this end. | [optional] [default to false]|
|
16
|
+
| **confined** | **BOOLEAN** | True if this call is held and the person on this side hears hold music. | [optional] [default to false]|
|
17
|
+
| **held** | **BOOLEAN** | True if this call is held and the person on this side hears silence. | [optional] [default to false]|
|
18
18
|
| **recording_id** | **String** | A globally unique identifier for the recording associated with this call. | [optional] |
|
19
19
|
| **segments** | [**Array<Segment>**](Segment.html) | The time line of the participant's call, divided into activity segments. | [optional] |
|
20
20
|
| **error_info** | [**ErrorBody**](ErrorBody.html) | | [optional] |
|
@@ -10,7 +10,7 @@ title: CallForwarding
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
11
|
| **name** | **String** | | [optional] |
|
12
12
|
| **user** | [**User**](User.html) | | [optional] |
|
13
|
-
| **enabled** | **BOOLEAN** | | [optional] |
|
13
|
+
| **enabled** | **BOOLEAN** | | [optional] [default to false]|
|
14
14
|
| **phone_number** | **String** | | [optional] |
|
15
15
|
| **modified_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
16
16
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
@@ -18,8 +18,8 @@ title: CallMediaParticipant
|
|
18
18
|
| **state** | **String** | The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting | [optional] |
|
19
19
|
| **direction** | **String** | The participant's direction. Values can be: 'inbound' or 'outbound' | [optional] |
|
20
20
|
| **disconnect_type** | **String** | The reason the participant was disconnected from the conversation. | [optional] |
|
21
|
-
| **held** | **BOOLEAN** | Value is true when the participant is on hold. | [optional] |
|
22
|
-
| **wrapup_required** | **BOOLEAN** | Value is true when the participant requires wrap-up. | [optional] |
|
21
|
+
| **held** | **BOOLEAN** | Value is true when the participant is on hold. | [optional] [default to false]|
|
22
|
+
| **wrapup_required** | **BOOLEAN** | Value is true when the participant requires wrap-up. | [optional] [default to false]|
|
23
23
|
| **wrapup_prompt** | **String** | The wrap-up prompt indicating the type of wrap-up to be performed. | [optional] |
|
24
24
|
| **user** | [**UriReference**](UriReference.html) | The PureCloud user for this participant. | [optional] |
|
25
25
|
| **queue** | [**UriReference**](UriReference.html) | The PureCloud queue for this participant. | [optional] |
|
@@ -27,13 +27,13 @@ title: CallMediaParticipant
|
|
27
27
|
| **error_info** | [**ErrorBody**](ErrorBody.html) | If the conversation ends in error, contains additional error details. | [optional] |
|
28
28
|
| **script** | [**UriReference**](UriReference.html) | The Engage script that should be used by this participant. | [optional] |
|
29
29
|
| **wrapup_timeout_ms** | **Integer** | The amount of time the participant has to complete wrap-up. | [optional] |
|
30
|
-
| **wrapup_skipped** | **BOOLEAN** | Value is true when the participant has skipped wrap-up. | [optional] |
|
30
|
+
| **wrapup_skipped** | **BOOLEAN** | Value is true when the participant has skipped wrap-up. | [optional] [default to false]|
|
31
31
|
| **provider** | **String** | The source provider for the communication. | [optional] |
|
32
32
|
| **external_contact** | [**UriReference**](UriReference.html) | If this participant represents an external contact, then this will be the reference for the external contact. | [optional] |
|
33
33
|
| **external_organization** | [**UriReference**](UriReference.html) | If this participant represents an external org, then this will be the reference for the external org. | [optional] |
|
34
|
-
| **muted** | **BOOLEAN** | Value is true when the call is muted. | [optional] |
|
35
|
-
| **confined** | **BOOLEAN** | Value is true when the call is confined. | [optional] |
|
36
|
-
| **recording** | **BOOLEAN** | Value is true when the call is being recorded. | [optional] |
|
34
|
+
| **muted** | **BOOLEAN** | Value is true when the call is muted. | [optional] [default to false]|
|
35
|
+
| **confined** | **BOOLEAN** | Value is true when the call is confined. | [optional] [default to false]|
|
36
|
+
| **recording** | **BOOLEAN** | Value is true when the call is being recorded. | [optional] [default to false]|
|
37
37
|
| **recording_state** | **String** | The state of the call recording. | [optional] |
|
38
38
|
| **group** | [**UriReference**](UriReference.html) | The group involved in the group ring call. | [optional] |
|
39
39
|
| **ani** | **String** | The call ANI. | [optional] |
|
data/doc_out/Callback.html.md
CHANGED
@@ -11,14 +11,14 @@ title: Callback
|
|
11
11
|
| **id** | **String** | A globally unique identifier for this communication. | [optional] |
|
12
12
|
| **segments** | [**Array<Segment>**](Segment.html) | The time line of the participant's callback, divided into activity segments. | [optional] |
|
13
13
|
| **direction** | **String** | The direction of the call | [optional] |
|
14
|
-
| **held** | **BOOLEAN** | True if this call is held and the person on this side hears silence. | [optional] |
|
14
|
+
| **held** | **BOOLEAN** | True if this call is held and the person on this side hears silence. | [optional] [default to false]|
|
15
15
|
| **disconnect_type** | **String** | System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. | [optional] |
|
16
16
|
| **start_hold_time** | **DateTime** | The timestamp the callback was placed on hold in the cloud clock if the callback is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
17
17
|
| **dialer_preview** | [**DialerPreview**](DialerPreview.html) | The preview data to be used when this callback is a Preview. | [optional] |
|
18
18
|
| **callback_numbers** | **Array<String>** | The phone number(s) to use to place the callback. | [optional] |
|
19
19
|
| **callback_user_name** | **String** | The name of the user requesting a callback. | [optional] |
|
20
20
|
| **script_id** | **String** | The UUID of the script to use. | [optional] |
|
21
|
-
| **skip_enabled** | **BOOLEAN** | True if the ability to skip a callback should be enabled. | [optional] |
|
21
|
+
| **skip_enabled** | **BOOLEAN** | True if the ability to skip a callback should be enabled. | [optional] [default to false]|
|
22
22
|
| **timeout_seconds** | **Integer** | The number of seconds before the system automatically places a call for a callback. 0 means the automatic placement is disabled. | [optional] |
|
23
23
|
| **connected_time** | **DateTime** | The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
24
24
|
| **disconnected_time** | **DateTime** | The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
@@ -18,8 +18,8 @@ title: CallbackMediaParticipant
|
|
18
18
|
| **state** | **String** | The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting | [optional] |
|
19
19
|
| **direction** | **String** | The participant's direction. Values can be: 'inbound' or 'outbound' | [optional] |
|
20
20
|
| **disconnect_type** | **String** | The reason the participant was disconnected from the conversation. | [optional] |
|
21
|
-
| **held** | **BOOLEAN** | Value is true when the participant is on hold. | [optional] |
|
22
|
-
| **wrapup_required** | **BOOLEAN** | Value is true when the participant requires wrap-up. | [optional] |
|
21
|
+
| **held** | **BOOLEAN** | Value is true when the participant is on hold. | [optional] [default to false]|
|
22
|
+
| **wrapup_required** | **BOOLEAN** | Value is true when the participant requires wrap-up. | [optional] [default to false]|
|
23
23
|
| **wrapup_prompt** | **String** | The wrap-up prompt indicating the type of wrap-up to be performed. | [optional] |
|
24
24
|
| **user** | [**UriReference**](UriReference.html) | The PureCloud user for this participant. | [optional] |
|
25
25
|
| **queue** | [**UriReference**](UriReference.html) | The PureCloud queue for this participant. | [optional] |
|
@@ -27,14 +27,14 @@ title: CallbackMediaParticipant
|
|
27
27
|
| **error_info** | [**ErrorBody**](ErrorBody.html) | If the conversation ends in error, contains additional error details. | [optional] |
|
28
28
|
| **script** | [**UriReference**](UriReference.html) | The Engage script that should be used by this participant. | [optional] |
|
29
29
|
| **wrapup_timeout_ms** | **Integer** | The amount of time the participant has to complete wrap-up. | [optional] |
|
30
|
-
| **wrapup_skipped** | **BOOLEAN** | Value is true when the participant has skipped wrap-up. | [optional] |
|
30
|
+
| **wrapup_skipped** | **BOOLEAN** | Value is true when the participant has skipped wrap-up. | [optional] [default to false]|
|
31
31
|
| **provider** | **String** | The source provider for the communication. | [optional] |
|
32
32
|
| **external_contact** | [**UriReference**](UriReference.html) | If this participant represents an external contact, then this will be the reference for the external contact. | [optional] |
|
33
33
|
| **external_organization** | [**UriReference**](UriReference.html) | If this participant represents an external org, then this will be the reference for the external org. | [optional] |
|
34
34
|
| **outbound_preview** | [**DialerPreview**](DialerPreview.html) | The outbound preview associated with this callback. | [optional] |
|
35
35
|
| **callback_numbers** | **Array<String>** | The list of phone number to use for this callback. | [optional] |
|
36
36
|
| **callback_user_name** | **String** | The name of the callback target. | [optional] |
|
37
|
-
| **skip_enabled** | **BOOLEAN** | If true, the callback can be skipped | [optional] |
|
37
|
+
| **skip_enabled** | **BOOLEAN** | If true, the callback can be skipped | [optional] [default to false]|
|
38
38
|
| **timeout_seconds** | **Integer** | Duration in seconds before the callback will be auto-dialed. | [optional] |
|
39
39
|
| **callback_scheduled_time** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
40
40
|
{: class="table table-striped"}
|
data/doc_out/Campaign.html.md
CHANGED
@@ -28,7 +28,7 @@ title: Campaign
|
|
28
28
|
| **caller_address** | **String** | caller id phone number to be displayed on the outbound call | [optional] |
|
29
29
|
| **outbound_line_count** | **Integer** | for agentless campaigns, the number of outbound lines to be concurrently dialed | [optional] |
|
30
30
|
| **rule_sets** | [**Array<UriReference>**](UriReference.html) | identifiers of the rule sets | [optional] |
|
31
|
-
| **skip_preview_disabled** | **BOOLEAN** | for preview campaigns, indicator of whether the agent can skip a preview without placing a call | [optional] |
|
31
|
+
| **skip_preview_disabled** | **BOOLEAN** | for preview campaigns, indicator of whether the agent can skip a preview without placing a call | [optional] [default to false]|
|
32
32
|
| **preview_time_out_seconds** | **Integer** | for preview campaigns, number of seconds before a call will be automatically placed. A value of 0 indicates no automatic placement of calls | [optional] |
|
33
33
|
| **contact_sort** | [**ContactSort**](ContactSort.html) | information determining the order in which the contacts will be dialed | [optional] |
|
34
34
|
| **no_answer_timeout** | **Integer** | for non-preview campaigns, how long to wait before dispositioning as 'no-answer', default 30 seconds | [optional] |
|
@@ -12,7 +12,7 @@ title: CampaignInteraction
|
|
12
12
|
| **agent** | [**UriReference**](UriReference.html) | | [optional] |
|
13
13
|
| **contact** | [**UriReference**](UriReference.html) | | [optional] |
|
14
14
|
| **destination_address** | **String** | | [optional] |
|
15
|
-
| **active_preview_call** | **BOOLEAN** | Boolean value if there is an active preview call on the interaction | [optional] |
|
15
|
+
| **active_preview_call** | **BOOLEAN** | Boolean value if there is an active preview call on the interaction | [optional] [default to false]|
|
16
16
|
| **last_active_preview_wrapup_time** | **DateTime** | The time when the last preview of the interaction was wrapped up. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
17
17
|
| **creation_time** | **DateTime** | The time when dialer created the interaction. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
18
18
|
| **call_placed_time** | **DateTime** | The time when the agent or system places the call. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
@@ -15,8 +15,8 @@ title: CampaignRule
|
|
15
15
|
| **campaign_rule_entities** | [**CampaignRuleEntities**](CampaignRuleEntities.html) | the list of entities the rule monitors | |
|
16
16
|
| **campaign_rule_conditions** | [**Array<CampaignRuleCondition>**](CampaignRuleCondition.html) | the list of conditions the are evaluated | |
|
17
17
|
| **campaign_rule_actions** | [**Array<CampaignRuleAction>**](CampaignRuleAction.html) | the list of actions that are executed if the conditions are satisfied | |
|
18
|
-
| **match_any_conditions** | **BOOLEAN** | | [optional] |
|
19
|
-
| **enabled** | **BOOLEAN** | | [optional] |
|
18
|
+
| **match_any_conditions** | **BOOLEAN** | | [optional] [default to false]|
|
19
|
+
| **enabled** | **BOOLEAN** | | [optional] [default to false]|
|
20
20
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
21
21
|
{: class="table table-striped"}
|
22
22
|
|
@@ -9,7 +9,7 @@ title: CampaignRuleActionEntities
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **campaigns** | [**Array<UriReference>**](UriReference.html) | | [optional] |
|
11
11
|
| **sequences** | [**Array<UriReference>**](UriReference.html) | | [optional] |
|
12
|
-
| **use_triggering_entity** | **BOOLEAN** | | [optional] |
|
12
|
+
| **use_triggering_entity** | **BOOLEAN** | | [optional] [default to false]|
|
13
13
|
{: class="table table-striped"}
|
14
14
|
|
15
15
|
|
@@ -16,7 +16,7 @@ title: CampaignSequence
|
|
16
16
|
| **current_campaign** | **Integer** | the zero-based index of the current campaign in the campaigns list | |
|
17
17
|
| **status** | **String** | status of the sequence | |
|
18
18
|
| **stop_message** | **String** | if a sequence has unexpectedly stopped, this message provides the reason | [optional] |
|
19
|
-
| **repeat** | **BOOLEAN** | indicates if a sequence is to repeat from the beginning after the last campaign completes; default is false | [optional] |
|
19
|
+
| **repeat** | **BOOLEAN** | indicates if a sequence is to repeat from the beginning after the last campaign completes; default is false | [optional] [default to false]|
|
20
20
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
21
21
|
{: class="table table-striped"}
|
22
22
|
|
@@ -11,9 +11,9 @@ title: CertificateDetails
|
|
11
11
|
| **subject** | **String** | Information about the subject of the certificate. The value of this property is a comma separated key=value format. Each key is one of the attribute names supported by X.500. | [optional] |
|
12
12
|
| **expiration_date** | **DateTime** | The expiration date of the certificate. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
13
13
|
| **issue_date** | **DateTime** | The issue date of the certificate. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
14
|
-
| **expired** | **BOOLEAN** | True if the certificate is expired, false otherwise. | [optional] |
|
15
|
-
| **signature_valid** | **BOOLEAN** | | [optional] |
|
16
|
-
| **valid** | **BOOLEAN** | | [optional] |
|
14
|
+
| **expired** | **BOOLEAN** | True if the certificate is expired, false otherwise. | [optional] [default to false]|
|
15
|
+
| **signature_valid** | **BOOLEAN** | | [optional] [default to false]|
|
16
|
+
| **valid** | **BOOLEAN** | | [optional] [default to false]|
|
17
17
|
{: class="table table-striped"}
|
18
18
|
|
19
19
|
|
@@ -18,8 +18,8 @@ title: ChatMediaParticipant
|
|
18
18
|
| **state** | **String** | The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting | [optional] |
|
19
19
|
| **direction** | **String** | The participant's direction. Values can be: 'inbound' or 'outbound' | [optional] |
|
20
20
|
| **disconnect_type** | **String** | The reason the participant was disconnected from the conversation. | [optional] |
|
21
|
-
| **held** | **BOOLEAN** | Value is true when the participant is on hold. | [optional] |
|
22
|
-
| **wrapup_required** | **BOOLEAN** | Value is true when the participant requires wrap-up. | [optional] |
|
21
|
+
| **held** | **BOOLEAN** | Value is true when the participant is on hold. | [optional] [default to false]|
|
22
|
+
| **wrapup_required** | **BOOLEAN** | Value is true when the participant requires wrap-up. | [optional] [default to false]|
|
23
23
|
| **wrapup_prompt** | **String** | The wrap-up prompt indicating the type of wrap-up to be performed. | [optional] |
|
24
24
|
| **user** | [**UriReference**](UriReference.html) | The PureCloud user for this participant. | [optional] |
|
25
25
|
| **queue** | [**UriReference**](UriReference.html) | The PureCloud queue for this participant. | [optional] |
|
@@ -27,7 +27,7 @@ title: ChatMediaParticipant
|
|
27
27
|
| **error_info** | [**ErrorBody**](ErrorBody.html) | If the conversation ends in error, contains additional error details. | [optional] |
|
28
28
|
| **script** | [**UriReference**](UriReference.html) | The Engage script that should be used by this participant. | [optional] |
|
29
29
|
| **wrapup_timeout_ms** | **Integer** | The amount of time the participant has to complete wrap-up. | [optional] |
|
30
|
-
| **wrapup_skipped** | **BOOLEAN** | Value is true when the participant has skipped wrap-up. | [optional] |
|
30
|
+
| **wrapup_skipped** | **BOOLEAN** | Value is true when the participant has skipped wrap-up. | [optional] [default to false]|
|
31
31
|
| **provider** | **String** | The source provider for the communication. | [optional] |
|
32
32
|
| **external_contact** | [**UriReference**](UriReference.html) | If this participant represents an external contact, then this will be the reference for the external contact. | [optional] |
|
33
33
|
| **external_organization** | [**UriReference**](UriReference.html) | If this participant represents an external org, then this will be the reference for the external org. | [optional] |
|
@@ -18,8 +18,8 @@ title: CobrowseMediaParticipant
|
|
18
18
|
| **state** | **String** | The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting | [optional] |
|
19
19
|
| **direction** | **String** | The participant's direction. Values can be: 'inbound' or 'outbound' | [optional] |
|
20
20
|
| **disconnect_type** | **String** | The reason the participant was disconnected from the conversation. | [optional] |
|
21
|
-
| **held** | **BOOLEAN** | Value is true when the participant is on hold. | [optional] |
|
22
|
-
| **wrapup_required** | **BOOLEAN** | Value is true when the participant requires wrap-up. | [optional] |
|
21
|
+
| **held** | **BOOLEAN** | Value is true when the participant is on hold. | [optional] [default to false]|
|
22
|
+
| **wrapup_required** | **BOOLEAN** | Value is true when the participant requires wrap-up. | [optional] [default to false]|
|
23
23
|
| **wrapup_prompt** | **String** | The wrap-up prompt indicating the type of wrap-up to be performed. | [optional] |
|
24
24
|
| **user** | [**UriReference**](UriReference.html) | The PureCloud user for this participant. | [optional] |
|
25
25
|
| **queue** | [**UriReference**](UriReference.html) | The PureCloud queue for this participant. | [optional] |
|
@@ -27,7 +27,7 @@ title: CobrowseMediaParticipant
|
|
27
27
|
| **error_info** | [**ErrorBody**](ErrorBody.html) | If the conversation ends in error, contains additional error details. | [optional] |
|
28
28
|
| **script** | [**UriReference**](UriReference.html) | The Engage script that should be used by this participant. | [optional] |
|
29
29
|
| **wrapup_timeout_ms** | **Integer** | The amount of time the participant has to complete wrap-up. | [optional] |
|
30
|
-
| **wrapup_skipped** | **BOOLEAN** | Value is true when the participant has skipped wrap-up. | [optional] |
|
30
|
+
| **wrapup_skipped** | **BOOLEAN** | Value is true when the participant has skipped wrap-up. | [optional] [default to false]|
|
31
31
|
| **provider** | **String** | The source provider for the communication. | [optional] |
|
32
32
|
| **external_contact** | [**UriReference**](UriReference.html) | If this participant represents an external contact, then this will be the reference for the external contact. | [optional] |
|
33
33
|
| **external_organization** | [**UriReference**](UriReference.html) | If this participant represents an external org, then this will be the reference for the external org. | [optional] |
|