Skip to main content
Dialpad logo

Dialpad

Lets an agent drive your Dialpad business phone system - send SMS/MMS, place and control calls, read AI transcripts and recaps, manage users, contacts, offices, departments and call centers, run analytics exports, and wire up webhooks.

What it can do​

MethodWhat it does
dialpad_send_smsSend an SMS/MMS to up to 10 recipients.
dialpad_list_callsList calls with time/target filters.
dialpad_get_callGet one call and its metadata.
dialpad_initiate_callPlace an outbound call on a user's behalf.
dialpad_transfer_callTransfer an active call to a number or target.
dialpad_hangup_callHang up an active call.
dialpad_get_transcriptGet a call's transcript.
dialpad_get_ai_recapGet a call's AI recap (summary, action items).
dialpad_list_usersList users; filter by email or state.
dialpad_get_userGet one user.
dialpad_create_userProvision a new user in an office.
dialpad_update_userUpdate a user's name, license, or state.
dialpad_delete_userDelete a user.
dialpad_assign_user_numberAssign a phone number to a user.
dialpad_list_contactsList shared or user-local contacts.
dialpad_get_contactGet one contact.
dialpad_create_contactCreate a contact.
dialpad_update_contactUpdate a contact.
dialpad_delete_contactDelete a contact.
dialpad_list_officesList offices.
dialpad_get_officeGet one office.
dialpad_list_departmentsList departments.
dialpad_get_departmentGet one department.
dialpad_list_department_operatorsList a department's operators.
dialpad_list_call_centersList call centers.
dialpad_get_call_centerGet one call center.
dialpad_list_call_center_operatorsList a call center's operators.
dialpad_add_call_center_operatorAdd an operator to a call center queue.
dialpad_remove_call_center_operatorRemove an operator from a call center.
dialpad_create_statsStart an analytics export (returns a request_id).
dialpad_get_statsPoll an analytics export result.
dialpad_list_webhooksList webhooks.
dialpad_get_webhookGet one webhook.
dialpad_create_webhookCreate a webhook endpoint.
dialpad_delete_webhookDelete a webhook.
dialpad_list_call_subscriptionsList call event subscriptions.
dialpad_create_call_subscriptionSubscribe a webhook to call events.
dialpad_delete_call_subscriptionDelete a call event subscription.
dialpad_list_sms_subscriptionsList SMS event subscriptions.
dialpad_create_sms_subscriptionSubscribe a webhook to SMS events.
dialpad_delete_sms_subscriptionDelete an SMS event subscription.
dialpad_list_numbersList the company's phone numbers (filter by status).
dialpad_get_numberGet one phone number's details.
dialpad_assign_numberAssign a number to any target (auto or specific).
dialpad_assign_specific_numberAssign a specific number to a target.
dialpad_unassign_numberUn-assign a number from its target.
dialpad_format_numberReformat a number between local and E.164.
dialpad_list_office_operatorsList an office mainline's operators.
dialpad_add_office_operatorAdd an operator to an office mainline.
dialpad_remove_office_operatorRemove an operator from an office mainline.
dialpad_create_departmentCreate a department.
dialpad_update_departmentUpdate a department.
dialpad_delete_departmentDelete a department.
dialpad_add_department_operatorAdd an operator to a department.
dialpad_remove_department_operatorRemove an operator from a department.
dialpad_create_call_centerCreate a call center.
dialpad_update_call_centerUpdate a call center.
dialpad_delete_call_centerDelete a call center.
dialpad_get_transcript_urlGet a downloadable transcript URL for a call.
dialpad_list_contact_subscriptionsList contact event subscriptions.
dialpad_create_contact_subscriptionSubscribe a webhook to contact events.
dialpad_delete_contact_subscriptionDelete a contact event subscription.
dialpad_list_agent_status_subscriptionsList agent status event subscriptions.
dialpad_create_agent_status_subscriptionSubscribe a webhook to agent status events.
dialpad_delete_agent_status_subscriptionDelete an agent status event subscription.
dialpad_list_change_log_subscriptionsList change log event subscriptions.
dialpad_create_change_log_subscriptionSubscribe a webhook to change log events.
dialpad_delete_change_log_subscriptionDelete a change log event subscription.
dialpad_toggle_dndToggle a user's Do Not Disturb.
dialpad_update_user_statusUpdate a user's status message and expiration.
dialpad_list_user_devicesList a user's devices.
dialpad_get_user_deviceGet one of a user's devices.
dialpad_list_user_deskphonesList a user's desk phones.
dialpad_get_user_e911Get a user's E911 emergency address.
dialpad_list_user_caller_idsList a user's available and active caller IDs.
dialpad_screen_popTrigger a screen pop on a user's device.
dialpad_list_allAuto-paginate any cursor-paginated list endpoint.

How to get credentials​

A Company (or Office) Admin creates the API key:

  1. Open dialpad.com/developers for the developer portal and current instructions.
  2. In Dialpad, go to Admin Settings -> Company (or Office) -> Authentication -> API keys.
  3. Add a key, name it (e.g. FlyMyAI Agent), and copy the token.
  4. The key authenticates as the whole company - keep it secret and revoke it from the same screen if it leaks.

Fields to fill in FlyMyAI​

FlyMyAI fieldWhere it comes from
DIALPAD_API_KEYAdmin Settings -> Company/Office -> Authentication -> API keys