Get contact widgets for matched contacts

POST /contact/widget

Asks the connector for the read-only widget of each matched contact, shown in the phone side panel during a call. Connectors that do not implement getContactWidget return an empty list. Widgets are not cached.

Operation ID: getContactWidget
Authorization: BEARER or API key

Request body

Required: Yes

Content type: application/json

Schema: object

{
  "phoneNumber": "string",
  "contacts": [
    {
      "id": "string",
      "name": "string",
      "phone": "string",
      "phoneNumber": "string",
      "type": "string",
      "title": "string",
      "company": "string",
      "email": "string",
      "createdDate": "string",
      "mostRecentActivityDate": "string",
      "additionalInfo": {},
      "isNewContact": false
    }
  ]
}

Responses

Status	Description	Body
200	Read-only widgets, one per contact that has one.	object
400	Bad request, missing authentication, or connector error.	ErrorResponse, string
401	The user session is expired or revoked.	ErrorResponse, string