helpwise_list_conversations
List conversations
List conversations (threads) of one or more inboxes, newest first, with subject, snippet, tags, assignee, read/starred/closed flags and contact. Pick the folder with `folder` (default: all). Page with `next_page_token`. Inbox ids come from helpwise_list_inboxes. GET /conversations.
输入参数limitfolderinbox_ids必填page_token
helpwise_get_conversation
Get conversation
One conversation with its messages, notes, drafts, assignment and contacts. Page long conversations with `page_token` from the previous reply. GET /inboxes/{inbox_id}/conversations/{conversation_id}.
输入参数limitfolderinbox_id必填page_tokenconversation_id必填
helpwise_list_contacts
List contacts
List contacts (name, company, job title, emails, phones, id). Page with limit and offset. GET /contacts.
输入参数limitoffset
helpwise_search_contacts
Search contacts
Search contacts by a name, email or phone term. Page with limit and offset. GET /contacts/search.
输入参数term必填limitoffset
helpwise_get_contact
Get contact
One contact with emails, phones, company, custom fields and recent conversations. GET /contacts/{id}.
输入参数contact_id必填
helpwise_list_tags
List tags
All tags (id, name, colour, parent, inbox). Use the ids with helpwise_apply_tags. GET /tags.
无需输入参数。
One tag by id. GET /tags/{id}.
输入参数tag_id必填
helpwise_get_report
Overall report
Overall and team-performance report for a date range: new/closed/assigned conversations (with change vs the previous period), inbound/outbound messages per day, busiest hour/day, average first response, response and resolution time, CSAT and per-agent performance. Optional inbox and tag filters. GET /reports.
输入参数end必填start必填tag_idsinbox_idbusiness_hours_only
helpwise_get_tags_report
Tags report
Per-tag report for one inbox and a date range: conversations per tag (and share), open conversations, average response, first-response and resolution time. GET /inboxes/{inbox_id}/reports/tags.
输入参数end必填start必填tag_idsinbox_id必填business_hours_only
helpwise_list_inboxes
List inboxes
List the account's inboxes (mailboxes) with id, name, address and type. Use the ids in the other tools. POST /mailboxes/list (V0).
输入参数pagelimit
helpwise_list_users
List users
List the team members (agents) with access to an inbox: id, name, email. Use the ids with helpwise_assign_conversation. POST /users/list (V0).
输入参数inbox_id必填
helpwise_get_current_user
Get current user
The Helpwise user the API key belongs to (name, email, id). POST /users/me (V0).
无需输入参数。
helpwise_create_contact
Create contact
WRITE: create a new contact in Helpwise (name, company, job title, emails, phones, custom fields). Nothing is sent to the person. Creating the same email twice may create a duplicate. POST /contacts.
输入参数emailsphonescompanylastnamefirstname必填job_titlecustom_fields
helpwise_update_contact
Update contact
WRITE: change a contact's name, company, job title, emails, phones or custom fields. Helpwise updates with PUT, so this tool first reads the contact and sends the current values together with your changes; a list you pass (emails, phones, custom_fields) REPLACES the old list. Nothing is sent to the person. PUT /contacts/{id}.
输入参数emailsphonescompanylastnamefirstnamejob_titlecontact_id必填custom_fields
helpwise_add_note
Add note
WRITE: add an internal note to a conversation. Visible to your Helpwise team only; it is not sent to the customer. Notes cannot be deleted through this API. POST /notes/add (V0).
输入参数message必填inbox_id必填conversation_id必填
helpwise_assign_conversation
Assign conversation
WRITE: assign a conversation to a team member (user id from helpwise_list_users), or pass assigned_to 0 to unassign it. The assignee may be notified by Helpwise. POST /threads/assign (V0).
输入参数inbox_id必填assigned_to必填conversation_id必填
helpwise_close_conversations
Close conversations
WRITE: close up to 25 conversations (mark them done). They can be reopened with helpwise_reopen_conversations. Nothing is sent to customers. PUT /conversations/action/close.
输入参数conversation_ids必填
helpwise_reopen_conversations
Reopen conversations
WRITE: move up to 25 conversations back to the inbox (reopen closed ones). Nothing is sent to customers. PUT /conversations/action/moveToInbox.
输入参数conversation_ids必填
helpwise_apply_tags
Apply tags
WRITE: apply existing tags (ids from helpwise_list_tags) to up to 25 conversations. Tags can drive Helpwise automations. Applying a tag already present changes nothing. POST /tags/apply.
输入参数tag_ids必填conversation_ids必填
helpwise_remove_tags
Remove tags from conversations
WRITE: take tags off up to 25 conversations. The tags themselves are not deleted. POST /tags/remove.
输入参数tag_ids必填conversation_ids必填
helpwise_send_email
Send email
WRITE: SEND A REAL EMAIL from a Helpwise inbox to the given customer address(es). Irreversible; once sent it cannot be recalled. At most 10 recipients in total (to + cc), one message per call; never use it for lists or campaigns. This starts a new message (it is not a reply on an existing conversation). The body is plain text (blank line = new paragraph); it is sent as HTML. POST /emails/send_mail (V0).
输入参数ccto必填body必填subject必填inbox_id必填reply_to