Number Masking
Number masking hides the far end’s phone number from a user: an agent can take and return calls without ever seeing the customer’s number. It is a privacy and data-protection control for contact centers, outsourced teams and anyone handling sensitive callers.
What it hides
Section titled “What it hides”Masking follows who is looking, not whose call it is. A masked viewer sees a partly hidden number (middle or last digits hidden) everywhere SIP.IO shows one:
- call logs, Call Details and CDR exports
- messages and conversations
- the live board and agent feed
- recordings, voicemail and fax
- the phone’s own screen: the caller ID shown on a masked user’s desk phone or softphone
Filters and sorting still run on the real digits server-side, so a masked user can still search their log by number prefix without the number ever being sent back.
Configure it
Section titled “Configure it”| Setting | Where | Values |
|---|---|---|
mask_num | per user on /v1/users, with an account default | 0 none · 1 inbound and queue callers · 2 outbound numbers · 3 both · null inherit the account’s |
mask_num_type | account | 0 hide the middle digits · 1 hide the last digits |
If a user’s setting can’t be read for any reason, they get everything masked: the screen keeps working and nothing leaks.
API keys inherit their creator’s mask
Section titled “API keys inherit their creator’s mask”An API key sees numbers the way the user who created it does. A masked agent can’t mint a key and use it to read the numbers their own screen hides. A key made by an admin, or before this rule existed, follows the account’s setting.
Calling back a hidden number
Section titled “Calling back a hidden number”A masked user can still return a call. POST /v1/calls/{callId}/callback rings the user’s own phones and then dials the far end of that logged call, without the number ever appearing in the reply:
curl -X POST 'https://api.sip.io/v1/calls/call_…/callback' -H 'Authorization: Bearer …'| Status | error | Meaning |
|---|---|---|
403 | callback_would_unmask | Your log hides this number but your outbound calls aren’t masked, so the callback would reveal it. |
404 | call_not_found | Not a call your log shows you. |
422 | no_callback_number | An internal call, or the caller withheld their number. |