PureBasic / Support API / Show Settings
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::setCkBasicAuth(http, 1)
CkHttp::setCkLogin(http, "login")
CkHttp::setCkPassword(http, "password")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://example.zendesk.com/api/v2/account/settings",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "settings": {
; "active_features": {
; "advanced_analytics": "<boolean>",
; "agent_forwarding": "<boolean>",
; "allow_ccs": "<boolean>",
; "allow_email_template_customization": "<boolean>",
; "automatic_answers": "<boolean>",
; "bcc_archiving": "<boolean>",
; "benchmark_opt_out": "<boolean>",
; "business_hours": "<boolean>",
; "chat": "<boolean>",
; "chat_about_my_ticket": "<boolean>",
; "csat_reason_code": "<boolean>",
; "custom_dkim_domain": "<boolean>",
; "customer_context_as_default": "<boolean>",
; "customer_satisfaction": "<boolean>",
; "dynamic_contents": "<boolean>",
; "explore": "<boolean>",
; "explore_on_support_ent_plan": "<boolean>",
; "explore_on_support_pro_plan": "<boolean>",
; "facebook": "<boolean>",
; "facebook_login": "<boolean>",
; "fallback_composer": "<boolean>",
; "forum_analytics": "<boolean>",
; "good_data_and_explore": "<boolean>",
; "google_login": "<boolean>",
; "insights": "<boolean>",
; "is_abusive": "<boolean>",
; "light_agents": "<boolean>",
; "markdown": "<boolean>",
; "on_hold_status": "<boolean>",
; "rich_content_in_emails": "<boolean>",
; "sandbox": "<boolean>",
; "satisfaction_prediction": "<boolean>",
; "suspended_ticket_notification": "<boolean>",
; "ticket_forms": "<boolean>",
; "ticket_tagging": "<boolean>",
; "topic_suggestion": "<boolean>",
; "twitter": "<boolean>",
; "twitter_login": "<boolean>",
; "user_org_fields": "<boolean>",
; "user_tagging": "<boolean>",
; "voice": "<boolean>"
; },
; "agents": {
; "agent_workspace": "<boolean>",
; "aw_self_serve_migration_enabled": "<boolean>",
; "focus_mode": "<boolean>",
; "idle_timeout_enabled": "<boolean>",
; "unified_agent_statuses": "<boolean>"
; },
; "api": {
; "accepted_api_agreement": "<boolean>",
; "api_password_access": "<string>",
; "api_token_access": "<string>"
; },
; "apps": {
; "create_private": "<boolean>",
; "create_public": "<boolean>",
; "use": "<boolean>"
; },
; "billing": {
; "backend": "<string>"
; },
; "branding": {
; "favicon_url": "<string>",
; "header_color": "<string>",
; "header_logo_url": "<string>",
; "page_background_color": "<string>",
; "tab_background_color": "<string>",
; "text_color": "<string>"
; },
; "brands": {
; "default_brand_id": "<integer>",
; "require_brand_on_new_tickets": "<boolean>"
; },
; "cdn": {
; "cdn_provider": "<string>",
; "fallback_cdn_provider": "<string>",
; "hosts": [
; {
; "name": "<string>",
; "url": "<string>"
; },
; {
; "name": "<string>",
; "url": "<string>"
; }
; ]
; },
; "chat": {
; "available": "<boolean>",
; "enabled": "<boolean>",
; "integrated": "<boolean>",
; "maximum_request_count": "<integer>",
; "welcome_message": "<string>"
; },
; "cross_sell": {
; "show_chat_tooltip": "<boolean>",
; "xsell_source": "<string>"
; },
; "gooddata_advanced_analytics": {
; "enabled": "<boolean>"
; },
; "google_apps": {
; "has_google_apps": "<boolean>",
; "has_google_apps_admin": "<boolean>"
; },
; "groups": {
; "check_group_name_uniqueness": "<boolean>"
; },
; "limits": {
; "attachment_size": "<integer>"
; },
; "localization": {
; "locale_ids": [
; "<integer>",
; "<integer>"
; ]
; },
; "lotus": {
; "pod_id": "<integer>",
; "prefer_lotus": "<boolean>",
; "reporting": "<boolean>"
; },
; "metrics": {
; "account_size": "<string>"
; },
; "onboarding": {
; "checklist_onboarding_version": "<integer>",
; "onboarding_segments": "<string>",
; "product_sign_up": "<string>"
; },
; "routing": {
; "autorouting_tag": "<string>",
; "enabled": "<boolean>",
; "max_email_capacity": "<integer>",
; "max_messaging_capacity": "<integer>",
; "reassignment_messaging_enabled": "<boolean>",
; "reassignment_messaging_timeout": "<integer>",
; "reassignment_talk_timeout": "<integer>"
; },
; "rule": {
; "macro_most_used": "<boolean>",
; "macro_order": "<string>",
; "skill_based_filtered_views": [
; {
; "in523": 60303840.72385332
; },
; {
; "estc": "eu aliquip id"
; }
; ],
; "using_skill_based_routing": "<boolean>"
; },
; "side_conversations": {
; "email_channel": "<boolean>",
; "msteams_channel": "<boolean>",
; "show_in_context_panel": "<boolean>",
; "slack_channel": "<boolean>",
; "tickets_channel": "<boolean>"
; },
; "statistics": {
; "forum": "<boolean>",
; "rule_usage": "<boolean>",
; "search": "<boolean>"
; },
; "ticket_form": {
; "raw_ticket_forms_instructions": "<string>",
; "ticket_forms_instructions": "<string>"
; },
; "ticket_sharing_partners": {
; "support_addresses": [
; "<string>",
; "<string>"
; ]
; },
; "tickets": {
; "accepted_new_collaboration_tos": "<boolean>",
; "agent_collision": "<boolean>",
; "agent_ticket_deletion": "<boolean>",
; "allow_group_reset": "<boolean>",
; "assign_default_organization": "<boolean>",
; "assign_tickets_upon_solve": "<boolean>",
; "auto_updated_ccs_followers_rules": "<boolean>",
; "collaboration": "<boolean>",
; "comments_public_by_default": "<boolean>",
; "email_attachments": "<boolean>",
; "emoji_autocompletion": "<boolean>",
; "follower_and_email_cc_collaborations": "<boolean>",
; "has_color_text": "<boolean>",
; "is_first_comment_private_enabled": "<boolean>",
; "light_agent_email_ccs_allowed": "<boolean>",
; "list_empty_views": "<boolean>",
; "list_newest_comments_first": "<boolean>",
; "markdown_ticket_comments": "<boolean>",
; "maximum_personal_views_to_list": "<integer>",
; "private_attachments": "<boolean>",
; "rich_text_comments": "<boolean>",
; "status_hold": "<boolean>",
; "tagging": "<boolean>",
; "using_skill_based_routing": "<boolean>"
; },
; "twitter": {
; "shorten_url": "<string>"
; },
; "user": {
; "agent_created_welcome_emails": "<boolean>",
; "end_user_phone_number_validation": "<boolean>",
; "have_gravatars_enabled": "<boolean>",
; "language_selection": "<boolean>",
; "multiple_organizations": "<boolean>",
; "tagging": "<boolean>",
; "time_zone_selection": "<boolean>"
; },
; "voice": {
; "agent_confirmation_when_forwarding": "<boolean>",
; "agent_wrap_up_after_calls": "<boolean>",
; "enabled": "<boolean>",
; "logging": "<boolean>",
; "maximum_queue_size": "<integer>",
; "maximum_queue_wait_time": "<integer>",
; "only_during_business_hours": "<boolean>",
; "outbound_enabled": "<boolean>",
; "recordings_public": "<boolean>",
; "uk_mobile_forwarding": "<boolean>"
; }
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
name.s
url.s
strVal.s
in523.s
estc.s
Advanced_analytics.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.advanced_analytics")
Agent_forwarding.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.agent_forwarding")
Allow_ccs.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.allow_ccs")
Allow_email_template_customization.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.allow_email_template_customization")
Automatic_answers.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.automatic_answers")
Bcc_archiving.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.bcc_archiving")
Benchmark_opt_out.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.benchmark_opt_out")
Business_hours.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.business_hours")
Chat.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.chat")
Chat_about_my_ticket.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.chat_about_my_ticket")
Csat_reason_code.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.csat_reason_code")
Custom_dkim_domain.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.custom_dkim_domain")
Customer_context_as_default.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.customer_context_as_default")
Customer_satisfaction.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.customer_satisfaction")
Dynamic_contents.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.dynamic_contents")
Explore.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.explore")
Explore_on_support_ent_plan.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.explore_on_support_ent_plan")
Explore_on_support_pro_plan.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.explore_on_support_pro_plan")
Facebook.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.facebook")
Facebook_login.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.facebook_login")
Fallback_composer.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.fallback_composer")
Forum_analytics.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.forum_analytics")
Good_data_and_explore.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.good_data_and_explore")
Google_login.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.google_login")
Insights.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.insights")
Is_abusive.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.is_abusive")
Light_agents.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.light_agents")
Markdown.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.markdown")
On_hold_status.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.on_hold_status")
Rich_content_in_emails.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.rich_content_in_emails")
Sandbox.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.sandbox")
Satisfaction_prediction.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.satisfaction_prediction")
Suspended_ticket_notification.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.suspended_ticket_notification")
Ticket_forms.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.ticket_forms")
Ticket_tagging.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.ticket_tagging")
Topic_suggestion.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.topic_suggestion")
Twitter.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.twitter")
Twitter_login.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.twitter_login")
User_org_fields.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.user_org_fields")
User_tagging.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.user_tagging")
Voice.s = CkJsonObject::ckStringOf(jResp,"settings.active_features.voice")
Agent_workspace.s = CkJsonObject::ckStringOf(jResp,"settings.agents.agent_workspace")
Aw_self_serve_migration_enabled.s = CkJsonObject::ckStringOf(jResp,"settings.agents.aw_self_serve_migration_enabled")
Focus_mode.s = CkJsonObject::ckStringOf(jResp,"settings.agents.focus_mode")
Idle_timeout_enabled.s = CkJsonObject::ckStringOf(jResp,"settings.agents.idle_timeout_enabled")
Unified_agent_statuses.s = CkJsonObject::ckStringOf(jResp,"settings.agents.unified_agent_statuses")
Accepted_api_agreement.s = CkJsonObject::ckStringOf(jResp,"settings.api.accepted_api_agreement")
Api_password_access.s = CkJsonObject::ckStringOf(jResp,"settings.api.api_password_access")
Api_token_access.s = CkJsonObject::ckStringOf(jResp,"settings.api.api_token_access")
Create_private.s = CkJsonObject::ckStringOf(jResp,"settings.apps.create_private")
Create_public.s = CkJsonObject::ckStringOf(jResp,"settings.apps.create_public")
Use.s = CkJsonObject::ckStringOf(jResp,"settings.apps.use")
Backend.s = CkJsonObject::ckStringOf(jResp,"settings.billing.backend")
Favicon_url.s = CkJsonObject::ckStringOf(jResp,"settings.branding.favicon_url")
Header_color.s = CkJsonObject::ckStringOf(jResp,"settings.branding.header_color")
Header_logo_url.s = CkJsonObject::ckStringOf(jResp,"settings.branding.header_logo_url")
Page_background_color.s = CkJsonObject::ckStringOf(jResp,"settings.branding.page_background_color")
Tab_background_color.s = CkJsonObject::ckStringOf(jResp,"settings.branding.tab_background_color")
Text_color.s = CkJsonObject::ckStringOf(jResp,"settings.branding.text_color")
Default_brand_id.s = CkJsonObject::ckStringOf(jResp,"settings.brands.default_brand_id")
Require_brand_on_new_tickets.s = CkJsonObject::ckStringOf(jResp,"settings.brands.require_brand_on_new_tickets")
Cdn_provider.s = CkJsonObject::ckStringOf(jResp,"settings.cdn.cdn_provider")
Fallback_cdn_provider.s = CkJsonObject::ckStringOf(jResp,"settings.cdn.fallback_cdn_provider")
Available.s = CkJsonObject::ckStringOf(jResp,"settings.chat.available")
Enabled.s = CkJsonObject::ckStringOf(jResp,"settings.chat.enabled")
Integrated.s = CkJsonObject::ckStringOf(jResp,"settings.chat.integrated")
Maximum_request_count.s = CkJsonObject::ckStringOf(jResp,"settings.chat.maximum_request_count")
Welcome_message.s = CkJsonObject::ckStringOf(jResp,"settings.chat.welcome_message")
Show_chat_tooltip.s = CkJsonObject::ckStringOf(jResp,"settings.cross_sell.show_chat_tooltip")
Xsell_source.s = CkJsonObject::ckStringOf(jResp,"settings.cross_sell.xsell_source")
Gooddata_advanced_analyticsEnabled.s = CkJsonObject::ckStringOf(jResp,"settings.gooddata_advanced_analytics.enabled")
Has_google_apps.s = CkJsonObject::ckStringOf(jResp,"settings.google_apps.has_google_apps")
Has_google_apps_admin.s = CkJsonObject::ckStringOf(jResp,"settings.google_apps.has_google_apps_admin")
Check_group_name_uniqueness.s = CkJsonObject::ckStringOf(jResp,"settings.groups.check_group_name_uniqueness")
Attachment_size.s = CkJsonObject::ckStringOf(jResp,"settings.limits.attachment_size")
Pod_id.s = CkJsonObject::ckStringOf(jResp,"settings.lotus.pod_id")
Prefer_lotus.s = CkJsonObject::ckStringOf(jResp,"settings.lotus.prefer_lotus")
Reporting.s = CkJsonObject::ckStringOf(jResp,"settings.lotus.reporting")
Account_size.s = CkJsonObject::ckStringOf(jResp,"settings.metrics.account_size")
Checklist_onboarding_version.s = CkJsonObject::ckStringOf(jResp,"settings.onboarding.checklist_onboarding_version")
Onboarding_segments.s = CkJsonObject::ckStringOf(jResp,"settings.onboarding.onboarding_segments")
Product_sign_up.s = CkJsonObject::ckStringOf(jResp,"settings.onboarding.product_sign_up")
Autorouting_tag.s = CkJsonObject::ckStringOf(jResp,"settings.routing.autorouting_tag")
RoutingEnabled.s = CkJsonObject::ckStringOf(jResp,"settings.routing.enabled")
Max_email_capacity.s = CkJsonObject::ckStringOf(jResp,"settings.routing.max_email_capacity")
Max_messaging_capacity.s = CkJsonObject::ckStringOf(jResp,"settings.routing.max_messaging_capacity")
Reassignment_messaging_enabled.s = CkJsonObject::ckStringOf(jResp,"settings.routing.reassignment_messaging_enabled")
Reassignment_messaging_timeout.s = CkJsonObject::ckStringOf(jResp,"settings.routing.reassignment_messaging_timeout")
Reassignment_talk_timeout.s = CkJsonObject::ckStringOf(jResp,"settings.routing.reassignment_talk_timeout")
Macro_most_used.s = CkJsonObject::ckStringOf(jResp,"settings.rule.macro_most_used")
Macro_order.s = CkJsonObject::ckStringOf(jResp,"settings.rule.macro_order")
Using_skill_based_routing.s = CkJsonObject::ckStringOf(jResp,"settings.rule.using_skill_based_routing")
Email_channel.s = CkJsonObject::ckStringOf(jResp,"settings.side_conversations.email_channel")
Msteams_channel.s = CkJsonObject::ckStringOf(jResp,"settings.side_conversations.msteams_channel")
Show_in_context_panel.s = CkJsonObject::ckStringOf(jResp,"settings.side_conversations.show_in_context_panel")
Slack_channel.s = CkJsonObject::ckStringOf(jResp,"settings.side_conversations.slack_channel")
Tickets_channel.s = CkJsonObject::ckStringOf(jResp,"settings.side_conversations.tickets_channel")
Forum.s = CkJsonObject::ckStringOf(jResp,"settings.statistics.forum")
Rule_usage.s = CkJsonObject::ckStringOf(jResp,"settings.statistics.rule_usage")
Search.s = CkJsonObject::ckStringOf(jResp,"settings.statistics.search")
Raw_ticket_forms_instructions.s = CkJsonObject::ckStringOf(jResp,"settings.ticket_form.raw_ticket_forms_instructions")
Ticket_forms_instructions.s = CkJsonObject::ckStringOf(jResp,"settings.ticket_form.ticket_forms_instructions")
Accepted_new_collaboration_tos.s = CkJsonObject::ckStringOf(jResp,"settings.tickets.accepted_new_collaboration_tos")
Agent_collision.s = CkJsonObject::ckStringOf(jResp,"settings.tickets.agent_collision")
Agent_ticket_deletion.s = CkJsonObject::ckStringOf(jResp,"settings.tickets.agent_ticket_deletion")
Allow_group_reset.s = CkJsonObject::ckStringOf(jResp,"settings.tickets.allow_group_reset")
Assign_default_organization.s = CkJsonObject::ckStringOf(jResp,"settings.tickets.assign_default_organization")
Assign_tickets_upon_solve.s = CkJsonObject::ckStringOf(jResp,"settings.tickets.assign_tickets_upon_solve")
Auto_updated_ccs_followers_rules.s = CkJsonObject::ckStringOf(jResp,"settings.tickets.auto_updated_ccs_followers_rules")
Collaboration.s = CkJsonObject::ckStringOf(jResp,"settings.tickets.collaboration")
Comments_public_by_default.s = CkJsonObject::ckStringOf(jResp,"settings.tickets.comments_public_by_default")
Email_attachments.s = CkJsonObject::ckStringOf(jResp,"settings.tickets.email_attachments")
Emoji_autocompletion.s = CkJsonObject::ckStringOf(jResp,"settings.tickets.emoji_autocompletion")
Follower_and_email_cc_collaborations.s = CkJsonObject::ckStringOf(jResp,"settings.tickets.follower_and_email_cc_collaborations")
Has_color_text.s = CkJsonObject::ckStringOf(jResp,"settings.tickets.has_color_text")
Is_first_comment_private_enabled.s = CkJsonObject::ckStringOf(jResp,"settings.tickets.is_first_comment_private_enabled")
Light_agent_email_ccs_allowed.s = CkJsonObject::ckStringOf(jResp,"settings.tickets.light_agent_email_ccs_allowed")
List_empty_views.s = CkJsonObject::ckStringOf(jResp,"settings.tickets.list_empty_views")
List_newest_comments_first.s = CkJsonObject::ckStringOf(jResp,"settings.tickets.list_newest_comments_first")
Markdown_ticket_comments.s = CkJsonObject::ckStringOf(jResp,"settings.tickets.markdown_ticket_comments")
Maximum_personal_views_to_list.s = CkJsonObject::ckStringOf(jResp,"settings.tickets.maximum_personal_views_to_list")
Private_attachments.s = CkJsonObject::ckStringOf(jResp,"settings.tickets.private_attachments")
Rich_text_comments.s = CkJsonObject::ckStringOf(jResp,"settings.tickets.rich_text_comments")
Status_hold.s = CkJsonObject::ckStringOf(jResp,"settings.tickets.status_hold")
Tagging.s = CkJsonObject::ckStringOf(jResp,"settings.tickets.tagging")
TicketsUsing_skill_based_routing.s = CkJsonObject::ckStringOf(jResp,"settings.tickets.using_skill_based_routing")
Shorten_url.s = CkJsonObject::ckStringOf(jResp,"settings.twitter.shorten_url")
Agent_created_welcome_emails.s = CkJsonObject::ckStringOf(jResp,"settings.user.agent_created_welcome_emails")
End_user_phone_number_validation.s = CkJsonObject::ckStringOf(jResp,"settings.user.end_user_phone_number_validation")
Have_gravatars_enabled.s = CkJsonObject::ckStringOf(jResp,"settings.user.have_gravatars_enabled")
Language_selection.s = CkJsonObject::ckStringOf(jResp,"settings.user.language_selection")
Multiple_organizations.s = CkJsonObject::ckStringOf(jResp,"settings.user.multiple_organizations")
UserTagging.s = CkJsonObject::ckStringOf(jResp,"settings.user.tagging")
Time_zone_selection.s = CkJsonObject::ckStringOf(jResp,"settings.user.time_zone_selection")
Agent_confirmation_when_forwarding.s = CkJsonObject::ckStringOf(jResp,"settings.voice.agent_confirmation_when_forwarding")
Agent_wrap_up_after_calls.s = CkJsonObject::ckStringOf(jResp,"settings.voice.agent_wrap_up_after_calls")
VoiceEnabled.s = CkJsonObject::ckStringOf(jResp,"settings.voice.enabled")
Logging.s = CkJsonObject::ckStringOf(jResp,"settings.voice.logging")
Maximum_queue_size.s = CkJsonObject::ckStringOf(jResp,"settings.voice.maximum_queue_size")
Maximum_queue_wait_time.s = CkJsonObject::ckStringOf(jResp,"settings.voice.maximum_queue_wait_time")
Only_during_business_hours.s = CkJsonObject::ckStringOf(jResp,"settings.voice.only_during_business_hours")
Outbound_enabled.s = CkJsonObject::ckStringOf(jResp,"settings.voice.outbound_enabled")
Recordings_public.s = CkJsonObject::ckStringOf(jResp,"settings.voice.recordings_public")
Uk_mobile_forwarding.s = CkJsonObject::ckStringOf(jResp,"settings.voice.uk_mobile_forwarding")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"settings.cdn.hosts")
While i < count_i
CkJsonObject::setCkI(jResp, i)
name = CkJsonObject::ckStringOf(jResp,"settings.cdn.hosts[i].name")
url = CkJsonObject::ckStringOf(jResp,"settings.cdn.hosts[i].url")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"settings.localization.locale_ids")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"settings.localization.locale_ids[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"settings.rule.skill_based_filtered_views")
While i < count_i
CkJsonObject::setCkI(jResp, i)
in523 = CkJsonObject::ckStringOf(jResp,"settings.rule.skill_based_filtered_views[i].in523")
estc = CkJsonObject::ckStringOf(jResp,"settings.rule.skill_based_filtered_views[i].estc")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"settings.ticket_sharing_partners.support_addresses")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"settings.ticket_sharing_partners.support_addresses[i]")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/account/settings
Postman Collection Item JSON
{
"name": "Show Settings",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/account/settings",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"account",
"settings"
]
},
"description": "Shows the settings that are available for the account.\n\n#### Allowed For\n\n* Agents\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/account/settings",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"account",
"settings"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"settings\": {\n \"active_features\": {\n \"advanced_analytics\": \"<boolean>\",\n \"agent_forwarding\": \"<boolean>\",\n \"allow_ccs\": \"<boolean>\",\n \"allow_email_template_customization\": \"<boolean>\",\n \"automatic_answers\": \"<boolean>\",\n \"bcc_archiving\": \"<boolean>\",\n \"benchmark_opt_out\": \"<boolean>\",\n \"business_hours\": \"<boolean>\",\n \"chat\": \"<boolean>\",\n \"chat_about_my_ticket\": \"<boolean>\",\n \"csat_reason_code\": \"<boolean>\",\n \"custom_dkim_domain\": \"<boolean>\",\n \"customer_context_as_default\": \"<boolean>\",\n \"customer_satisfaction\": \"<boolean>\",\n \"dynamic_contents\": \"<boolean>\",\n \"explore\": \"<boolean>\",\n \"explore_on_support_ent_plan\": \"<boolean>\",\n \"explore_on_support_pro_plan\": \"<boolean>\",\n \"facebook\": \"<boolean>\",\n \"facebook_login\": \"<boolean>\",\n \"fallback_composer\": \"<boolean>\",\n \"forum_analytics\": \"<boolean>\",\n \"good_data_and_explore\": \"<boolean>\",\n \"google_login\": \"<boolean>\",\n \"insights\": \"<boolean>\",\n \"is_abusive\": \"<boolean>\",\n \"light_agents\": \"<boolean>\",\n \"markdown\": \"<boolean>\",\n \"on_hold_status\": \"<boolean>\",\n \"rich_content_in_emails\": \"<boolean>\",\n \"sandbox\": \"<boolean>\",\n \"satisfaction_prediction\": \"<boolean>\",\n \"suspended_ticket_notification\": \"<boolean>\",\n \"ticket_forms\": \"<boolean>\",\n \"ticket_tagging\": \"<boolean>\",\n \"topic_suggestion\": \"<boolean>\",\n \"twitter\": \"<boolean>\",\n \"twitter_login\": \"<boolean>\",\n \"user_org_fields\": \"<boolean>\",\n \"user_tagging\": \"<boolean>\",\n \"voice\": \"<boolean>\"\n },\n \"agents\": {\n \"agent_workspace\": \"<boolean>\",\n \"aw_self_serve_migration_enabled\": \"<boolean>\",\n \"focus_mode\": \"<boolean>\",\n \"idle_timeout_enabled\": \"<boolean>\",\n \"unified_agent_statuses\": \"<boolean>\"\n },\n \"api\": {\n \"accepted_api_agreement\": \"<boolean>\",\n \"api_password_access\": \"<string>\",\n \"api_token_access\": \"<string>\"\n },\n \"apps\": {\n \"create_private\": \"<boolean>\",\n \"create_public\": \"<boolean>\",\n \"use\": \"<boolean>\"\n },\n \"billing\": {\n \"backend\": \"<string>\"\n },\n \"branding\": {\n \"favicon_url\": \"<string>\",\n \"header_color\": \"<string>\",\n \"header_logo_url\": \"<string>\",\n \"page_background_color\": \"<string>\",\n \"tab_background_color\": \"<string>\",\n \"text_color\": \"<string>\"\n },\n \"brands\": {\n \"default_brand_id\": \"<integer>\",\n \"require_brand_on_new_tickets\": \"<boolean>\"\n },\n \"cdn\": {\n \"cdn_provider\": \"<string>\",\n \"fallback_cdn_provider\": \"<string>\",\n \"hosts\": [\n {\n \"name\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n },\n \"chat\": {\n \"available\": \"<boolean>\",\n \"enabled\": \"<boolean>\",\n \"integrated\": \"<boolean>\",\n \"maximum_request_count\": \"<integer>\",\n \"welcome_message\": \"<string>\"\n },\n \"cross_sell\": {\n \"show_chat_tooltip\": \"<boolean>\",\n \"xsell_source\": \"<string>\"\n },\n \"gooddata_advanced_analytics\": {\n \"enabled\": \"<boolean>\"\n },\n \"google_apps\": {\n \"has_google_apps\": \"<boolean>\",\n \"has_google_apps_admin\": \"<boolean>\"\n },\n \"groups\": {\n \"check_group_name_uniqueness\": \"<boolean>\"\n },\n \"limits\": {\n \"attachment_size\": \"<integer>\"\n },\n \"localization\": {\n \"locale_ids\": [\n \"<integer>\",\n \"<integer>\"\n ]\n },\n \"lotus\": {\n \"pod_id\": \"<integer>\",\n \"prefer_lotus\": \"<boolean>\",\n \"reporting\": \"<boolean>\"\n },\n \"metrics\": {\n \"account_size\": \"<string>\"\n },\n \"onboarding\": {\n \"checklist_onboarding_version\": \"<integer>\",\n \"onboarding_segments\": \"<string>\",\n \"product_sign_up\": \"<string>\"\n },\n \"routing\": {\n \"autorouting_tag\": \"<string>\",\n \"enabled\": \"<boolean>\",\n \"max_email_capacity\": \"<integer>\",\n \"max_messaging_capacity\": \"<integer>\",\n \"reassignment_messaging_enabled\": \"<boolean>\",\n \"reassignment_messaging_timeout\": \"<integer>\",\n \"reassignment_talk_timeout\": \"<integer>\"\n },\n \"rule\": {\n \"macro_most_used\": \"<boolean>\",\n \"macro_order\": \"<string>\",\n \"skill_based_filtered_views\": [\n {\n \"in523\": 60303840.72385332\n },\n {\n \"estc\": \"eu aliquip id\"\n }\n ],\n \"using_skill_based_routing\": \"<boolean>\"\n },\n \"side_conversations\": {\n \"email_channel\": \"<boolean>\",\n \"msteams_channel\": \"<boolean>\",\n \"show_in_context_panel\": \"<boolean>\",\n \"slack_channel\": \"<boolean>\",\n \"tickets_channel\": \"<boolean>\"\n },\n \"statistics\": {\n \"forum\": \"<boolean>\",\n \"rule_usage\": \"<boolean>\",\n \"search\": \"<boolean>\"\n },\n \"ticket_form\": {\n \"raw_ticket_forms_instructions\": \"<string>\",\n \"ticket_forms_instructions\": \"<string>\"\n },\n \"ticket_sharing_partners\": {\n \"support_addresses\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"tickets\": {\n \"accepted_new_collaboration_tos\": \"<boolean>\",\n \"agent_collision\": \"<boolean>\",\n \"agent_ticket_deletion\": \"<boolean>\",\n \"allow_group_reset\": \"<boolean>\",\n \"assign_default_organization\": \"<boolean>\",\n \"assign_tickets_upon_solve\": \"<boolean>\",\n \"auto_updated_ccs_followers_rules\": \"<boolean>\",\n \"collaboration\": \"<boolean>\",\n \"comments_public_by_default\": \"<boolean>\",\n \"email_attachments\": \"<boolean>\",\n \"emoji_autocompletion\": \"<boolean>\",\n \"follower_and_email_cc_collaborations\": \"<boolean>\",\n \"has_color_text\": \"<boolean>\",\n \"is_first_comment_private_enabled\": \"<boolean>\",\n \"light_agent_email_ccs_allowed\": \"<boolean>\",\n \"list_empty_views\": \"<boolean>\",\n \"list_newest_comments_first\": \"<boolean>\",\n \"markdown_ticket_comments\": \"<boolean>\",\n \"maximum_personal_views_to_list\": \"<integer>\",\n \"private_attachments\": \"<boolean>\",\n \"rich_text_comments\": \"<boolean>\",\n \"status_hold\": \"<boolean>\",\n \"tagging\": \"<boolean>\",\n \"using_skill_based_routing\": \"<boolean>\"\n },\n \"twitter\": {\n \"shorten_url\": \"<string>\"\n },\n \"user\": {\n \"agent_created_welcome_emails\": \"<boolean>\",\n \"end_user_phone_number_validation\": \"<boolean>\",\n \"have_gravatars_enabled\": \"<boolean>\",\n \"language_selection\": \"<boolean>\",\n \"multiple_organizations\": \"<boolean>\",\n \"tagging\": \"<boolean>\",\n \"time_zone_selection\": \"<boolean>\"\n },\n \"voice\": {\n \"agent_confirmation_when_forwarding\": \"<boolean>\",\n \"agent_wrap_up_after_calls\": \"<boolean>\",\n \"enabled\": \"<boolean>\",\n \"logging\": \"<boolean>\",\n \"maximum_queue_size\": \"<integer>\",\n \"maximum_queue_wait_time\": \"<integer>\",\n \"only_during_business_hours\": \"<boolean>\",\n \"outbound_enabled\": \"<boolean>\",\n \"recordings_public\": \"<boolean>\",\n \"uk_mobile_forwarding\": \"<boolean>\"\n }\n }\n}"
}
]
}
