Query an Emergency Contact

Retrieve the details of an emergency contact in a tenant.

Request URL

GET {base_url}/uc-cconfig/api/v1/emergency-contacts/{id}

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Path parameters
Parameter Required Type Description
id Yes String The ID of the emergency contact.
Note: You can obtain the ID using the Search Emergency Contacts interface.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<Contact_Detail> The details of the emergency contact.
Contact_Detail
Parameter Type Description
id String The unique identifier of the emergency contact.
contactType String The type of the emergency contact.
  • specific: Internal user.
  • custom: External contact.
contactName String The name of the external contact.
Note: This parameter is returned with a value only when contactType is custom.
userIds Array<String> The IDs of the internal users.
Note: This parameter is returned with a value only when contactType is specific.
sendEmail Boolean Whether email notification is enabled.
  • true: Enabled
  • false: Disabled
email String The email address that receives the notification.
Note: This parameter is returned only when contactType is custom.
callExtension Boolean Whether phone call notification to an extension is enabled.
  • true: Enabled
  • false: Disabled
version Integer The version number of the contact, incremented with each update to prevent outdated data from overwriting new data.

Example

Request example

GET /uc-cconfig/api/v1/emergency-contacts/353467466842984448 HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJyZWdpb24ta2V5LTEiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc4ODUwNTI5MSwiaWF0IjoxNzg4NDgzNjkxLCJqdGkiOiI2NzZmNzhiNS1iZjUxLTQ0OTQtYTdjNC01ZTFjNjI3YmZlMTciLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.HCqpumqUB419xFtNV6oJJByPRzE571VVQWGuZ7I_NMgDg_LvEK9xS3CTe5tlCFOMyL36szYpawZA9nGpyqSCCTRbDplZBZAkbgWCFnV6H_cKZA15bmnpITEEQ1Azwzf49oTE00mudfYxeVJe7rQDX8lDQlgbMRnQZmwlscR_dbFVqPpQhuAkwhCT1Kyyu3NVvr-nNE8YdoxDQtdgGh5Uf09ULAyMD-j8qHya0jqYlFIIYp1_GzK5wpyU0-D7DjYmWYIkr9xBpTiqTZT6D2JUEKWJmud2psOpyITa2L39QIWHu7nqMty4u-8hfh9Vzlgl8XM8Z1yale_jNdJZgYmyQQ
x-tenant-code: jint

Response example

HTTP/1.1 200 OK
{
  "requestId": "a5012ae4d192b49a1a830c97a278b043",
  "code": "200",
  "message": "SUCCESS",
  "result": {
    "id": "353467466842984448",
    "contactType": "custom",
    "contactName": "Emergency IT",
    "userIds": [],
    "sendEmail": true,
    "email": "it-alert@example.com",
    "callExtension": false,
    "version": 1
    
    
    
  }
}