What does Contact "Consumer ID (optional)" mean

API and Webhooks
1

What does Contact “Consumer ID (optional)” mean?

What is its function? Why does the http api create or update contact request body not have “Consumer ID” Field

Contact Center APIs {addressBookId }/contacts

2

Hey @Alexander.LWZ
Thanks for reaching out to us and welcome to the Zoom developer forum.
Could you share with me where do you see the consumer ID optional? Do you see it in the request body or response? I am not able to locate it

3

Hi Elisa, thanks for your reply.
For example, we have the optional consumer ID as optional in first item, when we manually create contact in ZCC address book. (Sorry I got error when reply: An error occurred: Sorry, you can’t embed media items in a post.)

But when we create contact by API, we can’t manually set this field in request body and it’s also not in response. (link is in description, failed to add it here…)

4

Sorry I tried to upload a screenshot but failed. Could you try to navigate to “Contact backend management website: /cci/index/admin#/admin-address-books” and click “add contact”? The first edit box is named as : (Failed append link due to “An error occurred: Sorry, you can’t include links in your posts.”)

Add Contact
Add Contact
Consumer ID (optional)
Enter consumer ID
Display name
Enter display name
First name (optional)
Enter first name
Last name (optional)
Enter last name

5

Hey @Alexander.LWZ
Let me send you a DM and see if that way you can share links

1 Like
6

Thanks Elisa, please let me know when I can do this.

7

Hi Elisa, I can add some spaces into url to bypass the permission check.

Here is our admin panel, when manually add contact, we have a list of optional consumer ID available.
https:// telenav. zoom. us /cci/index/admin#/admin-address-books

But when we call API to create or update contact, this field is not available.
https:// developers .zoom. us/docs/api/contact-center/#tag/address-books/POST/contact_center/address_books

So what’s this consumer ID mean and how to use it by API. Thanks.

8

Hey @Alexander.LWZ
Thanks for sharing more details with me.
I can see what you are talking about now.
Let me ask internally about this but sometimes our API does not match 100% whats in the UI.
I will get back to you soon

9

Hey @Alexander.LWZ
Thanks for your patience here.
Consumer IDs are generated automatically when people start web chats, etc. And then a consumer ID is linked to an Address Book when an agent answers the chat, and picks an address book. That’s why this is not available via API
Hope this helps,
Elisa