QueryHotlineNumber-Artificial Intelligence Cloud Call Service(AICCS)-阿里云帮助中心

Query the hotline number configuration list by instance ID. Fuzzy query by hotline number is supported.

Operation description

The hotline number configuration includes information such as the hotline number, number location, carrier, and whether it is used for incoming calls. For details, see Return Parameters.

Queries per second (QPS) limit

Per-user invocation frequency: 100 times per second.
API invocation frequency: 100 times per second.

Note

If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The Artificial Intelligence Cloud Call Service (AICCS) instance ID. You can obtain it from Instance Management in the left-side navigation pane of the Artificial Intelligence Cloud Call Service console.	ccc_xp_pre-cn-***
CurrentPage	integer	Yes	The current page number. The value must be greater than 0. Default value: 1.	1
PageSize	integer	Yes	The number of entries per page. The value must be greater than 0. Default value: 20.	10
HotlineNumber	string	No	The hotline number. Fuzzy query is supported.	0571****2211
DepartmentId	integer	No	The department ID.	2256****
GroupIds	array	No	The list of skill groups.
	integer	No	The skill group ID. Use this together with the skill group category ID.	["6083**","6084**"]

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Request ID.	EE339D98-9BD3-4413-B165
Message	string	Status code description.	OK
Data	object	Hotline number configuration information.
TotalCount	integer	Total amount of data.	123
PageSize	integer	Page size.	10
CurrentPage	integer	Current page.	1
HotlineNumList	array<object>	Number list.
	array<object>	Number list.
FlowId	integer	Incoming call flow ID.	12
Description	string	Number description.	测试
OutboundEnabled	boolean	Indicates whether the number is used for outbound calls.	true
CalloutAllDepartment	boolean	Outbound calls apply to all departments.	true
FlowName	string	Inbound flow name.	测试流程
CalloutRangeList	array<object>	List of departments for which outbound calls are effective.
	array<object>	List of departments for which outbound calls are effective.
GroupDOList	array<object>	The skill group list.
	object	The skill group list.
GroupName	string	The skill group name.	技能组A
GroupId	integer	The skill group ID.	6083****
DepartmentName	string	The department name.	部门A
DepartmentId	integer	Department ID.	2256****
HotlineNumber	string	Hotline number.	0571****2211
EvaluationStatus	integer	Satisfaction status. Valid values: 0: Neither inbound nor outbound calls are enabled. 1: Inbound calls are enabled. 2: Outbound calls are enabled. 3: Both inbound and outbound calls are enabled.	0
Sp	string	Carrier.	电信
Location	string	Number location.	浙江杭州
InBoundEnabled	boolean	Indicates whether the number is used for inbound calls.	true
Code	string	The status code. A value of Success indicates that the request succeeded.	Success
Success	boolean	Indicates whether the API call succeeded. true: Succeeded. false: Failed.	true

Examples

Success response

JSON format

{
  "RequestId": "EE339D98-9BD3-4413-B165",
  "Message": "OK",
  "Data": {
    "TotalCount": 123,
    "PageSize": 10,
    "CurrentPage": 1,
    "HotlineNumList": [
      {
        "FlowId": 12,
        "Description": "测试",
        "OutboundEnabled": true,
        "CalloutAllDepartment": true,
        "FlowName": "测试流程",
        "CalloutRangeList": [
          {
            "GroupDOList": [
              {
                "GroupName": "技能组A",
                "GroupId": 0
              }
            ],
            "DepartmentName": "部门A",
            "DepartmentId": 0
          }
        ],
        "HotlineNumber": "0571****2211",
        "EvaluationStatus": 0,
        "Sp": "电信",
        "Location": "浙江杭州",
        "InBoundEnabled": true
      }
    ]
  },
  "Code": "Success",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.