Search Emergency Contacts

Request URL

POST {base_url}/uc-cconfig/api/v1/emergency-contacts/search-page

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.

Body parameters


Parameter	Required	Type	Description
pageNumber	No	Integer	The page number to retrieve.
pageSize	No	Integer	The number of records to retrieve per page.
keyword	No	String	The keyword used to search for emergency contacts.

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<Search_Result>	The search result of emergency contacts.

Search_Result


Parameter	Type	Description
pageSize	Integer	The number of records per page.
pageNumber	Integer	The current page number.
count	String	The total number of matching records.
results	Array<Emergency_Contact>	The list of matching emergency contacts.

Emergency_Contact


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`.
sendEmail	Boolean	Whether email notification is enabled. `true`: Enabled `false`: Disabled
callExtension	Boolean	Whether phone call notification to an extension is enabled. `true`: Enabled `false`: Disabled
users	Array<Internal_User_Info>	The information of internal users. Note: This parameter is returned with a value only when `contactType` is `specific`.

Internal_User_Info


Parameter	Type	Description
id	String	The unique identifier of the user.
extension	String	The extension number of the user.
name	String	The name of the user.

Example

Request example

POST /uc-cconfig/api/v1/emergency-contacts/search-page HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJyZWdpb24ta2V5LTEiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc4ODUwNTI5MSwiaWF0IjoxNzg4NDgzNjkxLCJqdGkiOiI2NzZmNzhiNS1iZjUxLTQ0OTQtYTdjNC01ZTFjNjI3YmZlMTciLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.HCqpumqUB419xFtNV6oJJByPRzE571VVQWGuZ7I_NMgDg_LvEK9xS3CTe5tlCFOMyL36szYpawZA9nGpyqSCCTRbDplZBZAkbgWCFnV6H_cKZA15bmnpITEEQ1Azwzf49oTE00mudfYxeVJe7rQDX8lDQlgbMRnQZmwlscR_dbFVqPpQhuAkwhCT1Kyyu3NVvr-nNE8YdoxDQtdgGh5Uf09ULAyMD-j8qHya0jqYlFIIYp1_GzK5wpyU0-D7DjYmWYIkr9xBpTiqTZT6D2JUEKWJmud2psOpyITa2L39QIWHu7nqMty4u-8hfh9Vzlgl8XM8Z1yale_jNdJZgYmyQQ
Content-Type: application/json
x-tenant-code: jint
{
  "pageNumber": 1,
  "pageSize": 20,
  "keyword": "Emergency"
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "d7971c1becb4d550e31e706c19bbd583",
  "code": "200",
  "message": "SUCCESS",
  "result": {
    "pageSize": 20,
    "pageNumber": 1,
    "count": "1",
    "results": [
      {
        "id": "353467466842984448",
        "contactType": "custom",
        "contactName": "Emergency IT",
        "sendEmail": true,
        
        "callExtension": false,
        "users": []
      }
    ]
  }
}