GetContactBlockList-阿里云帮助中心

Retrieves the outbound call blocklist.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

outboundbot:GetContactBlockList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number. This parameter is required.	1
PageSize	integer	No	The number of entries per page. This parameter is required.	10
CountTotalRow	boolean	No	Specifies whether to display the total number of entries.	true
InstanceId	string	Yes	The instance ID.	846e20ae-e113-4231-a792-cb354187c9f6
		No

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
Code	string	The response code.	OK
Message	string	The response message.	Success
RequestId	string	The request ID.	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success	boolean	Indicates whether the request was successful.	true
ContactBlocklistList	object	The contact blocklist.	{}
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of entries.	100
List	array<object>	The array data.	[]
	object
ContactBlockListId	string	The unique key of the entry in the do-not-call list.	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
CreationTime	integer	The time when the entry was created.	1640077685465
Remark	string	The remarks.	xxxx
PhoneNumber	string	The mobile phone number.	1388888888
Operator	string	The operator.	xxx
InstanceId	string	The instance ID.	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Name	string	The name of the contact.	xxx
Creator	string	The user who created the entry.	xxx

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "ContactBlocklistList": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "List": [
      {
        "ContactBlockListId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
        "CreationTime": 1640077685465,
        "Remark": "xxxx",
        "PhoneNumber": "1388888888",
        "Operator": "xxx",
        "InstanceId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
        "Name": "xxx",
        "Creator": "xxx"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.