All Products
Search

This Product

    Chat App Message Service:ListInstance

    Document Center

    Chat App Message Service:ListInstance

    Last Updated:Mar 31, 2026

    Lists instances.

    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:ListInstance

    list

    *Instance

    acs:cams:{#regionId}:{#accountId}:instance/*

    None

    None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    ChannelType

    string

    No

    The channel type. Valid values:

    • whatsapp

    • messenger

    • instagram

    • viber

    VIBER

    InstanceName

    string

    No

    The instance name.

    viber_ins

    SubmitTime

    string

    No

    The submission time, in YYYY-MM-DD HH:MM:SS format.

    2023-12-12 00:00:00

    PageSize

    integer

    No

    The number of items to return per page.

    87

    PageIndex

    integer

    No

    The page number to return.

    92

    ResourceGroupId

    string

    No

    The ID of the resource group that contains the instance.

    11

    InstanceId

    string

    No

    The instance ID. Use this parameter for non-Alibaba Cloud hosts only.

    r-uf6wd7pkyjwxvlxfhk

    FilterStr

    string

    No

    The filter string for the query.

    aa

    Response elements

    Element

    Type

    Description

    Example

    object

    The data returned.

    AccessDeniedDetail

    string

    The details of the access denial.

    {}

    TotalCount

    integer

    The total number of entries that match the specified criteria.

    15

    RequestId

    string

    The request ID.

    2993*****

    Message

    string

    The response message.

    NULL

    Data

    array<object>

    An array of objects, each representing an instance.

    object

    The details of the instance.

    CountryId

    string

    The country ID.

    1

    ContactMail

    string

    The contact email address.

    ma**@gmail.com

    ResourceRegionId

    string

    The ID of the region where the resource is located.

    11

    ResourceGroupId

    string

    The resource group ID.

    12

    InstanceId

    string

    The instance ID.

    29339****

    OfficeAddress

    string

    The office address.

    example

    SubmitTime

    string

    The time when the instance was submitted.

    2023-12-12 00:00:00

    InstanceName

    string

    The instance name.

    viber_ins

    CustSpaceId

    string

    The customer space ID.

    dad-gf**

    IsvTerms

    string

    The ISV terms.

    aa

    FacebookBmId

    string

    The ID of the associated Facebook Business Manager account.

    1

    InstanceDescription

    string

    The instance description.

    ins

    ChannelType

    string

    The channel type.

    VIBER

    State

    string

    The state of the instance.

    published

    Code

    string

    The request status code.

    • OK indicates that the request was successful.

    • For other error codes, see the Error Code List.

    OK

    Success

    boolean

    Indicates whether the call succeeded.

    • true: The call succeeded.

    • false: The call failed.

    true

    Examples

    Success response

    JSON format

    {
  "AccessDeniedDetail": "{}",
  "TotalCount": 15,
  "RequestId": "2993*****",
  "Message": "NULL",
  "Data": [
    {
      "CountryId": "1",
      "ContactMail": "ma**@gmail.com",
      "ResourceRegionId": "11",
      "ResourceGroupId": "12",
      "InstanceId": "29339****",
      "OfficeAddress": "example",
      "SubmitTime": "2023-12-12 00:00:00",
      "InstanceName": "viber_ins",
      "CustSpaceId": "dad-gf**",
      "IsvTerms": "aa",
      "FacebookBmId": "1",
      "InstanceDescription": "ins",
      "ChannelType": "VIBER",
      "State": "published"
    }
  ],
  "Code": "OK",
  "Success": true
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.