dialpad-users - Pinkfish - AI Agents & Workflows for Getting Work Done

Server path: /dialpad-users | Type: Application | PCID required: Yes

Tools

Tool	Description
`dialpad_users_agentgroup_get`	Agent Group — Get
`dialpad_users_caller_id_users_get`	Caller ID — Get
`dialpad_users_caller_id_users_post`	Caller ID — Set
`dialpad_users_coaching_team_get`	Coaching Team — Get
`dialpad_users_coaching_team_listall`	Coaching Team — List
`dialpad_users_coaching_team_members_add`	Coaching Team — Add Member
`dialpad_users_coaching_team_members_get`	Coaching Team — List Members
`dialpad_users_contacts_create`	Contact — Create
`dialpad_users_contacts_create_with_uid`	Contact — Create or Update
`dialpad_users_contacts_delete`	Contact — Delete
`dialpad_users_contacts_get`	Contact — Get
`dialpad_users_contacts_list`	Contact — List
`dialpad_users_contacts_update`	Contact — Update
`dialpad_users_create`	User — Create
`dialpad_users_delete`	User — Delete
`dialpad_users_deskphones_users_delete`	Desk Phone — Delete
`dialpad_users_deskphones_users_get`	Desk Phone — Get
`dialpad_users_deskphones_users_list`	Desk Phone — List
`dialpad_users_e911_get`	E911 Address — Get
`dialpad_users_e911_update`	E911 Address — Update
`dialpad_users_get`	User — Get
`dialpad_users_initiate_call`	Call — Initiate
`dialpad_users_list`	User — List
`dialpad_users_move_office_patch`	User — Switch Office
`dialpad_users_numbers_assign_user_number_post`	Dialpad Number — Assign
`dialpad_users_numbers_user_unassign_number_post`	Dialpad Number — Unassign
`dialpad_users_personas_get`	Persona — List
`dialpad_users_screen_pop_initiate`	Screen-pop — Trigger
`dialpad_users_toggle_call_vi`	Call VI — Toggle
`dialpad_users_toggle_dnd`	Do Not Disturb — Toggle
`dialpad_users_update`	User — Update
`dialpad_users_update_active_call`	Call Recording — Toggle
`dialpad_users_update_status`	User Status — Update
`dialpad_users_userdevices_get`	User Device — Get
`dialpad_users_userdevices_list`	User Device — List

dialpad_users_agentgroup_get

Agent Group — Get Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	the Agent Group id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "the Agent Group id"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

dialpad_users_caller_id_users_get

Caller ID — Get Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	The user’s id. (‘me’ can be used if you are using a user level API key)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The user's id. ('me' can be used if you are using a user level API key)"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

dialpad_users_caller_id_users_post

Caller ID — Set Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	The user’s id. (‘me’ can be used if you are using a user level API key)
`caller_id`	string	Yes	—	Phone number (e164 formatted) that will be defined as a Caller ID for the target. Use ‘blocked’ to block the Caller ID.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The user's id. ('me' can be used if you are using a user level API key)"
    },
    "caller_id": {
      "type": "string",
      "description": "Phone number (e164 formatted) that will be defined as a Caller ID for the target. Use 'blocked' to block the Caller ID."
    }
  },
  "required": [
    "PCID",
    "id",
    "caller_id"
  ]
}

dialpad_users_coaching_team_get

Coaching Team — Get Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	Id of the coaching team

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "Id of the coaching team"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

dialpad_users_coaching_team_listall

Coaching Team — List Parameters:

Parameter	Type	Required	Default	Description
`cursor`	string	No	—	A token used to return the next page of a previous request. Use the cursor provided in the previous response.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "A token used to return the next page of a previous request. Use the cursor provided in the previous response."
    }
  },
  "required": [
    "PCID"
  ]
}

dialpad_users_coaching_team_members_add

Coaching Team — Add Member Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	Id of the coaching team
`member_id`	string	Yes	—	The id of the user added to the coaching team.
`role`	string	Yes	—	The role of the user added.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "Id of the coaching team"
    },
    "member_id": {
      "type": "string",
      "description": "The id of the user added to the coaching team."
    },
    "role": {
      "type": "string",
      "description": "The role of the user added.",
      "enum": [
        "coach",
        "trainee"
      ]
    }
  },
  "required": [
    "PCID",
    "id",
    "member_id",
    "role"
  ]
}

dialpad_users_coaching_team_members_get

Coaching Team — List Members Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	Id of the coaching team

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "Id of the coaching team"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

dialpad_users_contacts_create

Contact — Create Parameters:

Parameter	Type	Required	Default	Description
`company_name`	string	null	No	—	[single-line only] The contact’s company name.
`emails`	string[]	No	—	The contact’s emails. The first email in the list is the contact’s primary email.
`extension`	string	null	No	—	The contact’s extension number.
`first_name`	string	Yes	—	[single-line only] The contact’s first name.
`job_title`	string	null	No	—	[single-line only] The contact’s job title.
`last_name`	string	Yes	—	[single-line only] The contact’s last name.
`owner_id`	string	null	No	—	The id of the user who will own this contact. If provided, a local contact will be created for this user. Otherwise, the contact will be created as a shared contact in your company.
`phones`	string[]	No	—	The contact’s phone numbers. The phone number must be in e164 format. The first number in the list is the contact’s primary phone.
`trunk_group`	string	null	No	—	[Deprecated]
`urls`	string[]	No	—	A list of websites associated with or belonging to this contact.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "company_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "[single-line only]  The contact's company name."
    },
    "emails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The contact's emails.  The first email in the list is the contact's primary email."
    },
    "extension": {
      "type": [
        "string",
        "null"
      ],
      "description": "The contact's extension number."
    },
    "first_name": {
      "type": "string",
      "description": "[single-line only]  The contact's first name."
    },
    "job_title": {
      "type": [
        "string",
        "null"
      ],
      "description": "[single-line only]  The contact's job title."
    },
    "last_name": {
      "type": "string",
      "description": "[single-line only]  The contact's last name."
    },
    "owner_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The id of the user who will own this contact.  If provided, a local contact will be created for this user. Otherwise, the contact will be created as a shared contact in your company."
    },
    "phones": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The contact's phone numbers.  The phone number must be in e164 format. The first number in the list is the contact's primary phone."
    },
    "trunk_group": {
      "type": [
        "string",
        "null"
      ],
      "description": "[Deprecated]"
    },
    "urls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of websites associated with or belonging to this contact."
    }
  },
  "required": [
    "PCID",
    "first_name",
    "last_name"
  ]
}

dialpad_users_contacts_create_with_uid

Contact — Create or Update Parameters:

Parameter	Type	Required	Default	Description
`company_name`	string	null	No	—	[single-line only] The contact’s company name.
`emails`	string[]	No	—	The contact’s emails. The first email in the list is the contact’s primary email.
`extension`	string	null	No	—	The contact’s extension number.
`first_name`	string	Yes	—	[single-line only] The contact’s first name.
`job_title`	string	null	No	—	[single-line only] The contact’s job title.
`last_name`	string	Yes	—	[single-line only] The contact’s last name.
`phones`	string[]	No	—	The contact’s phone numbers. The phone number must be in e164 format. The first number in the list is the contact’s primary phone.
`trunk_group`	string	null	No	—	[Deprecated]
`uid`	string	Yes	—	The unique id to be included as part of the contact’s generated id.
`urls`	string[]	No	—	A list of websites associated with or belonging to this contact.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "company_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "[single-line only]  The contact's company name."
    },
    "emails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The contact's emails.  The first email in the list is the contact's primary email."
    },
    "extension": {
      "type": [
        "string",
        "null"
      ],
      "description": "The contact's extension number."
    },
    "first_name": {
      "type": "string",
      "description": "[single-line only]  The contact's first name."
    },
    "job_title": {
      "type": [
        "string",
        "null"
      ],
      "description": "[single-line only]  The contact's job title."
    },
    "last_name": {
      "type": "string",
      "description": "[single-line only]  The contact's last name."
    },
    "phones": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The contact's phone numbers.  The phone number must be in e164 format. The first number in the list is the contact's primary phone."
    },
    "trunk_group": {
      "type": [
        "string",
        "null"
      ],
      "description": "[Deprecated]"
    },
    "uid": {
      "type": "string",
      "description": "The unique id to be included as part of the contact's generated id."
    },
    "urls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of websites associated with or belonging to this contact."
    }
  },
  "required": [
    "PCID",
    "first_name",
    "last_name",
    "uid"
  ]
}

dialpad_users_contacts_delete

Contact — Delete Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	The contact’s id.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The contact's id."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

dialpad_users_contacts_get

Contact — Get Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	The contact’s id.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The contact's id."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

dialpad_users_contacts_list

Contact — List Parameters:

Parameter	Type	Required	Default	Description
`cursor`	string	No	—	A token used to return the next page of a previous request. Use the cursor provided in the previous response.
`include_local`	boolean	No	—	If set to True company local contacts will be included. default False.
`owner_id`	string	No	—	The id of the user who owns the contact.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "A token used to return the next page of a previous request. Use the cursor provided in the previous response."
    },
    "include_local": {
      "type": "boolean",
      "description": "If set to True company local contacts will be included. default False."
    },
    "owner_id": {
      "type": "string",
      "description": "The id of the user who owns the contact."
    }
  },
  "required": [
    "PCID"
  ]
}

dialpad_users_contacts_update

Contact — Update Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	The contact’s id.
`company_name`	string	null	No	—	[single-line only] The contact’s company name.
`emails`	string[]	No	—	The contact’s emails. The first email in the list is the contact’s primary email.
`extension`	string	null	No	—	The contact’s extension number.
`first_name`	string	null	No	—	[single-line only] The contact’s first name.
`job_title`	string	null	No	—	[single-line only] The contact’s job title.
`last_name`	string	null	No	—	[single-line only] The contact’s last name.
`phones`	string[]	No	—	The contact’s phone numbers. The phone number must be in e164 format. The first number in the list is the contact’s primary phone.
`trunk_group`	string	null	No	—	[Deprecated]
`urls`	string[]	No	—	A list of websites associated with or belonging to this contact.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The contact's id."
    },
    "company_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "[single-line only]  The contact's company name."
    },
    "emails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The contact's emails.  The first email in the list is the contact's primary email."
    },
    "extension": {
      "type": [
        "string",
        "null"
      ],
      "description": "The contact's extension number."
    },
    "first_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "[single-line only]  The contact's first name."
    },
    "job_title": {
      "type": [
        "string",
        "null"
      ],
      "description": "[single-line only]  The contact's job title."
    },
    "last_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "[single-line only]  The contact's last name."
    },
    "phones": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The contact's phone numbers.  The phone number must be in e164 format. The first number in the list is the contact's primary phone."
    },
    "trunk_group": {
      "type": [
        "string",
        "null"
      ],
      "description": "[Deprecated]"
    },
    "urls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of websites associated with or belonging to this contact."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

dialpad_users_create

User — Create Parameters:

Parameter	Type	Required	Default	Description
`auto_assign`	boolean	null	No	—	If set to true, a number will be automatically assigned.
`email`	string	Yes	—	The user’s email.
`first_name`	string	null	No	—	[single-line only] The user’s first name.
`last_name`	string	null	No	—	[single-line only] The user’s last name.
`license`	string	null	No	—	The user’s license type. This affects billing for the user.
`office_id`	integer	Yes	—	The user’s office id.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "auto_assign": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "If set to true, a number will be automatically assigned."
    },
    "email": {
      "type": "string",
      "description": "The user's email."
    },
    "first_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "[single-line only]  The user's first name."
    },
    "last_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "[single-line only]  The user's last name."
    },
    "license": {
      "type": [
        "string",
        "null"
      ],
      "description": "The user's license type. This affects billing for the user.",
      "enum": [
        "admins",
        "agents",
        "dpde_all",
        "dpde_one",
        "lite_lines",
        "lite_support_agents",
        "magenta_lines",
        "talk",
        "user"
      ]
    },
    "office_id": {
      "type": "integer",
      "description": "The user's office id."
    }
  },
  "required": [
    "PCID",
    "email",
    "office_id"
  ]
}

dialpad_users_delete

User — Delete Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	The user’s id. (‘me’ can be used if you are using a user level API key)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The user's id. ('me' can be used if you are using a user level API key)"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

dialpad_users_deskphones_users_delete

Desk Phone — Delete Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	The desk phone’s id.
`parent_id`	integer	Yes	—	The user’s id. (‘me’ can be used if you are using a user level API key)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The desk phone's id."
    },
    "parent_id": {
      "type": "integer",
      "description": "The user's id. ('me' can be used if you are using a user level API key)"
    }
  },
  "required": [
    "PCID",
    "id",
    "parent_id"
  ]
}

dialpad_users_deskphones_users_get

Desk Phone — Get Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	The desk phone’s id.
`parent_id`	integer	Yes	—	The user’s id. (‘me’ can be used if you are using a user level API key)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The desk phone's id."
    },
    "parent_id": {
      "type": "integer",
      "description": "The user's id. ('me' can be used if you are using a user level API key)"
    }
  },
  "required": [
    "PCID",
    "id",
    "parent_id"
  ]
}

dialpad_users_deskphones_users_list

Desk Phone — List Parameters:

Parameter	Type	Required	Default	Description
`parent_id`	integer	Yes	—	The user’s id. (‘me’ can be used if you are using a user level API key)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "parent_id": {
      "type": "integer",
      "description": "The user's id. ('me' can be used if you are using a user level API key)"
    }
  },
  "required": [
    "PCID",
    "parent_id"
  ]
}

dialpad_users_e911_get

E911 Address — Get Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	The user’s id. (‘me’ can be used if you are using a user level API key)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The user's id. ('me' can be used if you are using a user level API key)"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

dialpad_users_e911_update

E911 Address — Update Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	The user’s id. (‘me’ can be used if you are using a user level API key)
`address`	string	Yes	—	[single-line only] Line 1 of the new E911 address.
`address2`	string	null	No	—	[single-line only] Line 2 of the new E911 address.
`city`	string	Yes	—	[single-line only] City of the new E911 address.
`country`	string	Yes	—	Country of the new E911 address.
`state`	string	Yes	—	[single-line only] State or Province of the new E911 address.
`use_validated_option`	boolean	null	No	—	Whether to use the validated address option from our service.
`zip`	string	Yes	—	[single-line only] Zip of the new E911 address.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The user's id. ('me' can be used if you are using a user level API key)"
    },
    "address": {
      "type": "string",
      "description": "[single-line only]  Line 1 of the new E911 address."
    },
    "address2": {
      "type": [
        "string",
        "null"
      ],
      "description": "[single-line only]  Line 2 of the new E911 address."
    },
    "city": {
      "type": "string",
      "description": "[single-line only]  City of the new E911 address."
    },
    "country": {
      "type": "string",
      "description": "Country of the new E911 address."
    },
    "state": {
      "type": "string",
      "description": "[single-line only]  State or Province of the new E911 address."
    },
    "use_validated_option": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether to use the validated address option from our service."
    },
    "zip": {
      "type": "string",
      "description": "[single-line only]  Zip of the new E911 address."
    }
  },
  "required": [
    "PCID",
    "id",
    "address",
    "city",
    "country",
    "state",
    "zip"
  ]
}

dialpad_users_get

User — Get Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	The user’s id. (‘me’ can be used if you are using a user level API key)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The user's id. ('me' can be used if you are using a user level API key)"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

dialpad_users_initiate_call

Call — Initiate Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	The user’s id. (‘me’ can be used if you are using a user level API key)
`custom_data`	string	null	No	—	Extra data to associate with the call. This will be passed through to any subscribed call events.
`group_id`	integer	null	No	—	The ID of a group that will be used to initiate the call.
`group_type`	string	null	No	—	The type of a group that will be used to initiate the call.
`outbound_caller_id`	string	null	No	—	The e164-formatted number shown to the call recipient (or “blocked”). If set to “blocked”, the recipient will receive a call from “unknown caller”. The number can be the caller’s number, or the caller’s group number if the group is provided, or the caller’s company reserved number.
`phone_number`	string	null	No	—	The e164-formatted number to call.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The user's id. ('me' can be used if you are using a user level API key)"
    },
    "custom_data": {
      "type": [
        "string",
        "null"
      ],
      "description": "Extra data to associate with the call. This will be passed through to any subscribed call events."
    },
    "group_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The ID of a group that will be used to initiate the call."
    },
    "group_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "The type of a group that will be used to initiate the call.",
      "enum": [
        "callcenter",
        "department",
        "office"
      ]
    },
    "outbound_caller_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The e164-formatted number shown to the call recipient (or \"blocked\").  If set to \"blocked\", the recipient will receive a call from \"unknown caller\". The number can be the caller's number, or the caller's group number if the group is provided, or the caller's company reserved number."
    },
    "phone_number": {
      "type": [
        "string",
        "null"
      ],
      "description": "The e164-formatted number to call."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

dialpad_users_list

User — List Parameters:

Parameter	Type	Required	Default	Description
`cursor`	string	No	—	A token used to return the next page of a previous request. Use the cursor provided in the previous response.
`state`	string	No	—	Filter results by the specified user state (e.g. active, suspended, deleted)
`company_admin`	boolean	No	—	If provided, filter results by the specified value to return only company admins or only non-company admins.
`email`	string	No	—	The user’s email.
`number`	string	No	—	The user’s phone number.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "A token used to return the next page of a previous request. Use the cursor provided in the previous response."
    },
    "state": {
      "type": "string",
      "description": "Filter results by the specified user state (e.g. active, suspended, deleted)",
      "enum": [
        "active",
        "all",
        "cancelled",
        "deleted",
        "pending",
        "suspended"
      ]
    },
    "company_admin": {
      "type": "boolean",
      "description": "If provided, filter results by the specified value to return only company admins or only non-company admins."
    },
    "email": {
      "type": "string",
      "description": "The user's email."
    },
    "number": {
      "type": "string",
      "description": "The user's phone number."
    }
  },
  "required": [
    "PCID"
  ]
}

dialpad_users_move_office_patch

User — Switch Office Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	The user’s id. (‘me’ can be used if you are using a user level API key)
`office_id`	integer	null	No	—	The user’s office id. When provided, the user will be moved to this office.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The user's id. ('me' can be used if you are using a user level API key)"
    },
    "office_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The user's office id. When provided, the user will be moved to this office."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

dialpad_users_numbers_assign_user_number_post

Dialpad Number — Assign Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	The user’s id. (‘me’ can be used if you are using a user level API key)
`area_code`	string	null	No	—	An area code in which to find an available phone number for assignment.
`number`	string	null	No	—	A phone number to assign. (e164-formatted)
`primary`	boolean	null	No	—	A boolean indicating whether this should become the primary phone number.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The user's id. ('me' can be used if you are using a user level API key)"
    },
    "area_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "An area code in which to find an available phone number for assignment."
    },
    "number": {
      "type": [
        "string",
        "null"
      ],
      "description": "A phone number to assign. (e164-formatted)"
    },
    "primary": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "A boolean indicating whether this should become the primary phone number."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

dialpad_users_numbers_user_unassign_number_post

Dialpad Number — Unassign Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	The user’s id. (‘me’ can be used if you are using a user level API key)
`number`	string	Yes	—	A phone number to unassign. (e164-formatted)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The user's id. ('me' can be used if you are using a user level API key)"
    },
    "number": {
      "type": "string",
      "description": "A phone number to unassign. (e164-formatted)"
    }
  },
  "required": [
    "PCID",
    "id",
    "number"
  ]
}

dialpad_users_personas_get

Persona — List Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	The user’s id. (‘me’ can be used if you are using a user level API key)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The user's id. ('me' can be used if you are using a user level API key)"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

dialpad_users_screen_pop_initiate

Screen-pop — Trigger Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	The user’s id. (‘me’ can be used if you are using a user level API key)
`screen_pop_uri`	string	Yes	—	The screen pop’s url. Most Url should start with scheme name such as http or https. Be aware that url with userinfo subcomponent, such as “https://username:password@www.example.com” is not supported for security reasons. Launching native apps is also supported through a format such as “customuri://domain.com”

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The user's id. ('me' can be used if you are using a user level API key)"
    },
    "screen_pop_uri": {
      "type": "string",
      "description": "The screen pop's url.  Most Url should start with scheme name such as http or https. Be aware that url with userinfo subcomponent, such as \"https://username:password@www.example.com\" is not supported for security reasons. Launching native apps is also supported through a format such as \"customuri://domain.com\""
    }
  },
  "required": [
    "PCID",
    "id",
    "screen_pop_uri"
  ]
}

dialpad_users_toggle_call_vi

Call VI — Toggle Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	The user’s id. (‘me’ can be used if you are using a user level API key)
`enable_vi`	boolean	null	No	—	Whether or not call vi should be enabled.
`vi_locale`	string	null	No	—	The locale to use for vi.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The user's id. ('me' can be used if you are using a user level API key)"
    },
    "enable_vi": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether or not call vi should be enabled."
    },
    "vi_locale": {
      "type": [
        "string",
        "null"
      ],
      "description": "The locale to use for vi.",
      "enum": [
        "de-de",
        "en-au",
        "en-ca",
        "en-gb",
        "en-mx",
        "en-nz",
        "en-us",
        "es-es",
        "es-mx",
        "es-us",
        "fr-ca",
        "fr-fr",
        "it-it",
        "ja-jp",
        "ko-kr",
        "nl-nl",
        "pt-br",
        "sv-se",
        "zh-cn"
      ]
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

dialpad_users_toggle_dnd

Do Not Disturb — Toggle Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	The user’s id. (‘me’ can be used if you are using a user level API key)
`do_not_disturb`	boolean	Yes	—	Determines if DND is ON or OFF.
`group_id`	integer	null	No	—	The ID of the group which the user’s DND status will be updated for.
`group_type`	string	null	No	—	The type of the group which the user’s DND status will be updated for.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The user's id. ('me' can be used if you are using a user level API key)"
    },
    "do_not_disturb": {
      "type": "boolean",
      "description": "Determines if DND is ON or OFF."
    },
    "group_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The ID of the group which the user's DND status will be updated for."
    },
    "group_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "The type of the group which the user's DND status will be updated for.",
      "enum": [
        "callcenter",
        "department",
        "office"
      ]
    }
  },
  "required": [
    "PCID",
    "id",
    "do_not_disturb"
  ]
}

dialpad_users_update

User — Update Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	The user’s id. (‘me’ can be used if you are using a user level API key)
`admin_office_ids`	integer[]	No	—	The list of admin office IDs. This is used to set the user as an office admin for the offices with the provided IDs.
`emails`	string[]	No	—	The user’s emails. This can be used to add, remove, or re-order emails. The first email in the list is the user’s primary email.
`extension`	string	null	No	—	The user’s new extension number. Extensions are optional in Dialpad and turned off by default. If you want extensions please contact support to enable them.
`first_name`	string	null	No	—	[single-line only] The user’s first name.
`forwarding_numbers`	string[]	No	—	A list of phone numbers that should be dialed in addition to the user’s Dialpad number(s) upon receiving a call.
`international_dialing_enabled`	boolean	null	No	—	Whether or not the user is enabled to dial internationally.
`is_super_admin`	boolean	null	No	—	Whether or not the user is a super admin. (company level administrator)
`job_title`	string	null	No	—	[single-line only] The user’s job title.
`keep_paid_numbers`	boolean	null	No	—	Whether or not to keep phone numbers when switching to a support license. Note: Phone numbers require additional number licenses under a support license.
`last_name`	string	null	No	—	[single-line only] The user’s last name.
`license`	string	null	No	—	The user’s license type. Changing this affects billing for the user. For a Sell license, specify the type as `agents`. For a Support license, specify the type as `support`.
`office_id`	integer	null	No	—	The user’s office id. If provided, the user will be moved to this office. For international offices, the user must not have phone numbers assigned. Once the transfer is complete, your admin can add the phone numbers via the user assign number API. Only supported on paid accounts and there must be enough licenses to transfer the user to the destination office.
`phone_numbers`	string[]	No	—	A list of the phone number(s) assigned to this user. This can be used to re-order or remove numbers. To assign a new number, use the assign number API instead.
`presence_status`	object	No	—	Presence Status
`state`	string	null	No	—	The user’s state. This is used to suspend or re-activate a user.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The user's id. ('me' can be used if you are using a user level API key)"
    },
    "admin_office_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int64"
      },
      "description": "The list of admin office IDs.  This is used to set the user as an office admin for the offices with the provided IDs."
    },
    "emails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The user's emails.  This can be used to add, remove, or re-order emails. The first email in the list is the user's primary email."
    },
    "extension": {
      "type": [
        "string",
        "null"
      ],
      "description": "The user's new extension number.  Extensions are optional in Dialpad and turned off by default. If you want extensions please contact support to enable them."
    },
    "first_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "[single-line only]  The user's first name."
    },
    "forwarding_numbers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of phone numbers that should be dialed in addition to the user's Dialpad number(s) upon receiving a call."
    },
    "international_dialing_enabled": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether or not the user is enabled to dial internationally."
    },
    "is_super_admin": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether or not the user is a super admin. (company level administrator)"
    },
    "job_title": {
      "type": [
        "string",
        "null"
      ],
      "description": "[single-line only]  The user's job title."
    },
    "keep_paid_numbers": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether or not to keep phone numbers when switching to a support license.  Note: Phone numbers require additional number licenses under a support license."
    },
    "last_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "[single-line only]  The user's last name."
    },
    "license": {
      "type": [
        "string",
        "null"
      ],
      "description": "The user's license type.  Changing this affects billing for the user. For a Sell license, specify the type as `agents`. For a Support license, specify the type as `support`.",
      "enum": [
        "admins",
        "agents",
        "dpde_all",
        "dpde_one",
        "lite_lines",
        "lite_support_agents",
        "magenta_lines",
        "talk",
        "user"
      ]
    },
    "office_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The user's office id.  If provided, the user will be moved to this office. For international offices, the user must not have phone numbers assigned. Once the transfer is complete, your admin can add the phone numbers via the user assign number API. Only supported on paid accounts and there must be enough licenses to transfer the user to the destination office."
    },
    "phone_numbers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of the phone number(s) assigned to this user.  This can be used to re-order or remove numbers. To assign a new number, use the assign number API instead."
    },
    "presence_status": {
      "type": "object",
      "description": "Presence Status",
      "properties": {
        "message": {
          "type": "string",
          "description": "The presence status message to be updated."
        },
        "provider": {
          "type": "string",
          "description": "The provider requesting the presence status update."
        },
        "type": {
          "type": "string",
          "description": "Predefined templates will be only used for the supported types.  Accepts the following types: - `default` -- status message template: \"{provider}: {message}\" - `conference` -- status message template: \"On {provider}: in the {message} meeting\"  `provider` and `message` should be chosen with the message template in mind.",
          "enum": [
            "conference",
            "default"
          ]
        }
      }
    },
    "state": {
      "type": [
        "string",
        "null"
      ],
      "description": "The user's state.  This is used to suspend or re-activate a user.",
      "enum": [
        "active",
        "suspended"
      ]
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

dialpad_users_update_active_call

Call Recording — Toggle Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	The user’s id. (‘me’ can be used if you are using a user level API key)
`is_recording`	boolean	null	No	—	Whether or not recording should be enabled.
`play_message`	boolean	null	No	—	Whether or not to play a message to indicate the call is being recorded (or recording has stopped).
`recording_type`	string	null	No	—	Whether or not to toggle recording for the operator call (personal recording), the group call (department recording), or both. Only applicable for group calls (call centers, departments, etc.)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The user's id. ('me' can be used if you are using a user level API key)"
    },
    "is_recording": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether or not recording should be enabled."
    },
    "play_message": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether or not to play a message to indicate the call is being recorded (or recording has stopped)."
    },
    "recording_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "Whether or not to toggle recording for the operator call (personal recording), the group call (department recording), or both.  Only applicable for group calls (call centers, departments, etc.)",
      "enum": [
        "all",
        "group",
        "user"
      ]
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

dialpad_users_update_status

User Status — Update Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	The user’s id. (‘me’ can be used if you are using a user level API key)
`expiration`	integer	null	No	—	The expiration of this status. None for no expiration.
`status_message`	string	null	No	—	The status message for the user.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The user's id. ('me' can be used if you are using a user level API key)"
    },
    "expiration": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The expiration of this status. None for no expiration."
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "The status message for the user."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

dialpad_users_userdevices_get

User Device — Get Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	The device’s id.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The device's id."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

dialpad_users_userdevices_list

User Device — List Parameters:

Parameter	Type	Required	Default	Description
`cursor`	string	No	—	A token used to return the next page of a previous request. Use the cursor provided in the previous response.
`user_id`	string	No	—	The user’s id. (‘me’ can be used if you are using a user level API key)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "A token used to return the next page of a previous request. Use the cursor provided in the previous response."
    },
    "user_id": {
      "type": "string",
      "description": "The user's id. ('me' can be used if you are using a user level API key)"
    }
  },
  "required": [
    "PCID"
  ]
}

​Tools

​dialpad_users_agentgroup_get

​dialpad_users_caller_id_users_get

​dialpad_users_caller_id_users_post

​dialpad_users_coaching_team_get

​dialpad_users_coaching_team_listall

​dialpad_users_coaching_team_members_add

​dialpad_users_coaching_team_members_get

​dialpad_users_contacts_create

​dialpad_users_contacts_create_with_uid

​dialpad_users_contacts_delete

​dialpad_users_contacts_get

​dialpad_users_contacts_list

​dialpad_users_contacts_update

​dialpad_users_create

​dialpad_users_delete

​dialpad_users_deskphones_users_delete

​dialpad_users_deskphones_users_get

​dialpad_users_deskphones_users_list

​dialpad_users_e911_get

​dialpad_users_e911_update

​dialpad_users_get

​dialpad_users_initiate_call

​dialpad_users_list

​dialpad_users_move_office_patch

​dialpad_users_numbers_assign_user_number_post

​dialpad_users_numbers_user_unassign_number_post

​dialpad_users_personas_get

​dialpad_users_screen_pop_initiate

​dialpad_users_toggle_call_vi

​dialpad_users_toggle_dnd

​dialpad_users_update

​dialpad_users_update_active_call

​dialpad_users_update_status

​dialpad_users_userdevices_get

​dialpad_users_userdevices_list

Tools

dialpad_users_agentgroup_get

dialpad_users_caller_id_users_get

dialpad_users_caller_id_users_post

dialpad_users_coaching_team_get

dialpad_users_coaching_team_listall

dialpad_users_coaching_team_members_add

dialpad_users_coaching_team_members_get

dialpad_users_contacts_create

dialpad_users_contacts_create_with_uid

dialpad_users_contacts_delete

dialpad_users_contacts_get

dialpad_users_contacts_list

dialpad_users_contacts_update

dialpad_users_create

dialpad_users_delete

dialpad_users_deskphones_users_delete

dialpad_users_deskphones_users_get

dialpad_users_deskphones_users_list

dialpad_users_e911_get

dialpad_users_e911_update

dialpad_users_get

dialpad_users_initiate_call

dialpad_users_list

dialpad_users_move_office_patch

dialpad_users_numbers_assign_user_number_post

dialpad_users_numbers_user_unassign_number_post

dialpad_users_personas_get

dialpad_users_screen_pop_initiate

dialpad_users_toggle_call_vi

dialpad_users_toggle_dnd

dialpad_users_update

dialpad_users_update_active_call

dialpad_users_update_status

dialpad_users_userdevices_get

dialpad_users_userdevices_list