Search Emergency Numbers

Search emergency numbers in a tenant.

Request URL

POST {base_url}/uc-cconfig/api/v1/emergency-numbers/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.
sorts	No	Array<Sort_Condition>	The sort conditions.

Sort_Condition


Parameter	Required	Type	Description
property	No	String	The name of the field to sort by. Valid value: `trunkDisplayCallerIds`
direction	No	String	The sort order. Valid value: `asc`: Sort in ascending order. `desc`: Sort in descending order.

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 numbers.

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_Number>	The list of matching emergency numbers.

Emergency_Number


Parameter	Type	Description
id	String	The unique identifier of the emergency number.
name	String	The name of the emergency number.
number	String	The emergency number.
callerIdPriority	String	The Outbound Caller ID priority for emergency calls. `trunk`: Use the Emergency Outbound Caller ID configured for the trunk used to place the emergency call. If an Emergency Outbound Caller ID is configured for the trunk, the system uses the configured number. If no Emergency Outbound Caller ID is configured for the trunk, the system uses the trunk's default Outbound Caller ID. `user`: Use the Emergency Outbound Caller ID configured for the user who places the emergency call. If an Emergency Outbound Caller ID is configured for the user, the system uses the configured number. If no Emergency Outbound Caller ID is configured for the user, the system uses the Emergency Outbound Caller ID configured for the trunk. If no Emergency Outbound Caller ID is configured for either the user or the trunk, the system uses the trunk's default Outbound Caller ID.
trunkDisplayCallerIds	Array<Trunk_Outbound_Caller_ID>	The outbound caller ID information for the trunk used for emergency calls.
userScope	String	The users who can use the emergency number for emergency calling. `all`: All users can use the emergency number. `specific`: Only the specified users can use the emergency number.

Trunk_Outbound_Caller_ID


Parameter	Type	Description
id	String	The unique identifier of the outbound rule.
trunkId	String	The unique identifier of the trunk used for emergency calls.
trunkEmergencyCallerId	String	The outbound caller ID of the trunk used for emergency calls.
trunkName	String	The name of the trunk.
trunkEmergencyCallerIdInDid	String	Whether the Emergency Outbound Caller ID is a DID number bound to the trunk. `0`: The trunk is either configured with a custom number as the Emergency Outbound Caller ID or has no Emergency Outbound Caller ID configured. Non-zero value: The ID of the DID number bound to the trunk and used as the Emergency Outbound Caller ID.
didNumber	String	The DID number bound to the trunk and used as the emergency outbound caller ID.

Example

Request example

POST /uc-cconfig/api/v1/emergency-numbers/search-page HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJyZWdpb24ta2V5LTEiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc4ODc4Njc2MCwiaWF0IjoxNzg4NzY1MTYwLCJqdGkiOiJkZDZmMGEzYS05NTg0LTRhOGQtYTZmYi0wOGQ2ZTE0ODdmZmUiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.1deRKiIDcYLXRg5CpWqCVFMN9a-YJT1sC3PcAHGCREP-Irc7vYOYkZT_OuV8KE2bQNRBb8P4krbM2bqXGMeen-X6cXFAVYRhcwHRgWJhZF3Xn8-uiHpESVhOAEPhEgoGS4rDmL-dzGomPQenp2C0D8l3Bwiw2cqRkHu8Y4ZxUtx7oOYvxyP84AhWPyLNX0Ge-C65ob18Lp3_m7_Z8j2EG0xnNbzk_C3IM-PozoDZJd_pccbfLI0bNWt_l5BUryRaAtz4MKHtHyPKjBH9EXxnLXwyZOC5PJ__bHTTh91MXsuiLUUHDbeTsTLQrYgPX2OGMnVwUPN8jho6YwL90rpW7g
Content-Type: application/json
x-tenant-code: jint
{
  "pageNumber": 1,
  "pageSize": 10
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "5eca6041967356b6de49daa78aaa5d97",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "pageSize": 10,
    "pageNumber": 1,
    "count": "2",
    "results": [
      {
        "id": "355287488894279680",
        "name": "Fire Exit HQ",
        "number": "9119",
        "callerIdPriority": "trunk",
        "trunkDisplayCallerIds": [
          {
            "id": "355287687733649408",
            "trunkId": "337909436766003200",
            "trunkEmergencyCallerId": "",
            "trunkName": "ee",
            "trunkEmergencyCallerIdInDid": "0",
            "didNumber": ""
          }
        ],
        "userScope": "all"
      },
      {
        "id": "350911911840137216",
        "name": "11111",
        "number": "1222",
        "callerIdPriority": "trunk",
        "trunkDisplayCallerIds": [
          {
            "id": "350911911844331520",
            "trunkId": "337909436766003200",
            "trunkEmergencyCallerId": "",
            "trunkName": "ee",
            "trunkEmergencyCallerIdInDid": "0",
            "didNumber": ""
          }
        ],
        "userScope": "all"
      }
    ]
  }
}