ListPhoneNumbersOfSkillGroup-阿里云帮助中心

You can invoke the ListPhoneNumbersOfSkillGroup API to obtain the list of phone numbers associated with a specified skill group under a specified instance. You can also use this API to query phone numbers that are not currently associated with the skill group but can be associated with it.

Operation description

Note: If a phone number is already used as a personal outbound number, it will not appear in the list of numbers available for association with a skill group.

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	Instance ID.	ccc-test
SkillGroupId	string	Yes	Skill group ID.	skillgroup@ccc-test
PageNumber	integer	Yes	Page number for paging. Valid values: 1 to 100.	1
PageSize	integer	Yes	Page size for paging. Valid values: 1 to 100.	10
IsMember	boolean	Yes	Indicates whether the phone numbers are associated with the skill group. If true, the API queries the list of phone numbers already associated with the specified SkillGroupId. If false, the API queries the list of phone numbers that can be associated with the specified SkillGroupId but are not currently associated. This parameter is typically used together with the AddNumbersToSkillGroup API.	true
SearchPattern	string	No	Performs Fuzzy Matching on phone numbers. This parameter is optional. The default value is empty, which means no filtering is applied.	0833
Active	boolean	No	Indicates whether the phone number is active. This parameter is optional. The default value is empty, which means no filtering is applied.	true

Response elements

Element	Type	Description	Example
	object
Code	string	Response code.	OK
HttpStatusCode	integer	HTTP status code.	200
Message	string	Response message.	无
RequestId	string	Request ID.	EEEE671A-3E24-4A04-81E6-6C4F5B39DF75
Data	object	Data.
PageNumber	integer	Page number, ranging from 1 to 100.	1
PageSize	integer	Page size, ranging from 1 to 100.	10
TotalCount	integer	Total count.	1
List	array<object>	List of phone numbers.
	object
Active	boolean	Whether the phone number is active.	true
Number	string	Phone number.	08330011****
City	string	City where the phone number is registered.	乐山
InstanceId	string	Instance ID.	ccc-test
Usage	string	Usage of the phone number. Valid values: Outbound : Outbound Inbound : Inbound Bidirection : Inbound and outbound	Bidirection
ContactFlowId	string	IVR contact flow ID associated with the phone number.	a3fb6c62-9b49-4942-ae5b-cf2abd4123ek
Province	string	Province where the phone number is registered.	四川

Examples

Success response

JSON format

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "EEEE671A-3E24-4A04-81E6-6C4F5B39DF75",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 1,
    "List": [
      {
        "Active": true,
        "Number": "08330011****",
        "City": "乐山",
        "InstanceId": "ccc-test",
        "Usage": "Bidirection",
        "ContactFlowId": "a3fb6c62-9b49-4942-ae5b-cf2abd4123ek",
        "Province": "四川"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	Parameter.Maximum	The parameter %s must be less than or equal to %s.
400	Parameter.Minimum	The parameter %s must be greater than or equal to %s.
400	Parameter.Empty	The parameter %s may not be null or empty.
400	Parameter.Null	The parameter %s may not be null.
404	NotExists.InstanceId	The specified instance %s does not exist.
404	NotExists.SkillGroupId	The skill group ID %s does not exist in instance %s.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.