# Zoom Contact Center

> Work with Zoom Contact Center: look up engagements, recordings and voicemails, transfer or end engagements, text customers, keep address books up to date and manage agents and queues. Start a workflow when an engagement starts or ends, or a recording or voicemail arrives.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/zoom-contact-center

## Actions

### Add agents to queue

Make people agents of a queue, so its engagements can reach them.

**Inputs**

- Queue (`queue_id`, text, required): The queue. Pick one, or give its ID from an earlier step.
- Agents (`agent_ids`, list, required): The people to add. Pick them, or give Zoom user IDs or emails.

**Outputs**

- `added` (number): How many were added
- `agents` (list): Who was added (not those already in the queue)

**Example output**

```json
{
  "added": 1,
  "agents": [
    {
      "cc_user_id": "ccu_Xy98",
      "display_name": "Jo Chen",
      "status_name": "Ready",
      "user_email": "jo@example.com",
      "user_id": "u_Ab12Cd34"
    }
  ]
}
```

### Add contact to campaign list

Add someone to an outbound campaign's contact list, so the campaign calls them.

**Inputs**

- Contact list (`contact_list_id`, text, required): The campaign contact list. Pick one, or give its ID.
- Name (`display_name`, text): Their name. Defaults to the first and last name.
- First name (`first_name`, text): Their first name.
- Last name (`last_name`, text): Their last name.
- Phone numbers (`phone_numbers`, list, required): Up to 5, with country codes. The first is the main number.
- Emails (`emails`, list): Up to 4 email addresses.
- Company (`company`, text): Their company.
- Account number (`account_number`, text): Their account number.

**Outputs**

- `contact` (object): The contact added

**Example output**

```json
{
  "contact": {
    "contact_account_number": "AC-1001",
    "contact_company": "Example Co",
    "contact_display_name": "Sam Rivera",
    "contact_emails": [
      "sam@example.com"
    ],
    "contact_first_name": "Sam",
    "contact_id": "occ_19x",
    "contact_last_name": "Rivera",
    "contact_phones": [
      {
        "contact_phone_number": "+14155550100",
        "contact_phone_type": "Main"
      }
    ]
  }
}
```

### Create contact

Add a contact to an address book, so agents see who is calling.

**Inputs**

- Address book (`address_book_id`, text, required): The address book. Pick one, or give its ID from an earlier step.
- Name (`display_name`, text): The name agents see. Defaults to the first and last name.
- First name (`first_name`, text): Their first name.
- Last name (`last_name`, text): Their last name.
- Phone numbers (`phone_numbers`, list): Up to 5, with country codes. The first is their main number. Give a phone number or an email.
- Emails (`emails`, list): Up to 4 email addresses.
- Company (`company`, text): Their company.
- Role (`role`, text): Their job title.
- Account number (`account_number`, text): Their account number.
- Location (`location`, text): Where they are.
- Time zone (`time_zone`, text): Their time zone, such as America/New_York.

**Outputs**

- `contact` (object): The contact

**Example output**

```json
{
  "contact": {
    "account_number": "AC-1001",
    "address_book_id": "ab_Customers",
    "address_book_name": "Customers",
    "company": "Example Co",
    "contact_id": "ct_4Fj8",
    "display_name": "Sam Rivera",
    "emails": [
      "sam@example.com"
    ],
    "first_name": "Sam",
    "last_name": "Rivera",
    "location": "San Francisco",
    "phones": [
      {
        "phone_number": "+14155550100",
        "phone_type": "main"
      }
    ],
    "role": "Buyer",
    "timezone": "America/Los_Angeles"
  }
}
```

### Delete contact

Remove a contact from an address book.

**Inputs**

- Address book (`address_book_id`, text, required): The address book. Pick one, or give its ID from an earlier step.
- Contact (`contact_id`, text, required): The contact's ID, from 'Find contacts' or an earlier step.

**Outputs**

- `contact_id` (text): The contact removed
- `deleted` (true/false): True once removed

**Example output**

```json
{
  "contact_id": "ct_4Fj8",
  "deleted": true
}
```

### End engagement

End an open engagement.

**Inputs**

- Engagement (`engagement_id`, text, required): The engagement's ID, from a trigger or an earlier step.

**Outputs**

- `ended` (true/false): True once it is ended
- `engagement_id` (text): The engagement

**Example output**

```json
{
  "ended": true,
  "engagement_id": "eng_9QpWz2RtL4"
}
```

### Find contacts

Find contacts in an address book by email or phone number, or list them all.

**Inputs**

- Address book (`address_book_id`, text, required): The address book. Pick one, or give its ID from an earlier step.
- Email (`email`, list): Only contacts with this email (an exact match). Up to 10.
- Phone number (`phone_number`, list): Only contacts with this number, with its country code. Up to 10.
- Most results (`limit`, number): The most to return, up to 1000. Defaults to 50. Default: `50`.

**Outputs**

- `contacts` (list): The contacts
- `count` (number): How many

**Example output**

```json
{
  "contacts": [
    {
      "account_number": "AC-1001",
      "address_book_id": "ab_Customers",
      "address_book_name": "Customers",
      "company": "Example Co",
      "contact_id": "ct_4Fj8",
      "display_name": "Sam Rivera",
      "emails": [
        "sam@example.com"
      ],
      "first_name": "Sam",
      "last_name": "Rivera",
      "location": "San Francisco",
      "phones": [
        {
          "phone_number": "+14155550100",
          "phone_type": "main"
        }
      ],
      "role": "Buyer",
      "timezone": "America/Los_Angeles"
    }
  ],
  "count": 1
}
```

### Get contact

Get one address book contact.

**Inputs**

- Address book (`address_book_id`, text, required): The address book. Pick one, or give its ID from an earlier step.
- Contact (`contact_id`, text, required): The contact's ID, from 'Find contacts' or an earlier step.

**Outputs**

- `contact` (object): The contact

**Example output**

```json
{
  "contact": {
    "account_number": "AC-1001",
    "address_book_id": "ab_Customers",
    "address_book_name": "Customers",
    "company": "Example Co",
    "contact_id": "ct_4Fj8",
    "display_name": "Sam Rivera",
    "emails": [
      "sam@example.com"
    ],
    "first_name": "Sam",
    "last_name": "Rivera",
    "location": "San Francisco",
    "phones": [
      {
        "phone_number": "+14155550100",
        "phone_type": "main"
      }
    ],
    "role": "Buyer",
    "timezone": "America/Los_Angeles"
  }
}
```

### Get engagement

Get a finished engagement with its events, queue, agents, outcome and notes. Zoom shows it a few minutes after it ends.

**Inputs**

- Engagement (`engagement_id`, text, required): The engagement's ID, from a trigger or an earlier step.

**Outputs**

- `engagement` (object): The engagement

**Example output**

```json
{
  "engagement": {
    "agents": [
      {
        "display_name": "Jo Chen",
        "user_id": "u_Ab12Cd34"
      }
    ],
    "channels": [
      {
        "channel": "voice",
        "channel_source": "voice"
      }
    ],
    "consumers": [
      {
        "consumer_display_name": "Sam Rivera",
        "consumer_id": "c_81kd02",
        "consumer_number": "+14155550100"
      }
    ],
    "direction": "inbound",
    "dispositions": [
      {
        "disposition_id": "d_res",
        "disposition_name": "Resolved"
      }
    ],
    "duration": 449,
    "end_time": "2026-11-17T15:09:40Z",
    "engagement_id": "eng_3jTXd1QbQ0yaW9mB",
    "flows": [
      {
        "flow_id": "f_Main01",
        "flow_name": "Main line"
      }
    ],
    "handling_duration": 400,
    "notes": [
      {
        "note": "Reset the customer's password.",
        "note_id": "n_1",
        "user_id": "u_Ab12Cd34"
      }
    ],
    "queues": [
      {
        "cc_queue_id": "q_Support01",
        "queue_name": "Support"
      }
    ],
    "start_time": "2026-11-17T15:02:11Z",
    "talk_duration": 380,
    "transcript_url": "",
    "voice_mail": 0,
    "waiting_duration": 42,
    "wrap_up_duration": 20
  }
}
```

### List address books

List your address books and how many contacts each holds.

**Inputs**

- Unit (`unit_id`, text): Only address books in this unit. Leave blank for all.

**Outputs**

- `address_books` (list): The address books
- `count` (number): How many

**Example output**

```json
{
  "address_books": [
    {
      "address_book_description": "Everyone who has bought from us",
      "address_book_id": "ab_Customers",
      "address_book_name": "Customers",
      "total_contacts": 1250,
      "unit_id": "un_Main",
      "unit_name": "Main"
    }
  ],
  "count": 1
}
```

### List engagements

List finished calls, chats, texts, videos and emails in a time range, with their queue, agents, durations, outcome and notes.

**Inputs**

- From (`start`, date and time): Start of the time range. Defaults to seven days before the end.
- To (`end`, date and time): End of the time range, at most 31 days after the start. Defaults to now.
- Channel (`channel`, text): Only this channel. One of: `voice`, `video`, `messaging` (Messaging (chat, SMS)), `email`.
- Direction (`direction`, text): Only inbound or only outbound. One of: `inbound`, `outbound`.
- Queue (`queue_id`, text): Only this queue. Pick one, or give its ID from an earlier step.
- Customer phone number (`customer_number`, text): Only engagements with this number, with its country code.
- Most results (`limit`, number): The most to return, up to 1000. Defaults to 50. Default: `50`.

**Outputs**

- `count` (number): How many
- `engagements` (list): The engagements

**Example output**

```json
{
  "count": 1,
  "engagements": [
    {
      "agents": [
        {
          "display_name": "Jo Chen",
          "user_id": "u_Ab12Cd34"
        }
      ],
      "channels": [
        {
          "channel": "voice",
          "channel_source": "voice"
        }
      ],
      "consumers": [
        {
          "consumer_display_name": "Sam Rivera",
          "consumer_id": "c_81kd02",
          "consumer_number": "+14155550100"
        }
      ],
      "direction": "inbound",
      "dispositions": [
        {
          "disposition_id": "d_res",
          "disposition_name": "Resolved"
        }
      ],
      "duration": 449,
      "end_time": "2026-11-17T15:09:40Z",
      "engagement_id": "eng_3jTXd1QbQ0yaW9mB",
      "flows": [
        {
          "flow_id": "f_Main01",
          "flow_name": "Main line"
        }
      ],
      "handling_duration": 400,
      "notes": [
        {
          "note": "Reset the customer's password.",
          "note_id": "n_1",
          "user_id": "u_Ab12Cd34"
        }
      ],
      "queues": [
        {
          "cc_queue_id": "q_Support01",
          "queue_name": "Support"
        }
      ],
      "start_time": "2026-11-17T15:02:11Z",
      "talk_duration": 380,
      "transcript_url": "",
      "voice_mail": 0,
      "waiting_duration": 42,
      "wrap_up_duration": 20
    }
  ]
}
```

### List open engagements

List engagements happening now: in a flow, waiting in a queue, ringing or with an agent.

**Inputs**

- Channel (`channel`, text): Only this channel. One of: `voice`, `video`, `messaging` (Messaging (chat, SMS)), `email`, `work_item` (Work item).
- Status (`status`, text): Only engagements in this state. One of: `in_flow` (In a flow), `in_queue` (Waiting in a queue), `ringing` (Ringing an agent), `assigned` (With an agent), `assigned(on_hold)` (On hold), `callback` (Callback requested), `awaiting_callback` (Awaiting callback), `callback_retry` (Callback being retried), `virtual_agent` (With a virtual agent), `parked`, `inactive`.
- Queue (`queue_id`, text): Only this queue. Pick one, or give its ID from an earlier step.
- Agent (`agent_id`, text): Only engagements with this agent. Pick one, or give their Zoom user ID or email.
- Most results (`limit`, number): The most to return, up to 1000. Defaults to 50. Default: `50`.

**Outputs**

- `count` (number): How many
- `engagements` (list): The open engagements

**Example output**

```json
{
  "count": 1,
  "engagements": [
    {
      "agents": [],
      "channels": [
        {
          "channel": "messaging",
          "channel_source": "web_chat"
        }
      ],
      "consumers": [
        {
          "consumer_display_name": "Ana",
          "consumer_id": "c_55",
          "consumer_number": ""
        }
      ],
      "direction": "inbound",
      "engagement_id": "eng_9QpWz2RtL4",
      "flows": [
        {
          "flow_id": "f_Chat01",
          "flow_name": "Web chat"
        }
      ],
      "queues": [
        {
          "cc_queue_id": "q_Support01",
          "queue_name": "Support"
        }
      ],
      "start_time": "2026-11-18T10:01:00Z",
      "status": "in_queue"
    }
  ]
}
```

### List queues

List your queues with their channel and how many agents each has.

**Inputs**

- Channel (`channel`, text): Only queues for this channel. One of: `voice`, `video`, `messaging` (Messaging (chat, SMS)), `email`, `work_item` (Work item).
- Name (`name`, text): Only the queue with this exact name. End it with * to match names that start with it.
- Most results (`limit`, number): The most to return, up to 1000. Defaults to 50. Default: `50`.

**Outputs**

- `count` (number): How many
- `queues` (list): The queues

**Example output**

```json
{
  "count": 1,
  "queues": [
    {
      "agents_count": 12,
      "cc_queue_id": "q_Support01",
      "channel": "voice",
      "last_modified_time": "2026-10-20T12:00:00Z",
      "queue_name": "Support",
      "supervisors_count": 2
    }
  ]
}
```

### List recordings

List call and video recordings, of one engagement or in a time range, with their links.

**Inputs**

- Engagement (`engagement_id`, text): Only this engagement's recordings. Leave blank for all.
- From (`start`, date and time): Start of the time range. Defaults to seven days before the end.
- To (`end`, date and time): End of the time range, at most 31 days after the start. Defaults to now.
- Channel (`channel`, text): Only voice or only video. One of: `voice`, `video`.
- Most results (`limit`, number): The most to return, up to 1000. Defaults to 50. Default: `50`.

**Outputs**

- `count` (number): How many
- `recordings` (list): The recordings

**Example output**

```json
{
  "count": 1,
  "recordings": [
    {
      "cc_queue_id": "q_Support01",
      "channel": "voice",
      "consumer_name": "Sam Rivera",
      "consumer_number": "+14155550100",
      "direction": "inbound",
      "display_name": "Jo Chen",
      "download_url": "https://zoom.us/contact_center/recording/download/rec_7Hn2Kd",
      "engagement_id": "eng_3jTXd1QbQ0yaW9mB",
      "playback_url": "https://zoom.us/contact_center/recording/playback/rec_7Hn2Kd",
      "queue_name": "Support",
      "recording_duration": 390,
      "recording_end_time": "2026-11-17T15:09:30Z",
      "recording_id": "rec_7Hn2Kd",
      "recording_start_time": "2026-11-17T15:03:00Z",
      "recording_type": "automatic",
      "transcript_url": "https://zoom.us/contact_center/recording/transcripts/download/rec_7Hn2Kd",
      "user_email": "jo@example.com",
      "user_id": "u_Ab12Cd34"
    }
  ]
}
```

### List users

List your Contact Center's agents, supervisors and admins, with each one's status.

**Inputs**

- Search (`search`, text): Only users whose name or email matches.
- Access (`access`, text): Only users who can, or can't, use Contact Center. One of: `active` (Can use Contact Center), `inactive` (Can't use Contact Center).
- Most results (`limit`, number): The most to return, up to 1000. Defaults to 50. Default: `50`.

**Outputs**

- `count` (number): How many
- `users` (list): The users

**Example output**

```json
{
  "count": 1,
  "users": [
    {
      "cc_user_id": "ccu_Xy98",
      "display_name": "Jo Chen",
      "last_modified_time": "2026-11-01T09:00:00Z",
      "role_name": "Agent",
      "status_id": "st_ready",
      "status_name": "Ready",
      "sub_status_id": "",
      "sub_status_name": "",
      "user_access": "active",
      "user_email": "jo@example.com",
      "user_id": "u_Ab12Cd34"
    }
  ]
}
```

### List voicemails

List voicemails customers left in a time range, with who called and their links.

**Inputs**

- From (`start`, date and time): Start of the time range. Defaults to seven days before the end.
- To (`end`, date and time): End of the time range, at most 31 days after the start. Defaults to now.
- Queue (`queue_id`, text): Only this queue. Pick one, or give its ID from an earlier step.
- Caller's phone number (`customer_number`, text): Only voicemails from this number, with its country code.
- Most results (`limit`, number): The most to return, up to 1000. Defaults to 50. Default: `50`.

**Outputs**

- `count` (number): How many
- `voicemails` (list): The voicemails

**Example output**

```json
{
  "count": 1,
  "voicemails": [
    {
      "cci_queue_id": "q_Support01",
      "consumer_display_name": "Sam Rivera",
      "consumer_number": "+14155550100",
      "created_at": "2026-11-17T22:15:00Z",
      "download_url": "https://zoom.us/contact_center/inbox/download/vm_2Lk9",
      "engagement_id": "eng_Vm77",
      "flow_name": "Main line",
      "inbox_id": "ib_Main",
      "inbox_name": "After hours",
      "message_duration": 31,
      "message_id": "vm_2Lk9",
      "playback_url": "https://zoom.us/contact_center/inbox/playback/vm_2Lk9",
      "queue_name": "Support",
      "status": "normal",
      "transcript_url": "https://zoom.us/contact_center/inbox/transcripts/vm_2Lk9"
    }
  ]
}
```

### Remove agent from queue

Take an agent out of a queue, so they stop getting its engagements.

**Inputs**

- Queue (`queue_id`, text, required): The queue. Pick one, or give its ID from an earlier step.
- Agent (`agent_id`, text, required): The agent. Pick one, or give their Zoom user ID or email.

**Outputs**

- `agent_id` (text): The agent removed
- `queue_id` (text): The queue
- `removed` (true/false): True once removed

**Example output**

```json
{
  "agent_id": "u_Ab12Cd34",
  "queue_id": "q_Support01",
  "removed": true
}
```

### Send text message

Text up to 20 people from one of your Contact Center's SMS numbers. They must have opted in to texts from it.

**Inputs**

- From (`from_number`, text, required): Your SMS number to send from. Pick one, or give it with its country code.
- To (`to`, list, required): Phone numbers to text, with country codes. Up to 20.
- Message (`message`, text, required): What to say, up to 500 characters.

**Outputs**

- `messages` (list): One per number
- `sent` (number): How many numbers it went to

**Example output**

```json
{
  "messages": [
    {
      "consumer_number": "+14155550100",
      "contact_center_number": "+14155550199",
      "message_id": "IQ-dhfaoufosadfb",
      "success": true
    }
  ],
  "sent": 1
}
```

### Set agent status

Set an agent's status, such as Ready, or Not Ready with a reason.

**Inputs**

- Agent (`agent_id`, text, required): The agent. Pick one, or give their Zoom user ID or email.
- Status (`status_id`, text, required): Their new status. Pick one, or give its ID.
- Not Ready reason (`reason_id`, text): Why they're not ready, such as Break. Only with Not Ready.

**Outputs**

- `agent_id` (text): The agent
- `reason_id` (text): Their Not Ready reason
- `status_id` (text): Their new status

**Example output**

```json
{
  "agent_id": "u_Ab12Cd34",
  "reason_id": "st_break",
  "status_id": "st_notready"
}
```

### Transfer engagement

Hand an open engagement to a queue, an agent or a flow. Fill in one of the three.

**Inputs**

- Engagement (`engagement_id`, text, required): The engagement's ID, from a trigger or an earlier step.
- Queue (`queue_id`, text): Transfer it to this queue. Pick one, or give its ID from an earlier step.
- Agent (`agent_id`, text): Transfer it to this agent. Pick one, or give their Zoom user ID or email.
- Flow (`flow_id`, text): Transfer it to this flow. Pick one, or give its ID.

**Outputs**

- `engagement_id` (text): The engagement
- `target_id` (text): Where it went
- `transferred_to` (text): queue, agent or flow

**Example output**

```json
{
  "engagement_id": "eng_9QpWz2RtL4",
  "target_id": "q_Billing02",
  "transferred_to": "queue"
}
```

### Update contact

Change an address book contact. Fields left blank keep their value.

**Inputs**

- Address book (`address_book_id`, text, required): The address book. Pick one, or give its ID from an earlier step.
- Contact (`contact_id`, text, required): The contact's ID, from 'Find contacts' or an earlier step.
- Name (`display_name`, text): The name agents see. Leave blank to keep it.
- First name (`first_name`, text): Their first name. Leave blank to keep it.
- Last name (`last_name`, text): Their last name. Leave blank to keep it.
- Phone numbers (`phone_numbers`, list): Up to 5, with country codes. The first is their main number. Leave blank to keep it.
- Emails (`emails`, list): Up to 4 email addresses. These replace the current ones.
- Company (`company`, text): Their company. Leave blank to keep it.
- Role (`role`, text): Their job title. Leave blank to keep it.
- Account number (`account_number`, text): Their account number. Leave blank to keep it.
- Location (`location`, text): Where they are. Leave blank to keep it.
- Time zone (`time_zone`, text): Their time zone, such as America/New_York. Leave blank to keep it.

**Outputs**

- `contact` (object): The contact

**Example output**

```json
{
  "contact": {
    "account_number": "AC-1001",
    "address_book_id": "ab_Customers",
    "address_book_name": "Customers",
    "company": "Example Co",
    "contact_id": "ct_4Fj8",
    "display_name": "Sam Rivera",
    "emails": [
      "sam@example.com"
    ],
    "first_name": "Sam",
    "last_name": "Rivera",
    "location": "San Francisco",
    "phones": [
      {
        "phone_number": "+14155550100",
        "phone_type": "main"
      }
    ],
    "role": "Buyer",
    "timezone": "America/Los_Angeles"
  }
}
```
