Caller ID API Overview
Overview
A Business Caller ID (BCID) resource describes a telephone number associated with a brand. When you make calls from this number, the iPhone displays the brand's display name, brand asset (logo), and optional department name to enhance the calling experience.
A location is not required to be associated with a brand to use a BCID resource.
Prerequisites
For Owners:
- To use the BCID feature an Owner MUST delegate at least one Partner offering CAP capabilities.
- Owner MUST add brand and brand logo details to fully support the BCID experience.
- Brand MUST have at least one (1) version that is
PUBLISHED. - Brand asset MUST have at least one (1) version of a
PLACECARD_LOGOthat isPUBLISHED. - If any of these requirements are not satisfied, the iPhone will rely upon fallback measures.
- Brand MUST have at least one (1) version that is
For Partners:
- The Partner MUST be registered as an Agency in Business Connect.
- An existing Partner client that is not already a Business Connect organization and wants to use BCID MUST register their organization in Business Connect.
- Partner, or a trusted affiliate, MUST host RCD.
- BCID requires an explicit, unambiguous association between a phone number and a delegated brand; shared outbound numbers inherently limit this capability.
Constraints
- Quantity of telephone numbers SHOULD NOT exceed one hundred and fifty thousand (150,000) per brand.
- An existing Business Connect organization may delegate to a Partner. However, the organization must provide their phone registry directly to the Partner outside Business Connect channels. The Partner may then manage BCID resources on your behalf.
- BCID is limited to the USA.
Model View
Download Models
| File Format | Description |
|---|---|
| CSV | Entities & attributes. Caller ID details "flattened" and described using JSON path notation |
| Markdown | Entities & Attributes |