### Get App Settings Example Source: https://developers.dialpad.com/reference/app_settingsget Demonstrates a successful response for retrieving app settings. This example shows a JSON object with enabled status, preferred service flag, and various detailed settings for an OAuth app. ```json { "enabled": true, "is_preferred_service": true, "settings": { "bar": "high", "call_logging_enabled": true, "call_recording_logging_enabled": false, "enable_foo": true, "foo": "bar1", "foo2": 2, "log_auto_external_transferred_call": true, "log_call_recordings": false, "sf_case_owner_sms": false, "sms_logging_enabled": false, "voicemail_logging_enabled": false } } ``` -------------------------------- ### Get Company Information Example Source: https://developers.dialpad.com/reference/companyget Example response for the GET /api/v2/company endpoint. This demonstrates the structure of company data returned by the API, including settings like AI training and CallAI enablement. ```json { "account_type": "standard", "country": "us", "domain": "fuzz-ball.com", "id": "123", "name": "ファージー　ボール, Inc", "office_count": "1", "settings": { "allow_ai_training": true, "has_callai": true } } ``` -------------------------------- ### Get Call Event Subscription Example Source: https://developers.dialpad.com/reference/webhook_call_event_subscriptionget This example demonstrates the JSON response when successfully retrieving a call event subscription. It includes details about the subscription's call states, enablement, group call settings, ID, and associated webhook information. ```json { "call_states": [ "barge", "hangup", "recording" ], "enabled": true, "group_calls_only": true, "id": "5620703441190912", "webhook": { "hook_url": "https://test.com", "id": "6183653394612224", "signature": { "algo": "HS256", "secret": "puppy", "type": "jwt" } } } ``` -------------------------------- ### Create User Example Source: https://developers.dialpad.com/reference/userscreate This example demonstrates the structure of a successful response when creating a new user. It includes details such as company ID, user information, and associated settings. ```json { "company_id": "4508591728425653", "country": "us", "date_added": "2013-01-01T00:00:00", "display_name": "Mocky Mockson", "do_not_disturb": false, "emails": [ "mocky@fuzz-ball.com" ], "first_name": "Mocky", "id": "5137304475768569", "image_url": "https://dialpad.example.com/avatar/user/ag5kZXZ-dWJlci12b2ljZXIYCxILVXNlclByb2ZpbGUY-a2Gw56LkAkM.png?version=caaf49b4dbcec738c3b8fd1189746b89", "international_dialing_enabled": false, "is_admin": false, "is_available": true, "is_on_duty": false, "is_online": false, "is_super_admin": false, "language": "en", "last_name": "Mockson", "license": "talk", "muted": false, "office_id": "6422934115149452", "onboarding_completed": false, "state": "active", "timezone": "US/Pacific", "voicemail": { "is_default_voicemail": true, "name": "default", "voicemail_notifications_enabled": true } } ``` -------------------------------- ### Websocket Response Example Source: https://developers.dialpad.com/reference/websocketscreate An example of a successful response when creating a websocket, including its ID, URL, and signature configuration. ```json { "json_example": { "value": { "id": 12345, "websocket_url": "wss://example.com/events/12345", "signature": { "algo": "HS256", "secret": "your-secret-string", "type": "jwt" } } } } ``` -------------------------------- ### Webhook List Example (JSON) Source: https://developers.dialpad.com/reference/webhookslist This example demonstrates the structure of a successful response when retrieving a list of webhooks. It includes details about the webhook URL, ID, and signature configuration. ```json { "items": [ { "hook_url": "https://test.com/webhooks", "id": "193", "signature": { "algo": "HS256", "secret": "test_secret", "type": "jwt" } } ] } ``` -------------------------------- ### Create Dialpad Meeting Example Source: https://developers.dialpad.com/reference/meetingscreate This example demonstrates the structure of a successful response when creating a Dialpad meeting. It includes details such as meeting type, duration, participant information, and recurrence settings. ```json { "call_out": false, "dial_in_number": "12489834682", "duration": "3600", "id": "9", "instance_id": "9-1735721100", "meeting_type": "PERSONAL", "meeting_url": "https://meetings.dialpad.com/room/bot66", "organizer_pin": "123", "participant_pin": "123", "participants_info": [ { "display_name": "Bot 66", "email": "bot66@dialpad.com", "is_organizer": true, "phone": "+19253903216" } ], "recurrence": "RRULE:FREQ=WEEKLY", "recurrence_end_date": "2025-01-05T16:00:00+00:00", "start_datetime": "2025-01-05T15:00:00+00:00", "timezone": "UTC", "title": "test title" } ``` -------------------------------- ### List Websockets Response Example Source: https://developers.dialpad.com/reference/websocketslist An example JSON response when listing websockets. It includes a list of websocket objects, each with an ID, signature details, and a websocket URL. ```json { "items": [ { "id": "193", "signature": { "algo": "HS256", "secret": "test_secret", "type": "jwt" }, "websocket_url": "wss://test.example.com/v2/events/193" } ] } ``` -------------------------------- ### List Call Event Subscriptions Example Source: https://developers.dialpad.com/reference/webhook_call_event_subscriptionlist This example demonstrates a successful response when listing call event subscriptions. It shows the structure of the returned data, including subscription details like call states, enabled status, and webhook configuration. ```json { "items": [ { "call_states": [ "barge", "hangup", "recording" ], "enabled": true, "group_calls_only": true, "id": "5620703441190912", "webhook": { "hook_url": "https://test.com", "id": "6183653394612224", "signature": { "algo": "HS256", "secret": "puppy", "type": "jwt" } } } ] } ``` -------------------------------- ### Send Fax Example Source: https://developers.dialpad.com/reference/faxsend This example demonstrates the structure of a successful response when sending a fax. It includes details such as contact ID, status, and fax transaction information. ```json { "contact_id": "4516793766903808", "created_date": "2013-01-01T00:00:00+00:00", "direction": "outbound", "fax_status": "success", "fax_transaction": { "is_billed": false, "num_pages": "2" }, "fax_url": "https://dialpad.com/blob/fax/ag5kZXZ-dWJlci12b2ljZXIaCxIKRmF4TWVzc2FnZSIKOHJhVUFOQXR3QQw", "from_number": "+14155551000", "id": "8raUANAtwA", "sender_id": "5066549580791808", "to_number": "+14157731113", "user_id": "5066549580791808" } ``` -------------------------------- ### OpenAPI Definition Example Source: https://developers.dialpad.com/reference/callparticipantsadd This is an example of an OpenAPI definition for the Dialpad API. It includes server URLs and configuration for API explorers. ```json { "url": "https://sandbox.dialpad.com/" } ] } ``` ``` -------------------------------- ### List Off-Duty Statuses Example Source: https://developers.dialpad.com/reference/officesoffdutystatusesget This example demonstrates a successful response when listing off-duty statuses for an office. It shows the office ID and the associated off-duty status strings. ```json { "id": "124", "off_duty_statuses": [ "Lunch Time", "Off Duty" ] } ``` -------------------------------- ### Example JSON Response for User Status Update Source: https://developers.dialpad.com/reference/usersupdate_status This example shows the structure of a successful response when updating a user's status, including the user ID, status message, and expiration time. ```json { "expiration": "3600", "id": "5835806903417907", "status_message": "test status with expiration" } ``` -------------------------------- ### Custom IVR Assignment Example Source: https://developers.dialpad.com/reference/ivrupdate This JSON example demonstrates the structure of a successful response when assigning a custom IVR message. It includes details of the IVR type and a list of available IVR options with their IDs, names, and selection status. ```json { "ivr_type": "DEPARTMENT_INTRO", "ivrs": [ { "date_added": "1356998400000", "id": "4507997673881600", "name": "test_mp3", "selected": true }, { "date_added": "1356998400000", "id": "5620703441190912", "name": "mocked-file.mp3", "selected": false }, { "date_added": "1356998400000", "id": "6746603348033536", "name": "test_mp3", "selected": false } ] } ``` -------------------------------- ### E911 Address Get Example Response Source: https://developers.dialpad.com/reference/officese911get This is an example of a successful JSON response when retrieving an E911 address. It includes address lines, city, state, country, and zip code. ```json { "address": "3001 BISHOP DR", "address2": "ste 120", "city": "SAN RAMON", "country": "us", "state": "ca", "zip": "94583" } ``` -------------------------------- ### Get Websocket by ID Example Source: https://developers.dialpad.com/reference/websocketsget Retrieves a specific websocket using its ID. This operation is rate-limited to 1200 requests per minute. ```json { "id": "193", "signature": { "algo": "HS256", "secret": "test_secret", "type": "jwt" }, "websocket_url": "wss://platform-websockets-5bwy6zprxa-uc.a.run.app/events/eyJhbGciOiJIUzI1NiIsInR5cCI6InZuZC5kaWFscGFkLndlYnNvY2tldCtqd3QifQ.eyJzdWIiOiJlbmRwb2ludDoxOTM6KiIsImV4cCI6MTM1NzAwMjAwMCwiaXNzIjoiaHR0cHM6Ly90ZXN0YmVkLmV4YW1wbGUuY29tIiwiaWF0IjoxMzU2OTk4NDAwfQ.6ysTWkvMJG9uU1s18VRdcWRAqs_Nwen11BaeWse8lFE" } ``` -------------------------------- ### OpenAPI Definition Example Source: https://developers.dialpad.com/reference/bulk_messageslist This snippet shows a partial OpenAPI definition configuration. Ensure correct JSON formatting for integration. ```json { "proxy-enabled": false, "samples-enabled": true } } ``` -------------------------------- ### Get Stats Result Example Source: https://developers.dialpad.com/reference/statsget Retrieves the status of a statistics request using its ID. The response indicates if the process is 'processing', 'complete', or 'failed'. ```json { "status": "processing" } ``` -------------------------------- ### Get Agent Metrics Source: https://developers.dialpad.com/reference/wfm-metrics-agentget Retrieves WFM metrics for agents. You can filter the data by specifying a start and end timestamp. The `cursor` parameter can be used for paginating through results. ```APIDOC ## GET /wfm/metrics/agent ### Description Retrieves Work Force Management (WFM) metrics for agents within a specified time range. This endpoint allows for paginated retrieval of agent performance data. ### Method GET ### Endpoint /wfm/metrics/agent ### Query Parameters - **start** (string) - Required - UTC ISO 8601 timestamp (inclusive, e.g., 2025-01-17T00:00:00Z) - **end** (string) - Required - UTC ISO 8601 timestamp (exclusive, e.g., 2025-02-23T00:00:00Z) - **cursor** (string) - Optional - Include the cursor returned in a previous request to get the next page of data ### Response #### Success Response (200) - **items** (array) - An array of agent metrics objects. - **agent** (object) - Agent details. - **name** (string) - Agent's name. - **email** (string) - Agent's email. - **interval** (object) - The time interval for the metrics. - **start** (string) - The start of the interval. - **end** (string) - The end of the interval. - **scheduled_hours** (number) - Total scheduled hours for the agent in the interval. - **occupancy** (number) - Agent's occupancy percentage. - **adherence_score** (number) - Agent's adherence score. - **conversations_closed_per_hour** (number) - Number of conversations closed per hour. - **conversations_closed_per_service_hour** (number) - Number of conversations closed per service hour. - **total_conversations_closed** (number) - Total number of conversations closed. - **time_on_task** (number) - Percentage of time spent on tasks. - **utilisation** (number) - Agent's utilization percentage. - **actual_occupancy** (object) - Actual occupancy details. - **percentage** (number) - Occupancy percentage. - **seconds_lost** (number) - Seconds lost due to non-occupancy. - **dialpad_availability** (object) - Dialpad availability details. - **percentage** (number) - Availability percentage. - **seconds_lost** (number) - Seconds lost due to unavailability. - **planned_occupancy** (object) - Planned occupancy details. - **percentage** (number) - Planned occupancy percentage. - **seconds_lost** (number) - Seconds lost due to not meeting planned occupancy. - **time_in_adherence** (object) - Time spent in adherence. - **percentage** (number) - Percentage of time in adherence. - **seconds** (number) - Seconds spent in adherence. - **time_out_of_adherence** (object) - Time spent out of adherence. - **percentage** (number) - Percentage of time out of adherence. - **seconds** (number) - Seconds spent out of adherence. - **time_in_exception** (object) - Time spent in exception states. - **percentage** (number) - Percentage of time in exception. - **seconds** (number) - Seconds spent in exception. - **dialpad_time_in_status** (object) - Breakdown of time spent in different Dialpad statuses. - **available** (object) - Time spent in available status. - **percentage** (number) - Percentage of time available. - **seconds** (number) - Seconds spent available. - **busy** (object) - Time spent in busy status. - **percentage** (number) - Percentage of time busy. - **occupied** (object) - Time spent in occupied status. - **percentage** (number) - Percentage of time occupied. - **seconds** (number) - Seconds spent occupied. - **unavailable** (object) - Time spent in unavailable status. - **percentage** (number) - Percentage of time unavailable. - **seconds** (number) - Seconds spent unavailable. - **wrapup** (object) - Time spent in wrap-up status. - **percentage** (number) - Percentage of time in wrap-up. - **seconds** (number) - Seconds spent in wrap-up. #### Response Example ```json { "items": [ { "actual_occupancy": { "percentage": 0.62, "seconds_lost": 10800 }, "adherence_score": 95.5, "agent": { "email": "test@example.com", "name": "Test User" }, "conversations_closed_per_hour": 5.6, "conversations_closed_per_service_hour": 6.8, "dialpad_availability": { "percentage": 0.65, "seconds_lost": 9000 }, "dialpad_time_in_status": { "available": { "percentage": 0.17, "seconds": 5000 }, "busy": { "percentage": null }, "occupied": { "percentage": 0.41, "seconds": 12000 }, "unavailable": { "percentage": 0.28, "seconds": 8000 }, "wrapup": { "percentage": 0.12, "seconds": 3600 } }, "interval": { "end": "2025-01-02T00:00:00Z", "start": "2025-01-01T00:00:00Z" }, "occupancy": 0.92, "planned_occupancy": { "percentage": 0.95, "seconds_lost": 1200 }, "scheduled_hours": 8, "time_in_adherence": { "percentage": 0.94, "seconds": 27000 }, "time_in_exception": { "percentage": 0.02, "seconds": 600 }, "time_on_task": 0.78, "time_out_of_adherence": { "percentage": 0.04, "seconds": 1200 }, "total_conversations_closed": 45, "utilisation": 0.85 } ] } ``` ``` -------------------------------- ### Get Digital Sessions Data Source: https://developers.dialpad.com/reference/digitalsessionsdatalist Retrieves a list of digital sessions that were started or ended within the specified date range. Supports pagination using a cursor. ```APIDOC ## GET /api/v2/digital/sessionsdata ### Description Gets list of digital sessions which are started/ended in the requested period. NOTE: - The `cursor` value is provided in the API response, and can be passed as a parameter to retrieve subsequent pages of results. - Requested period must be less than 7 days Added on July 29th, 2025 for API v2. Requires scope: ``digital_sessions`` Rate limit: 100 per minute. ### Method GET ### Endpoint /api/v2/digital/sessionsdata ### Parameters #### Query Parameters - **cursor** (string) - Optional - A token used to return the next page of a previous request. Use the cursor provided in the previous response. - **end_date** (string) - Required - End date of the date range to be queried. E.g. 2024-09-25T00:00:00Z or 2024-09-25T00:00:00+04:00 or 2024-09-25T00:00:00-04:00 - **start_date** (string) - Required - Start date of the date range to be queried. E.g. 2024-09-25T00:00:00Z or 2024-09-25T00:00:00+04:00 or 2024-09-25T00:00:00-04:00 ### Response #### Success Response (200) - **sessions** (array) - List of digital sessions. - **cursor** (string) - Token to retrieve the next page of results. #### Response Example { "sessions": [ { "account_info": { "email": "string", "id": "string", "name": "string", "phone": "string" }, "call_id": "string", "end_time": "string", "id": "string", "start_time": "string", "target": { "id": "string", "name": "string", "type": "string" }, "user": { "display_name": "string", "id": "string", "primary_email": "string" } } ], "cursor": "string" } ``` -------------------------------- ### Create User Source: https://developers.dialpad.com/reference/userscreate Creates a new user with specified license. ```APIDOC ## POST /users ### Description Creates a new user. ### Method POST ### Endpoint /users ### Parameters #### Request Body - **license** (string) - Required - Specifies the license type for the user. Accepted values are: admins, agents, dpde_all, dpde_one, lite_lines, lite_support_agents, magenta_lines, talk, user. ### Request Example { "license": "agents" } ### Response #### Success Response (200) - **user** (object) - Details of the created user. #### Response Example { "user": { "id": "12345", "name": "John Doe", "email": "john.doe@example.com", "license": "agents" } } ``` -------------------------------- ### Update Call Center Example Source: https://developers.dialpad.com/reference/callcentersupdate This JSON example demonstrates the structure for updating a call center's configuration. It includes settings for advanced features, alerts, hours of operation, hold queue behavior, and routing options. Requires a company admin API key and is subject to a rate limit of 1200 per minute. ```json { "advanced_settings": { "auto_call_recording": { "allow_pause_recording": true, "call_recording_inbound": true, "call_recording_outbound": true }, "max_wrap_up_seconds": "5" }, "alerts": { "cc_service_level": "96", "cc_service_level_seconds": "59" }, "availability_status": "open", "country": "us", "first_action": "operators", "friday_hours": [ "08:00", "18:00" ], "group_description": "a cool test cc.", "hold_queue": { "allow_queue_callback": true, "announce_estimated_wait_time": false, "announce_position": true, "announcement_interval_seconds": "130", "estimated_wait_time_max": "30", "max_hold_count": "55", "max_hold_seconds": "930", "queue_callback_dtmf": "8", "queue_callback_threshold": "4", "queue_escape_dtmf": "*", "stay_in_queue_after_closing": true, "unattended_queue": true }, "hours_on": true, "id": "6742205301522432", "monday_hours": [ "09:00", "12:00", "14:00", "17:00" ], "name": "call center 2046", "no_operators_action": "voicemail", "office_id": "5048957394747392", "phone_numbers": [ "+14155551001" ], "ring_seconds": "45", "routing_options": { "closed": { "action": "person", "action_target_id": "5066549580791808", "action_target_type": "user", "dtmf": [ { "input": "0", "options": { "action": "voicemail" } } ] } } } ``` -------------------------------- ### Example Response for Deleting Custom IVR Source: https://developers.dialpad.com/reference/ivrdelete This is an example of a successful response when a custom IVR message is deleted. It returns details of the deleted message. ```json { "date_added": "1356998400000", "id": "6746603348033536", "name": "mocked-file.mp3", "selected": false } ``` -------------------------------- ### Office Get Endpoint Definition Source: https://developers.dialpad.com/reference/officesget This snippet defines the GET operation for retrieving office information. It includes parameters, response schemas, and tags for organization. ```yaml paths: /offices/{office_id}: get: operationId: "offices_get" parameters: - name: "office_id" in: "path" required: true schema: type: "string" responses: "200": content: application/json: schema: type: "object" properties: office: type: "object" properties: id: type: "string" name: type: "string" address: type: "string" city: type: "string" country: type: "string" state: type: "string" zip: type: "string" monday_hours: type: "array" items: type: "string" tuesday_hours: type: "array" items: type: "string" wednesday_hours: type: "array" items: type: "string" thursday_hours: type: "array" items: type: "string" friday_hours: type: "array" items: type: "string" saturday_hours: type: "array" items: type: "string" sunday_hours: type: "array" items: type: "string" timezone: type: "string" operator_routing: type: "string" try_dial_operators: type: "boolean" dtmf: type: "array" items: type: "object" properties: input: type: "string" options: type: "object" properties: action: type: "string" action_target_id: type: "string" action_target_type: type: "string" state: type: "string" schema: "$ref": "#/components/schemas/protos.office.OfficeProto" description: "A successful response" summary: "Office -- Get" tags: - "offices" x-ratelimit: - - 20 - 1 components: schemas: protos.office.OfficeProto: type: "object" properties: id: type: "string" name: type: "string" address: type: "string" city: type: "string" country: type: "string" state: type: "string" zip: type: "string" monday_hours: type: "array" items: type: "string" tuesday_hours: type: "array" items: type: "string" wednesday_hours: type: "array" items: type: "string" thursday_hours: type: "array" items: type: "string" friday_hours: type: "array" items: type: "string" saturday_hours: type: "array" items: type: "string" sunday_hours: type: "array" items: type: "string" timezone: type: "string" operator_routing: type: "string" try_dial_operators: type: "boolean" dtmf: type: "array" items: type: "object" properties: input: type: "string" options: type: "object" properties: action: type: "string" action_target_id: type: "string" action_target_type: type: "string" state: type: "string" security: - bearer_token: [] servers: - url: "https://dialpad.com/" - url: "https://sandbox.dialpad.com/" x-readme: explorer-enabled: true proxy-enabled: false samples-enabled: true ``` -------------------------------- ### Enable Samples in OpenAPI Definition Source: https://developers.dialpad.com/reference/conference-roomslist Configure your OpenAPI definition to enable sample requests and responses. Ensure this setting is correctly placed within the root of your OpenAPI document. ```json { "samples-enabled": true } ``` -------------------------------- ### Get Billing Plan Source: https://developers.dialpad.com/reference/planget Gets the plan for an office. Added on Mar 19, 2019 for API v2. Rate limit: 1200 per minute. ```APIDOC ## Get Billing Plan ### Description Gets the plan for an office. ### Method GET ### Endpoint /plan ### Parameters #### Query Parameters - **officeId** (string) - Required - The ID of the office to retrieve the plan for. ### Response #### Success Response (200) - **planName** (string) - The name of the billing plan. - **planId** (string) - The unique identifier for the billing plan. - **price** (number) - The cost of the billing plan. - **currency** (string) - The currency of the plan price. ``` -------------------------------- ### Create Meeting Room Request Example Source: https://developers.dialpad.com/reference/meetingsroomcreate This JSON object demonstrates the expected structure for creating a unique meeting room. It includes details such as the display number, meeting type, organizer and participant PINs, a unique meeting ID, the join URL, and the user ID. ```json { "display_number": "+1234567890", "meeting_type": "UNIQUE_MEETING", "organizer_pin": "1234", "participant_pin": "5678", "unique_meeting_id": "testroom", "url": "https://meetings.dialpad.com/room/fuzz-ball/testroom", "user_id": "5066549580791808" } ``` -------------------------------- ### Create Office Source: https://developers.dialpad.com/reference/officescreate Creates a secondary office. Rate limit: 1200 per minute. ```APIDOC ## POST /offices ### Description Creates a secondary office. ### Method POST ### Endpoint /offices ### Rate Limit 1200 per minute. ``` -------------------------------- ### Initiate Scorecards Export Source: https://developers.dialpad.com/reference/scorecardsexportcreate Begins processing statistics asynchronously. Returns a request ID to get the status and retrieve the results by calling GET /scorecards/export/{request_id}. ```APIDOC ## POST /scorecards/export ### Description Begins processing statistics asynchronously. Returns a request ID to get the status and retrieve the results by calling GET /scorecards/export/{request_id}. Scorecards for the whole company will be processed by default. A target_id and target_type can be provided to limit the stats to a single target. Added on Feb 12, 2024 for API v2. Rate limit: 250 per minute. ### Method POST ### Endpoint /scorecards/export ### Parameters #### Query Parameters - **target_id** (string) - Optional - The ID of the target to limit the stats to. - **target_type** (string) - Optional - The type of the target (e.g., 'user', 'group'). ### Request Body (No request body is specified in the documentation) ### Response #### Success Response (200) - **request_id** (string) - The ID of the export request, used to track status and retrieve results. #### Response Example ```json { "request_id": "abc123xyz789" } ``` ``` -------------------------------- ### Initiate Stats Processing Source: https://developers.dialpad.com/reference/statscreate Begins processing statistics asynchronously. Returns a request ID to get the status and retrieve the results by calling GET /stats/{request_id}. ```APIDOC ## POST /stats ### Description Begins processing statistics asynchronously. Returns a request ID to get the status and retrieve the results by calling GET /stats/{request_id}. Stats for the whole company will be processed by default. An office_id can be provided to limit stats to a single office. A target_id and target_type can be provided to limit stats to a single target. Added on May 3, 2018 for API v2. Rate limit: 200 per hour. ### Method POST ### Endpoint /stats ### Parameters #### Query Parameters - **office_id** (string) - Optional - Limits stats to a single office. - **target_id** (string) - Optional - Limits stats to a single target. - **target_type** (string) - Optional - Limits stats to a single target type. ### Request Example ```json { "office_id": "optional_office_id", "target_id": "optional_target_id", "target_type": "optional_target_type" } ``` ### Response #### Success Response (200) - **request_id** (string) - The ID of the processing request. ``` -------------------------------- ### E911 Address Get OpenAPI Definition Source: https://developers.dialpad.com/reference/officese911get This is the OpenAPI definition for the E911 Address Get endpoint. It outlines the request parameters, response structure, and authentication methods. ```json { "components": { "schemas": { "protos.office.E911GetProto": { "properties": { "address": { "description": "[single-line only]\n\nLine 1 of the E911 address.", "type": [ "null", "string" ] }, "address2": { "description": "[single-line only]\n\nLine 2 of the E911 address.", "type": [ "null", "string" ] }, "city": { "description": "[single-line only]\n\nCity of the E911 address.", "type": [ "null", "string" ] }, "country": { "description": "Country of the E911 address.", "type": [ "null", "string" ] }, "state": { "description": "[single-line only]\n\nState or Province of the E911 address.", "type": [ "null", "string" ] }, "zip": { "description": "[single-line only]\n\nZip code of the E911 address.", "type": [ "null", "string" ] } }, "title": "E911 address.", "type": "object" } }, "securitySchemes": { "bearer_token": { "description": "The API key can be put in the Authorization header.\ni.e. Authorization: Bearer ", "scheme": "bearer", "type": "http" } } }, "info": { "description": "# Introduction\n\nAdmin API v2 for Dialpad.\n\nRequests and responses from the admin API are provided in the JSON format.\n\n# Pagination\n\nList APIs support a limit and cursor parameter.\n\nThe limit defines the number of results to return. For the first request, pass in a desired limit.\nThe API response will contain a cursor field with a special string. Pass this special string into\nthe next request to retrieve the next page.\n\n# Authentication\n\nAll requests are authenticated via an API key in the query parameter or as a bearer token in the\nAuthorization header.\n\nAn API key can be acquired from the Dialpad admin web portal.\n\nNote: If you received your API key from the Dialpad support team rather than the web portal, the\nuser associated with your key must have company administrator permissions.", "title": "API", "version": "v2", "x-logo": { "altText": "Dialpad", "url": "https://storage.googleapis.com/dialpad_openapi_specs/logo.png" } }, "openapi": "3.1.0", "paths": { "/api/v2/offices/{id}/e911": { "get": { "deprecated": false, "description": "Gets E911 address of the office by office id.\n\nAdded on May 25, 2021 for API v2.\n\nRate limit: 1200 per minute.", "operationId": "offices.e911.get", "parameters": [ { "description": "The office's id.", "in": "path", "name": "id", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "json_example": { "value": { "address": "3001 BISHOP DR", "address2": "ste 120", "city": "SAN RAMON", "country": "us", "state": "ca", "zip": "94583" } } }, "schema": { "$ref": "#/components/schemas/protos.office.E911GetProto" } } }, "description": "A successful response" } }, "summary": "E911 Address -- Get", "tags": [ "offices" ], "x-ratelimit": [ [ 20, 1 ] ] } } }, "security": [ { "bearer_token": [] } ], "servers": [ { "url": "https://dialpad.com/" }, { "url": "https://sandbox.dialpad.com/" } ], "x-readme": { "explorer-enabled": true, "proxy-enabled": false, "samples-enabled": true } } ``` -------------------------------- ### OpenAPI Definition Configuration Source: https://developers.dialpad.com/reference/usersupdate Configure settings such as explorer, proxy, and samples enablement for the OpenAPI definition. ```json { "explorer-enabled": true, "proxy-enabled": false, "samples-enabled": true } ``` -------------------------------- ### Update Fax Event Subscription Example Source: https://developers.dialpad.com/reference/webhook_fax_event_subscriptionupdate This example shows the JSON response when a fax event subscription is updated. It includes details like the subscription ID, webhook URL, and signature settings. Requires the `fax_message` scope and is subject to a rate limit of 1200 per minute. ```json { "direction": "inbound", "enabled": false, "id": "194", "status": false, "webhook": { "hook_url": "https://test2.com", "id": "195", "signature": { "algo": "HS256", "secret": "random", "type": "jwt" } } } ```