All Products
Search
Document Center

:GetViberByRequestNo

Last Updated:Mar 31, 2026

Retrieves the application by its requestNo.

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

list

*All Resource

*

None

None

Request parameters

Parameter

Type

Required

Description

Example

RequestNo

string

Yes

The request ID.

86512358****

CustSpaceId

string

No

The Space ID of an ISV sub-customer or the Instance ID of a direct customer.

28251486512358****

Response elements

Element

Type

Description

Example

object

AccessDeniedDetail

string

Access denial details.

{}

Message

string

The response message.

successful

RequestId

string

The unique ID for the request. You can use this Aliyun-generated ID for troubleshooting.

90E63D28-E31D-1EB2-8**9-A94866411B2O

Data

object

The response data.

AuditResult

string

The audit result.

pass

Creator

string

The creator of the resource.

11

Reason

string

The audit comment.

aa

GmtCreate

string

The creation time.

1753236426000

SubscriberCode

string

The subscriber code.

4534**

MaapServiceNo

string

The Viber service ID.

735221

State

string

The status of the request.

A

AuditTime

string

The audit time.

1785465

GmtModifier

string

The modification time.

17833636

Id

string

The ID of the resource.

11

AuditRecord

object

The audit record details.

ContactMail

string

The contact email address.

example

CompanyLegalName

string

The legal name of the company.

xxxxxxcompany

LetterGuarantee

string

The URL of the letter of guarantee.

https://xxxxxxxxxx

IndustryInvolved

string

The company's industry.

cateringServices

MessageDestinationInternationalCountry

array

The international destination countries or regions.

string

An international destination country or region.

["355|AL"]

CompleteAddressOfHeadquarters

string

The complete address of the company's headquarters.

address

MessageEnableDate

string

The date business messaging is enabled.

2025-08-05

BusinessLicenseRegistrationNumber

string

The business license registration number.

43645465465

CompanyLegalPerson

string

The name of the company's legal representative.

jack

CompanyAddress

array<object>

The company addresses.

object

Details for a single company address.

CompanyAddress

string

The company address.

address

CompanyAddressTitle

string

The title of the company address.

111

CompanyRegisteredCountry

string

The country or region where the company is registered.

beijing

AgeLimit

string

The age restriction.

eighteenUp

IndustryDescription

string

A description of the industry.

Description

WebAddress

string

The company website.

https://xxxxxx

EnableAutoReply

string

Indicates whether auto-reply is enabled.

N

NowRecovery

string

The recovery status.

NowRecovery

RecoveryDate

string

The date of recovery.

2025-11-11

BusinessAccountName

string

The name of the business account.

aaaa

ApplyReason

string

The reason for the application.

aaa

string

A logo URL.

["http://xxx","http://xxxx"]

ReplyContent

string

The content of the auto-reply message.

aaa

CompanyProfile

string

The company profile.

new

CompanyTel

array<object>

The company telephone numbers.

object

Details for a single telephone number.

CompanyTelNumber

string

The company telephone number.

134213213

CompanyTelTitle

string

The title for the telephone number.

xxx

OtherLetterGuarantee

string

The URL for supplementary information.

https://wwwxxxx

MessageDialogueIntroduction

string

A brief introduction to the business messaging conversation.

aaa

MessageDestinationCountry

array

The local destination countries or regions.

string

A local destination country or region.

["61|es"]

SuspensionDate

string

The suspension date.

SuspensionDate

MessageSessionName

string

The name of the business messaging conversation.

name

CompanyEnglishName

string

The English name of the company.

english

ContactPhone

string

The contact person's phone number.

861151515***

ContactPosition

string

The contact person's position.

example

ContactEmail

string

The contact person's email address.

6944**@gmail.com

ContactName

string

The contact person's name.

qwq

Modifier

string

The user who last modified the resource.

11

RequestNo

string

The unique number for the application request.

5435435435

RequestType

string

The type of the request.

viberOpen

Code

string

The status code of the request.

  • OK: The request was successful.

  • For other error codes, see Error codes.

OK

Success

boolean

Indicates if the request was successful. Valid values:

  • true: The request was successful.

  • false: The request failed.

false

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "{}",
  "Message": "successful",
  "RequestId": "90E63D28-E31D-1EB2-8**9-A94866411B2O\n",
  "Data": {
    "AuditResult": "pass",
    "Creator": "11",
    "Reason": "aa",
    "GmtCreate": "1753236426000",
    "SubscriberCode": "4534**",
    "MaapServiceNo": "735221",
    "State": "A",
    "AuditTime": "1785465",
    "GmtModifier": "17833636",
    "Id": "11",
    "AuditRecord": {
      "ContactMail": "example",
      "CompanyLegalName": "xxxxxxcompany",
      "LetterGuarantee": "https://xxxxxxxxxx",
      "IndustryInvolved": "cateringServices",
      "MessageDestinationInternationalCountry": [
        "[\"355|AL\"]"
      ],
      "CompleteAddressOfHeadquarters": "address",
      "MessageEnableDate": "2025-08-05",
      "BusinessLicenseRegistrationNumber": "43645465465",
      "CompanyLegalPerson": "jack",
      "CompanyAddress": [
        {
          "CompanyAddress": "address",
          "CompanyAddressTitle": "111"
        }
      ],
      "CompanyRegisteredCountry": "beijing",
      "AgeLimit": "eighteenUp",
      "IndustryDescription": "Description",
      "WebAddress": "https://xxxxxx",
      "EnableAutoReply": "N",
      "NowRecovery": "NowRecovery",
      "RecoveryDate": "2025-11-11",
      "BusinessAccountName": "aaaa",
      "ApplyReason": "aaa",
      "Logo": [
        "[\"http://xxx\",\"http://xxxx\"]"
      ],
      "ReplyContent": "aaa",
      "CompanyProfile": "new",
      "CompanyTel": [
        {
          "CompanyTelNumber": "134213213",
          "CompanyTelTitle": "xxx"
        }
      ],
      "OtherLetterGuarantee": "https://wwwxxxx",
      "MessageDialogueIntroduction": "aaa",
      "MessageDestinationCountry": [
        "[\"61|es\"]"
      ],
      "SuspensionDate": "SuspensionDate",
      "MessageSessionName": "name",
      "CompanyEnglishName": "english",
      "ContactPhone": "861151515***",
      "ContactPosition": "example",
      "ContactEmail": "6944**@gmail.com",
      "ContactName": "qwq"
    },
    "Modifier": "11",
    "RequestNo": "5435435435",
    "RequestType": "viberOpen"
  },
  "Code": "OK",
  "Success": false
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.