ListInstagramPage - Chat App Message Service - Alibaba Cloud Documentation Center

Retrieves the Instagram pages associated with an instance.

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

cams:ListInstagramPage

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID. Only non-Alibaba Cloud hosts are supported.	inst-8t47hh***5pyj0ps

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	The details about the access denial.	{}
Message	string	The message returned with the result.	ok
RequestId	string	The request ID. It is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting.	dsfdsf-3jfj***
Data	object	The returned data object.
BeebotInfo	object	The Chatbot information.
BeebotInstanceId	string		instance1
BeebotNamespaceId	string		name1
AgentInfo	object	The agent information.
AgentKeywords	string		aaa,bbb
AgentNoKeywords	string		Y
InstagramInfo	object	The Instagram page information.
PageId	string		213254324532523
QueueFlag	string		Y
HttpFlag	string		Y
AccountId	string		176546546464
StatusQueue	string		AAA
UpQueue	string		BBB
PageName	string		iwhaclecloud-2
ConnectionStatus	string		connected
UpCallbackUrl	string		HTTP://WWW.***.COM
QueueName	string		aaa
AccountName	string		matrryhtr
StatusCallbackUrl	string		HTTP://WWW.***.COM
Code	string	The request status code. A value of OK indicates that the request was successful. For other error codes, see Error codes.	OK
Success	boolean	Indicates whether the operation was successful. Valid values: true: Successful. false: Failed.	false

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "{}",
  "Message": "ok",
  "RequestId": "dsfdsf-3jfj***",
  "Data": {
    "BeebotInfo": {
      "BeebotInstanceId": "instance1",
      "BeebotNamespaceId": "name1"
    },
    "AgentInfo": {
      "AgentKeywords": "aaa,bbb",
      "AgentNoKeywords": "Y"
    },
    "InstagramInfo": {
      "PageId": "213254324532523",
      "QueueFlag": "Y",
      "HttpFlag": "Y",
      "AccountId": "176546546464",
      "StatusQueue": "AAA",
      "UpQueue": "BBB",
      "PageName": "iwhaclecloud-2",
      "ConnectionStatus": "connected",
      "UpCallbackUrl": "HTTP://WWW.***.COM",
      "QueueName": "aaa",
      "AccountName": "matrryhtr",
      "StatusCallbackUrl": "HTTP://WWW.***.COM"
    }
  },
  "Code": "OK",
  "Success": false
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.