Skip to main content

Zoom Phone inputs for the integration

What Ocular needs from the store's Zoom Phone account to handle after-hours calls, measure them and compare against the previous assistant. Complete this list with your Zoom administrator and send it to your Ocular Customer Success contact.

Do not send credentials, tokens or keys by email or chat. API access is granted from the Zoom account by an administrator user, through the secure channel Customer Success indicates.

1. Account and access​

InputDetailRequired
Zoom Phone administratorName and email of the person who can change numbers, queues and hoursYes
Zoom Phone planPlan type and account region (determines whether external forwarding and the API are enabled)Yes
Zoom Phone API accessA Server-to-Server OAuth app created by your administrator in your own Zoom account, with read permissions on call logs, recordings and transcripts, users and queues. No Marketplace app installation or Zoom review is required. Instructions in section 1.1. Used to measure, compare and load the knowledge base.Yes for the comparison
Write permissions (optional)If you want Ocular to update forwarding or the after-hours route from the platform, write permission on number and queue configurationNo

1.1 How to create the Server-to-Server OAuth app (done by your Zoom administrator)​

It is an app type internal to your account: it is not published in the Marketplace and does not go through Zoom review. Cost: zero. Time: minutes.

  1. Sign in at marketplace.zoom.us with an administrator user of the store's Zoom account.
  2. Top right, Develop → Build App.
  3. Choose the Server-to-Server OAuth type and click Create. Suggested name: Ocular - <store name>.
  4. Under Information, fill in the app name, company and a contact. Under Feature, enable nothing.
  5. Under Scopes → Add Scopes, search Phone and check only the read (View) permissions: call logs, recordings and their transcripts, users and call queues. Do not add write permissions or other products.
  6. Under Activation, click Activate your app.
  7. Under App Credentials you will see the Account ID, Client ID and Client Secret. Hand them to Ocular only through the secure channel Customer Success indicates, never by email or chat.

Keep in mind:

  • The app only grants access to the data of that Zoom account. If you have several accounts, repeat the step in each one.
  • Zoom recommends one app per integrated service, to audit permissions and usage separately. Do not reuse an app from another vendor.
  • The permissions you can assign depend on the role of whoever creates the app; if you do not see the Phone ones, a full Zoom Phone administrator must do it.
  • For Ocular to read recordings and transcripts, automatic call recording must be enabled in the Zoom Phone policy of the number or queue.
  • You can revoke access at any time by deactivating the app from the same panel.

2. Current numbers and routes​

InputDetail
Main store numberE.164 (for example, +1 555 010 0100) and which Zoom object it is assigned to: auto receptionist, call queue or user
Additional numbersDirect lines, delivery or management numbers, with their assignment
Store queue identifierName and identifier of the queue that urgent calls reach today; users or extensions that answer it
VoicemailWhich extension or queue it belongs to and who checks it
Auto receptionistIf one exists, its current configuration: menu, options and where each one leads
Hours configured in ZoomBusiness hours, closed hours and holidays for each number, queue or receptionist, with time zone
Current after-hours routeWhat happens today when the store is closed: voice assistant, voicemail, forwarding, message

3. Entry point into Ocular​

Zoom Phone hands calls to Ocular through one of these paths. Indicate which one you prefer:

PathWhat must be configured in Zoom PhoneWhat Ocular provides
After-hours forwarding to an Ocular number (recommended to start)In the auto receptionist or the call queue, the "closed hours" route points to an external number provided by Ocular. External forwarding must be enabled on the plan.A dedicated +1 number for the store
Conditional forwardingSame as above, but only when the queue does not answer within N seconds or is full (overflow)The same Ocular number
SIPIf the account uses its own carrier or an SBC (BYOC / premise peering), the carrier delivers the call to Ocular over SIP with the original number and the caller identitySIP URI and network requirements (see SIP URI forwarding into Ocular)

Also confirm:

  • Caller identity on forwarding. That Zoom Phone keeps the caller's number when forwarding to Ocular (and does not replace it with the store number). It is what allows recognizing employees and logging complaints with a contact number.
  • Dialed number. That Ocular receives the store number that was called, so several stores can be served with a single integration.

4. Returning the call to Zoom​

So that Ocular can transfer to the store queue with a summary and take the call back if nobody answers:

InputDetail
Direct number or extension of the store queueWhere Ocular transfers urgent matters; it must accept external calls
Manager or shift lead numberFor after-hours notices and transfers, with the hours it accepts calls (for example, +1 555 010 0150)
Emergency numberDestination of the emergency rule
Maximum ring timeSeconds Ocular waits before taking the call back and taking a message
Identity to presentWhich number the store should see when Ocular transfers: the customer's, the store's or Ocular's

5. Current assistant and knowledge base​

InputDetail
Zoom voice assistant exportJSON file exported from the assistant configuration (prompt, skills, destinations, voice settings)
Knowledge baseFull content (documents, Q&A, URLs) or read access to the base connected to the assistant
Current service rulesWhat the assistant must and must not do today (for example, no driving directions)
Recordings and transcriptsAPI access or an export of a representative period, for the lab test and the comparison baseline

6. Employees and destinations​

InputDetail
Employee list for verificationName, registered mobile number (+1 555 010 0199) or assigned code; used only to verify identity on shift and urgent calls
Shift leadsWho receives shift and absence notices, and through which channel (platform, email, SMS, WhatsApp)
Complaint ownerName, channel and response time
Delivery aggregatorsWhich ones operate with the store and their support links or numbers

7. Testing and comparison​

InputDetail
Test numberA store number (or a new one in Zoom Phone) to test without affecting operations
Test windowsDates and times with the Zoom administrator available
Split mechanism for the parallel phaseBy hours, by day or by percentage; configured in the Zoom after-hours route
Acceptance criteriaWhat must be met to consider the comparison complete

8. Compliance​

InputDetail
Recording and AI-agent noticesText to play, according to the law of the store's state
Retention policyHow long to keep recordings and transcripts
Do-not-call listIf it applies to notices or callbacks

How to send it​

Send this list to your Customer Success contact. Mark anything you do not know as "pending". Customer Success will return, through the secure channel, the Ocular number or URI for forwarding, the app to authorize in the Zoom Marketplace and the date of the first test. The general telephony form is in Inputs we need from the customer.